nest-pilot
v0.2.3
Published
Interactive CLI for generating NestJS projects with Hexagonal, DDD, or Modular architecture
Downloads
11
Maintainers
Readme
cli/
The cli npm workspace package. This is the user-facing binary (nest-pilot) and the composer engine that powers project generation.
Currently supports:
- Hexagonal Architecture
What belongs here
src/commands/— Commander command definitions. One file per top-level CLI command (create, and future commands).src/prompts/— Clack interactive prompt flows. One file per command that requires user input.src/composer/— The template composer engine (see its own README).src/utils/— Pure utility functions with no side effects. No I/O, no framework imports.__mocks__/— Manual Jest mocks for ESM-only runtime dependencies (see ADR-002).
What is forbidden here
- NestJS imports of any kind — this is a build tool, not an application.
- Business logic — the CLI is only responsible for collecting user input and invoking the composer.
- Direct filesystem writes outside of
composer/renderFiles.ts. - Architecture-specific knowledge in commands or prompts — that belongs in the composer and the templates.
Entry Point
cli/
├── src/index.ts ← Binary shebang + Commander root program
└── dist/index.js ← Compiled output (generated by `npm run build`)Dev Scripts
npm run build # Compile TypeScript → dist/
npm run dev # Run from source via tsx (no compile step)
npm run test # Jest test suite