Skip to main content

@uxland/create-harmonix-plugin

npm

El creador de plugins. Genera un projecte de plugin amb React, Lit o Angular que ja funciona: un plugin que registra una vista a la regió main i un element al menú lateral, executant-se dins del shell de demostració. El fas servir un cop, per començar un projecte; no és una dependència del projecte que crea.

Ús​

npm create @uxland/harmonix-plugin@latest my-plugin -- --template react
cd my-plugin
npm install
npm run dev # the demo shell with your plugin
npm run build # only the plugin, in dist/index.js

Fes servir @latest: sense això, npm pot reutilitzar una versió antiga del creador que tingui a la memòria cau.

ArgumentDescripció
<folder>La carpeta que es crea. No ha d'existir o ha d'estar buida. El seu nom, en minúscules i només amb lletres, xifres i guions, es converteix en el name del paquet i en el pluginId.
--template <name>, -t <name>react, lit o angular.
--help, -hMostra com es fa servir.

Sense arguments, en un terminal interactiu, demana la carpeta i el framework.

Quan crea el projecte, el creador consulta la darrera versió d'@uxland/harmonix-demo-shell a npm i la fa servir si és més nova que la de la plantilla. També avisa si hi ha una versió més nova del creador.

Plantilles​

ReactLitAngular
Punt d'entrada del pluginsrc/plugin.tssrc/plugin.tsprojects/my-plugin/src/plugin.ts
Servidor de desenvolupamenthttp://localhost:5173http://localhost:5173http://localhost:4200
ConstruccióViteViteng build i Vite
Dependències addicionalsreact, react-dom 19, @uxland/harmonix-adapterslit 3Angular 20

Totes les plantilles construeixen un sol mòdul ES, dist/index.js, sense el framework ni el shell: els proporciona l'aplicació que carrega el plugin. package.json ja té el camp module que llegeix la CLI per publicar-lo, i .gitignore ja ignora .harmonixrc.

Requisits​

Node.js 20.19 o posterior.

Enllaços​