@dawudesign/node-hexa-cli 0.2.4 → 0.2.6

package/README.md

@@ -2,17 +2,16 @@
 
 > Scaffold and enforce **NestJS Hexagonal DDD** architecture from the command line.
 
-**node-hexa** automates the repetitive parts of clean architecture in NestJS:
-
-- **Scaffold** — generates a full bounded context with dependency injection pre-wired, in one command
-- **Enforce** — statically analyzes your TypeScript source and reports architecture violations
-- **Document** — exports a Mermaid diagram and architecture report as Markdown or SVG
+- **Scaffold** — generate a full NestJS project or bounded context in one command
+- **Enforce** — statically analyze your TypeScript source and report architecture violations
+- **Document** — export a Mermaid diagram and architecture report
 
 ---
 
 ## Requirements
 
-- **Node.js ≥ 20**
+- Node.js ≥ 20
+- npm or pnpm
 
 ---
 
@@ -22,37 +21,13 @@
 npm install -g @dawudesign/node-hexa-cli
 ```
 
-Verify:
-
-```bash
-node-hexa --version
-node-hexa --help
-```
-
----
-
-## Quickstart
-
-```bash
-# 1. Create a new NestJS Hexagonal DDD project
-node-hexa init my-app
-cd my-app
-
-# 2. Start the server
-pnpm start:dev
-
-# 3. Verify architecture is clean
-node-hexa check .
-# ✓ Architecture check passed
-```
-
 ---
 
 ## Commands
 
 ### `init`
 
-Creates a new NestJS project with the complete Hexagonal DDD structure.
+Create a new NestJS project with the full Hexagonal DDD structure.
 
 ```bash
 node-hexa init <name>
@@ -60,112 +35,80 @@ node-hexa init <name>
 
 ```bash
 node-hexa init my-app
+cd my-app
+pnpm start:dev
 ```
 
-Generates:
+Generated structure:
 
-```text
+```
 my-app/
 ├── src/
 │   ├── main.ts
 │   ├── app.module.ts
-│   └── contexts/
-│       └── iam/
-│           ├── iam.module.ts
-│           ├── domain/
-│           │   ├── entities/user.entity.ts
-│           │   └── ports/user.repository.port.ts
-│           ├── application/
-│           │   └── use-cases/create-user.usecase.ts
-│           └── infrastructure/
-│               ├── http/user.controller.ts
-│               └── persistence/in-memory-user.repository.ts
+│   ├── contexts/       ← add your bounded contexts here
+│   └── shared/
 └── node-hexa.config.json
 ```
 
----
-
-### `generate context`
-
-Generates a complete bounded context inside an existing NestJS project.
-
-```bash
-node-hexa generate context <name>
-```
+Then add your first bounded context:
 
 ```bash
 cd my-app
 node-hexa generate context orders
-# ✓ Context 'orders' generated at src/contexts/orders/
-# → Import OrdersModule in your AppModule to activate it.
 ```
 
 ---
 
-### `generate usecase`
+### `generate`
 
-Generates a use case with its DTO and Vitest spec inside an existing bounded context.
+Generate scaffolding inside an existing project.
 
 ```bash
+node-hexa generate context <name>
 node-hexa generate usecase <name> <context>
+node-hexa generate aggregate <name> <context>
 ```
 
 ```bash
-node-hexa generate usecase delete-user iam
-# ✓ Use case 'delete-user' generated in context 'iam'
-```
-
-Generated files:
-
-```text
-src/contexts/iam/application/use-cases/
-├── delete-user.usecase.ts
-├── delete-user.dto.ts
-└── delete-user.usecase.spec.ts
-```
-
----
-
-### `generate aggregate`
-
-Generates a full DDD aggregate (entity, value object, port, use case, in-memory repository, HTTP controller, NestJS module).
+# New bounded context
+node-hexa generate context orders
 
-```bash
-node-hexa generate aggregate <name> <context>
-```
+# Use case inside a context
+node-hexa generate usecase delete-user iam
 
-```bash
+# Full DDD aggregate (entity, port, use case, controller, repository)
 node-hexa generate aggregate product catalog
-# ✓ Aggregate 'product' generated in context 'catalog'
 ```
 
 ---
 
 ### `check`
 
-Checks architecture rules — exits `0` if clean, `1` if violations found. Designed for CI/CD.
+Check architecture violations. Exits `0` if clean, `1` if violations found. Designed for CI.
 
 ```bash
