Saltar al contenido principal

@uxland/create-harmonix-plugin

npm

El creador de plugins. Genera un proyecto de plugin con React, Lit o Angular que ya funciona: un plugin que registra una vista en la región main y un elemento en el menú lateral, y que se ejecuta dentro del shell de demostración. Lo usas una vez, para empezar un proyecto; no es una dependencia del proyecto que crea.

Uso​

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

Usa @latest: sin él, npm puede reutilizar una versión anterior del creador que tenga en caché.

ArgumentoDescripción
<folder>La carpeta que se creará. No debe existir o debe estar vacía. Su nombre, en minúsculas y solo con letras, dígitos y guiones, se convierte en el name del paquete y en el pluginId.
--template <name>, -t <name>react, lit o angular.
--help, -hMuestra el uso.

Sin argumentos, en un terminal interactivo, pregunta la carpeta y el framework.

Cuando crea el proyecto, el creador busca la última versión de @uxland/harmonix-demo-shell en npm y la usa si es más nueva que la de la plantilla. También avisa si existe una versión más nueva del creador.

Plantillas​

ReactLitAngular
Punto de entrada del pluginsrc/plugin.tssrc/plugin.tsprojects/my-plugin/src/plugin.ts
Servidor de desarrollohttp://localhost:5173http://localhost:5173http://localhost:4200
BuildViteViteng build y Vite
Dependencias adicionalesreact, react-dom 19, @uxland/harmonix-adapterslit 3Angular 20

Todas las plantillas generan un único módulo ES, dist/index.js, sin el framework ni el shell: los proporciona la aplicación que carga el plugin. package.json ya tiene el campo module que la CLI lee para publicarlo, y .gitignore ya ignora .harmonixrc.

Requisitos​

Node.js 20.19 o posterior.

Enlaces​