umbracodegen v1.0.0-alpha.6
umbracodegen
Generate boilerplate code for building v14+ Umbraco packages
Installation
umbracodegen
can be installed with your favourite package manager. It is recommended to install the package globally rather than in individual projects to save time installing every time.
npm:
npm i umbracodegen -g
pnpm:
pnpm add umbracodegen -g
bun:
bun install umbracodegen -g
Usage
To run umbracodegen
, simply type umb
or umbracodegen
into your terminal. There are currently two commands at your disposal:
umb new
Running umb new
will scaffold a blank Vite/Lit/TypeScript project as per the instructions in the Umbraco documentation.
umb generate [component]
Currently, running umb generate [component]
will start an interactive builder to scaffold the most used types of components within the backoffice, heavily inspired by code from Kevin Jump's TimeDashboard
Supported components:
- sections (
ManifestSection
) - dashboards (
ManifestDashboard
) - sidebars (
ManifestSectionSidebarApp
,ManifestMenu
,ManifestMenuItem
) - header apps (
ManifestHeaderApp
) - workspaces / workspace views (
ManifestWorkspace
) - property editors (
ManifestPropertyEditorSchema
,ManifestPropertyEditorUi
) - actions (workspace / entity) (
ManifestEntityAction
,ManifestWorkspaceAction
)
Roadmap
Some ideas for future releases include
- Scaffolding a blank package with default Vite/Lit/TypeScript tooling
- Set target path with an
--output|-o
option - Ability to run
npx create umbracodegen@latest
15 days ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago