@dawudesign/node-hexa-cli 0.2.4 → 0.2.5

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,11 +35,13 @@ 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
@@ -85,87 +62,55 @@ my-app/
 
 ---
 
-### `generate context`
+### `generate`
 
-Generates a complete bounded context inside an existing NestJS project.
+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
-cd my-app
+# New bounded context
 node-hexa generate context orders
-# ✓ Context 'orders' generated at src/contexts/orders/
-# → Import OrdersModule in your AppModule to activate it.
-```
-
----
-
-### `generate usecase`
-
-Generates a use case with its DTO and Vitest spec inside an existing bounded context.
-
-```bash
-node-hexa generate usecase <name> <context>
-```
 
-```bash
+# Use case inside a context
 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).
-
-```bash
-node-hexa generate aggregate <name> <context>
-```
 
-```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 +127,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 +157,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 +189,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 +198,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/package.json

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