-node-hexa check <path> [--watch]
+node-hexa check <path>
+node-hexa check <path> --watch
 ```
 
 ```bash
 # One-shot (CI)
 node-hexa check .
 
-# Watch mode (development)
+# Watch mode
 node-hexa check . --watch
 ```
 
 Output:
 
-```text
+```
 ✓ Architecture check passed
 ```
 
 or:
 
-```text
+```
 ✗ Architecture violations detected
 
   [CRITICAL] Domain must not depend on infrastructure → UserEntity
@@ -182,27 +125,19 @@ Full analysis: layers, violations, bounded contexts, Mermaid diagram, and score.
 node-hexa analyze <path>
 ```
 
-```bash
-node-hexa analyze .
-```
-
 ---
 
 ### `list`
 
-Lists all bounded contexts and their components.
+List all bounded contexts and their components.
 
 ```bash
 node-hexa list <path>
 ```
 
-```bash
-node-hexa list .
-```
-
 Output:
 
-```text
+```
 Bounded Contexts (2)
 
   IAM
@@ -220,27 +155,21 @@ Bounded Contexts (2)
 
 ### `docs`
 
-Generates an `architecture.md` at the project root with the Mermaid diagram, violations, and score.
+Generate an `architecture.md` at the project root with the Mermaid diagram and violations.
 
 ```bash
 node-hexa docs <path>
 ```
 
-```bash
-node-hexa docs .
-# Architecture documentation generated: ./architecture.md
-```
-
 ---
 
 ### `graph`
 
-Generates an `architecture.svg` dependency graph (requires `@mermaid-js/mermaid-cli`).
+Generate an `architecture.svg` dependency graph (requires `@mermaid-js/mermaid-cli`).
 
 ```bash
 npm install -g @mermaid-js/mermaid-cli
-node-hexa graph .
-# Architecture graph generated: ./architecture.svg
+node-hexa graph <path>
 ```
 
 ---
@@ -258,8 +187,8 @@ node-hexa graph .
 ```
 
 | Key | Type | Default | Description |
-| --- | --- | --- | --- |
-| `architecture` | `string` | required | Architecture type — `hexagonal-ddd` |
+|-----|------|---------|-------------|
+| `architecture` | `string` | `"hexagonal-ddd"` | Architecture type |
 | `strict` | `boolean` | `true` | `false` silences `MEDIUM` violations |
 | `contextsDir` | `string` | `"src/contexts"` | Path to bounded contexts directory |
 
@@ -267,17 +196,16 @@ node-hexa graph .
 
 ## Violation rules
 
-| Violation | Severity | Score penalty |
-| --- | --- | --- |
-| Domain imports from infrastructure / adapter | `CRITICAL` | −25 pts |
-| Domain imports from application | `CRITICAL` | −25 pts |
-| Application imports from infrastructure / adapter | `HIGH` | −15 pts |
-| Domain imports a framework (`@nestjs/*`, `prisma`, etc.) | `CRITICAL` | −25 pts |
-
-Score = `100 − sum of penalties`, minimum 0.
+| Violation | Severity |
+|-----------|----------|
+| Domain imports from infrastructure or adapter | `CRITICAL` |
+| Domain imports from application | `CRITICAL` |
+| Domain imports a framework (`@nestjs/*`, `prisma`…) | `CRITICAL` |
+| Application imports from infrastructure or adapter | `HIGH` |
 
 ---
 
 ## License
 
-MIT — free to use, modify and distribute.
+MIT
+

package/dist/index.js

