Skip to content

Stubs and Scaffolding

Most generators you use with the SDK belong to Core: ui5:app, ui5:card, ui5:tile, ui5:report, ui5:dashboard and the rest render Core's stubs. The SDK adds two stubs of its own.

The SDK's stubs

StubUsed byGenerates
help.md.stubui5:docA help document at ui5/{module}/doc/{uuid}/{locale}.md with a fresh UUID and title / description frontmatter
action/Handler.stubCore's ui5:action, when the SDK is installedA typed handler that implements SdkActionHandlerInterface

The SDK hooks into ui5:action by binding its own artifact behaviour scaffolder. Every other artifact type is handed back to Core's default, so the other generators behave exactly as they do without the SDK.

bash
php artisan ui5:doc Timesheet "Recording time" --locale=en

Customizing stubs

The SDK's stubs cannot be published or overridden. Their paths are fixed inside the package, and the SDK registers no vendor:publish tag.

ui5:publish does not touch stubs. It refreshes public/sdk with the icon fonts and the default avatar (the shell bundle is served from the package); --force skips the confirmation prompt.

See also