mirror of
https://github.com/n8n-io/n8n.git
synced 2026-10-17 05:29:44 +02:00
| .. | ||
| src | ||
| test | ||
| oxlint.config.mts | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| vitest.config.ts | ||
@n8n/backend-module-quick-connect
Backend feature module. The n8n runtime loads the module through the lazy import in
packages/cli/src/modules/modules.manifest.ts.
pnpm turbo typecheck --filter=@n8n/backend-module-quick-connect
pnpm turbo lint --filter=@n8n/backend-module-quick-connect
pnpm turbo test --filter=@n8n/backend-module-quick-connect
Go through Turbo. It builds this package's workspace dependencies first.
Read scripts/backend-module/backend-module-guide.md for the module lifecycle, REST controller,
service, repository, entity, configuration, and testing patterns.
Import rules
- Do not import from
packages/clior from then8npackage. - Declare each workspace and third-party import in this package.
- Export APIs for other packages from
src/index.ts. - Keep the module entrypoint in the
./moduleexport. Do not export it fromsrc/index.ts. Importing the entrypoint runs the@BackendModuledecorator. - Use dynamic imports inside the module entrypoint. This keeps disabled modules unloaded.
- Keep TypeORM imports in entity and repository files.