@@ -403,10 +403,7 @@ function generateProject(name) {
   const src = import_node_path5.default.join(base, "src");
   import_node_fs4.default.rmSync(src, { recursive: true, force: true });
   const dirs = [
-    "src/contexts/iam/domain/ports",
-    "src/contexts/iam/application/use-cases",
-    "src/contexts/iam/infrastructure/http",
-    "src/contexts/iam/infrastructure/persistence",
+    "src/contexts",
     "src/shared"
   ];
   dirs.forEach((dir) => {
@@ -427,127 +424,17 @@ bootstrap();
   import_node_fs4.default.writeFileSync(
     import_node_path5.default.join(base, "src/app.module.ts"),
     `import { Module } from '@nestjs/common';
-import { IamModule } from './contexts/iam/iam.module';
 
 @Module({
-  imports: [IamModule],
-})
-export class AppModule {}
-`
-  );
-  import_node_fs4.default.writeFileSync(
-    import_node_path5.default.join(base, "src/contexts/iam/domain/entities/user.entity.ts"),
-    `export class User {
-  constructor(
-    public readonly id: string,
-    public readonly email: string,
-    public readonly name: string,
-  ) {}
-}
-`
-  );
-  import_node_fs4.default.writeFileSync(
-    import_node_path5.default.join(base, "src/contexts/iam/domain/ports/user.repository.port.ts"),
-    `import { User } from '../entities/user.entity';
-
-export const USER_REPOSITORY_PORT = Symbol('UserRepositoryPort');
-
-export interface UserRepositoryPort {
-  save(user: User): Promise<void>;
-  findById(id: string): Promise<User | null>;
-}
-`
-  );
-  import_node_fs4.default.writeFileSync(
-    import_node_path5.default.join(base, "src/contexts/iam/application/use-cases/create-user.usecase.ts"),
-    `import { Inject, Injectable } from '@nestjs/common';
-import { User } from '../../domain/entities/user.entity';
-import {
-  USER_REPOSITORY_PORT,
-  UserRepositoryPort,
-} from '../../domain/ports/user.repository.port';
-import { randomUUID } from 'node:crypto';
-
-export interface CreateUserDto {
-  email: string;
-  name: string;
-}
-
-@Injectable()
-export class CreateUserUseCase {
-  constructor(
-    @Inject(USER_REPOSITORY_PORT)
-    private readonly userRepository: UserRepositoryPort,
-  ) {}
-
-  async execute(dto: CreateUserDto): Promise<User> {
-    const user = new User(randomUUID(), dto.email, dto.name);
-    await this.userRepository.save(user);
-    return user;
-  }
-}
-`
-  );
-  import_node_fs4.default.writeFileSync(
-    import_node_path5.default.join(
-      base,
-      "src/contexts/iam/infrastructure/persistence/in-memory-user.repository.ts"
-    ),
-    `import { Injectable } from '@nestjs/common';
-import { User } from '../../domain/entities/user.entity';
-import { UserRepositoryPort } from '../../domain/ports/user.repository.port';
-
-@Injectable()
-export class InMemoryUserRepository implements UserRepositoryPort {
-  private readonly store = new Map<string, User>();
-
-  async save(user: User): Promise<void> {
-    this.store.set(user.id, user);
-  }
-
-  async findById(id: string): Promise<User | null> {
-    return this.store.get(id) ?? null;
-  }
-}
-`
-  );
-  import_node_fs4.default.writeFileSync(
-    import_node_path5.default.join(base, "src/contexts/iam/infrastructure/http/user.controller.ts"),
-    `import { Body, Controller, Post } from '@nestjs/common';
-import { CreateUserUseCase, CreateUserDto } from '../../application/use-cases/create-user.usecase';
-
-@Controller('users')
-export class UserController {
-  constructor(private readonly createUser: CreateUserUseCase) {}
-
-  @Post()
-  async create(@Body() dto: CreateUserDto) {
-    return this.createUser.execute(dto);
-  }
-}
-`
-  );
-  import_node_fs4.default.writeFileSync(
-    import_node_path5.default.join(base, "src/contexts/iam/iam.module.ts"),
-    `import { Module } from '@nestjs/common';
-import { USER_REPOSITORY_PORT } from './domain/ports/user.repository.port';
-import { InMemoryUserRepository } from './infrastructure/persistence/in-memory-user.repository';
-import { CreateUserUseCase } from './application/use-cases/create-user.usecase';
-import { UserController } from './infrastructure/http/user.controller';
-
-@Module({
-  controllers: [UserController],
-  providers: [
-    {
-      provide: USER_REPOSITORY_PORT,
-      useClass: InMemoryUserRepository,
-    },
-    CreateUserUseCase,
+  imports: [
+    // Import your bounded context modules here
+    // e.g. import { OrdersModule } from './contexts/orders/orders.module';
   ],
 })
-export class IamModule {}
+export class AppModule {}
 `
   );
+  import_node_fs4.default.writeFileSync(import_node_path5.default.join(base, "src/contexts/.gitkeep"), "");
   import_node_fs4.default.writeFileSync(import_node_path5.default.join(base, "src/shared/.gitkeep"), "");
   import_node_fs4.default.writeFileSync(
     import_node_path5.default.join(base, "node-hexa.config.json"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dawudesign/node-hexa-cli",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "CLI to scaffold and analyze NestJS Hexagonal DDD projects",
   "keywords": [
     "nestjs",