mirror of https://github.com/n8n-io/n8n.git synced 2026-10-17 05:29:44 +02:00

History

Alex Grozav 9da3b7479f Some checks are pending CI: Master (Build, Test, Lint) / Build for Github Cache (push) Waiting to run Details CI: Master (Build, Test, Lint) / Unit tests (24.18.1) (push) Waiting to run Details CI: Master (Build, Test, Lint) / Unit tests (26.5.1) (push) Waiting to run Details CI: Master (Build, Test, Lint) / Lint (push) Waiting to run Details CI: Master (Build, Test, Lint) / Performance (push) Waiting to run Details CI: Master (Build, Test, Lint) / Verify single-instance deps (npm-install) (push) Waiting to run Details CI: Master (Build, Test, Lint) / Notify Slack on failure (push) Blocked by required conditions Details refactor(editor): Add `defineFrontendModule()` and make it the canonical descriptor form (no-changelog) (#38464 ) Co-authored-by: Claude Opus 5 <noreply@anthropic.com> Co-authored-by: multica-agent <github@multica.ai>		2026-09-12 16:34:08 +00:00
..
bin	build(editor): Add the @n8n/module-cli module scaffolder (no-changelog) (#36427 )	2026-08-24 14:16:05 +00:00
src	refactor(editor): Add `defineFrontendModule()` and make it the canonical descriptor form (no-changelog) (#38464 )	2026-09-12 16:34:08 +00:00
biome.jsonc	build(editor): Add the @n8n/module-cli module scaffolder (no-changelog) (#36427 )	2026-08-24 14:16:05 +00:00
frontend-module-guide.md	refactor(editor): Add `defineFrontendModule()` and make it the canonical descriptor form (no-changelog) (#38464 )	2026-09-12 16:34:08 +00:00
package.json	build(editor): Give the frontend module template the design-system plugins and stylelint (no-changelog) (#37101 )	2026-09-07 11:29:55 +00:00
README.md	docs(editor): Add the frontend module guide next to the module CLI (no-changelog) (#37004 )	2026-09-08 08:12:00 +00:00
vitest.config.mjs	build(editor): Add the @n8n/module-cli module scaffolder (no-changelog) (#36427 )	2026-08-24 14:16:05 +00:00

README.md

@n8n/module-cli

Interactive scaffolder for n8n modules.

pnpm n8n-module-sdk create                    # prompts for name and stack
pnpm n8n-module-sdk create my-feature --stack=frontend

create writes packages/modules/<name>/<frontend|backend>.

Then read frontend-module-guide.md. It gives the descriptor contract, the import boundaries, the registration points and the problem in each one.

Frontend

A real, resolvable workspace package: source-only (main: "src/index.ts", no dist), consumed by the editor-ui shell through Vite aliases. Scaffolding it also makes the four registrations outside the package that a module needs before the shell can see it — the modulePackages table in @n8n/frontend-vite-config, editor-ui's dependency entry, editor-ui's tsconfig paths, and modules.manifest.ts. Re-running after a partial failure adds no second copy of any of them.

Biome runs over the new package and over every edited file at the end, because a registration line can be longer than the 100-column limit. Without that step the next format:check in CI fails on a module nobody touched by hand.

Backend

A placeholder. Nothing loads it. The backend runtime discovers modules under packages/cli/src/modules/<name>, which is where every real backend module lives; packages/modules/<name>/backend reserves the path for the day the two halves sit together and gets a README saying so. To create a backend module that runs, use pnpm setup-backend-module.

No build step

Plain ESM, run straight from src/. A dist would mean building the scaffolder before you can scaffold with it, which breaks on day one of a new machine.