@devmed555/angular-clean-architecture-cli 0.0.1

package/README.md

@@ -0,0 +1,183 @@
+# CLI Documentation
+
+The CLI is an Nx generator designed to scaffold clean architecture features within the `sandbox` application.
+
+## Usage
+
+To generate a new feature, run:
+
+```bash
+npm run generate:feature -- --name=<feature-name>
+
+# Examples:
+npm run generate:feature -- --name=products
+npm run generate:feature -- --name=user-profile
+npm run generate:feature -- --name=shopping-cart
+
+# Interactive mode with prompts:
+npm run generate:feature:interactive
+```
+
+### Arguments
+
+| Argument | Description | Required |
+| --- | --- | --- |
+| `--name` | The name of the feature to generate (kebab-case recommended). | Yes |
+
+### Generated Structure
+
+The generator will create the following structure in `apps/sandbox/src/app/features/<name>`:
+
+```
+<feature-name>/
+├── domain/
+│   └── model.ts              # Business entities (PascalCase interfaces)
+├── infrastructure/
+│   └── service.ts            # HTTP services with CRUD operations
+├── application/
+│   └── store.ts              # NgRx SignalStore for state management
+└── ui/
+    └── component.ts          # Standalone Angular component with store injection
+```
+
+### Naming Conventions
+
+The generator automatically handles naming:
+- **Input**: kebab-case (e.g., `user-profile`)
+- **Classes/Interfaces**: PascalCase (e.g., `UserProfileComponent`, `UserProfile`)
+- **Stores**: PascalCase with "Store" suffix (e.g., `UserProfileStore`)
+- **Services**: PascalCase with "Service" suffix (e.g., `UserProfileService`)
+
+### Example Generated Code
+
+For `npm run generate:feature -- --name=product`:
+
+**Domain Model** (`domain/model.ts`):
+```typescript
+export interface Product {
+  id: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+```
+
+**Infrastructure Service** (`infrastructure/service.ts`):
+```typescript
+@Injectable({ providedIn: 'root' })
+export class ProductService {
+  private readonly apiUrl = '/api/products';
+  
+  getAll(): Observable<Product[]> { ... }
+  getById(id: string): Observable<Product> { ... }
+  create(data: Omit<Product, 'id' | 'createdAt' | 'updatedAt'>): Observable<Product> { ... }
+  update(id: string, data: Partial<Product>): Observable<Product> { ... }
+  delete(id: string): Observable<void> { ... }
+}
+```
+
+**Application Store** (`application/store.ts`):
+```typescript
+export const ProductStore = signalStore(
+  { providedIn: 'root' },
+  withState({ loading: false })
+);
+```
+
+**UI Component** (`ui/component.ts`):
+```typescript
+@Component({
+  selector: 'app-product-feature',
+  standalone: true,
+  imports: [CommonModule],
+  template: `
+    <div class="product-feature">
+      <h1>Product Feature</h1>
+      @if (store.loading()) {
+        <p>Loading...</p>
+      } @else {
+        <p>Ready to build your product feature!</p>
+      }
+    </div>
+  `,
+})
+export class ProductComponent {
+  protected readonly store = inject(ProductStore);
+}
+```
+
+## Template Structure
+
+Templates are located in `src/generators/clean-feature/files/`:
+
+```
+files/
+├── application/
+│   └── store.ts.template       # SignalStore template
+├── domain/
+│   └── model.ts.template       # Interface template
+├── infrastructure/
+│   └── service.ts.template     # Service template with CRUD
+└── ui/
+    └── component.ts.template   # Component template with store
+```
+
+Templates use EJS syntax:
+- `<%= name %>` - Original kebab-case feature name
+- `<%= pascalName %>` - PascalCase version of the name
+
+## Development
+
+### Build the CLI
+
+```bash
+npm run cli:build
+```
+
+### Test the CLI
+
+```bash
+npm run cli:test
+```
+
+### Lint the CLI
+
+```bash
+npm run cli:lint
+```
+
+### Development Workflow
+
+1. **Modify templates** in `src/generators/clean-feature/files/`
+2. **Update generator logic** in `generator.ts` if needed
+3. **Build**: `npm run cli:build`
+4. **Test**: Generate a feature with `npm run generate:feature -- --name=test`
+5. **Verify**: Check generated code in `apps/sandbox/src/app/features/test`
+6. **Clean up**: Delete test feature after verification
+
+### Adding New Template Variables
+
+To add new template variables:
+
+1. Update `generator.ts`:
+   ```typescript
+   generateFiles(tree, ..., targetPath, {
+     ...options,
+     name,
+     pascalName,
+     yourNewVariable: computeValue(name), // Add here
+     tmpl: '',
+   });
+   ```
+
+2. Use in templates:
+   ```typescript
+   // In any .template file
+   export class <%= yourNewVariable %>Something { }
+   ```
+
+## Tips
+
+- **Feature naming**: Use kebab-case for multi-word features (e.g., `user-profile`, not `userProfile`)
+- **Testing**: Always test generated code in the sandbox app
+- **Customization**: Modify templates to match your team's conventions
+- **Validation**: Consider adding name validation in `generator.ts` to prevent duplicates

package/bin/index.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+console.log("ACA CLI installed successfully!");
+console.log("To use the generator, run: nx g @devmed555/angular-clean-architecture-cli:clean-feature");

package/generators.json

@@ -0,0 +1,9 @@
+{
+  "generators": {
+    "clean-feature": {
+      "factory": "./src/generators/clean-feature/generator",
+      "schema": "./src/generators/clean-feature/schema.json",
+      "description": "clean-feature generator"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@devmed555/angular-clean-architecture-cli",
+  "version": "0.0.1",
+  "description": "CLI generator for Angular Clean Architecture features using NgRx SignalStore",
+  "keywords": [
+    "angular",
+    "clean-architecture",
+    "ngrx",
+    "signal-store",
+    "cli",
+    "generator",
+    "schematics"
+  ],
+  "author": "Mohamed Bouattour <mohamedbouattour123@gmail.com>",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MohamedBouattour/angular-clean-architecture"
+  },
+  "bin": {
+    "aca": "./bin/index.js"
+  },
+  "dependencies": {
+    "@nx/devkit": "20.0.4",
+    "@nx/js": "20.0.4",
+    "@nx/angular": "20.0.4",
+    "tslib": "^2.3.0",
+    "inquirer": "^9.2.12"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "private": false,
+  "generators": "./generators.json",
+  "types": "./src/index.d.ts"
+}

package/src/generators/clean-feature/files/application/store.ts.template

@@ -0,0 +1,6 @@
+import { signalStore, withState } from '@ngrx/signals';
+
+export const <%= pascalName %>Store = signalStore(
+  { providedIn: 'root' },
+  withState({ loading: false })
+);

package/src/generators/clean-feature/files/domain/model.ts.template

@@ -0,0 +1,4 @@
+export interface <%= pascalName %> {
+  id: string;
+<% attributes.forEach(function(attr) { %>  <%= attr.name %>: <%= attr.type %>;
+<% }); %>}

package/src/generators/clean-feature/files/infrastructure/service.ts.template

@@ -0,0 +1,31 @@
+import { Injectable } from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { <%= pascalName %> } from '../domain/model';
+
+@Injectable({ providedIn: 'root' })
+export class <%= pascalName %>Service {
+  private readonly apiUrl = '/api/<%= name %>s';
+
+  constructor(private http: HttpClient) {}
+
+  getAll(): Observable<<%= pascalName %>[]> {
+    return this.http.get<<%= pascalName %>[]>(this.apiUrl);
+  }
+
+  getById(id: string): Observable<<%= pascalName %>> {
+    return this.http.get<<%= pascalName %>>(`${this.apiUrl}/${id}`);
+  }
+
+  create(data: Omit<<%= pascalName %>, 'id'>): Observable<<%= pascalName %>> {
+    return this.http.post<<%= pascalName %>>(this.apiUrl, data);
+  }
+
+  update(id: string, data: Partial<<%= pascalName %>>): Observable<<%= pascalName %>> {
+    return this.http.put<<%= pascalName %>>(`${this.apiUrl}/${id}`, data);
+  }
+
+  delete(id: string): Observable<void> {
+    return this.http.delete<void>(`${this.apiUrl}/${id}`);
+  }
+}

package/src/generators/clean-feature/files/ui/component.ts.template

@@ -0,0 +1,44 @@
+import { Component, inject } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { <%= pascalName %>Store } from '../application/store';
+
+@Component({
+  selector: 'app-<%= name %>-feature',
+  standalone: true,
+  imports: [CommonModule],
+  template: `
+    <div class="<%= name %>-feature">
+      <h1><%= pascalName %> Feature</h1>
+      
+      @if (store.loading()) {
+        <p>Loading...</p>
+      } @else {
+        <p>Ready to build your <%= name %> feature!</p>
+        
+        <!-- Example list of <%= name %> items -->
+        <ul>
+          @for (item of []; track item.id) {
+            <li>
+              <% attributes.forEach(function(attr) { %>
+              <strong><%= attr.name %>:</strong> {{ item.<%= attr.name %> }}<br/>
+              <% }); %>
+            </li>
+          }
+        </ul>
+      }
+    </div>
+  `,
+  styles: `
+    .<%= name %>-feature {
+      padding: 1rem;
+    }
+
+    h1 {
+      color: #333;
+      margin-bottom: 1rem;
+    }
+  `,
+})
+export class <%= pascalName %>Component {
+  protected readonly store = inject(<%= pascalName %>Store);
+}

package/src/generators/clean-feature/generator.d.ts

@@ -0,0 +1,4 @@
+import { Tree } from '@nx/devkit';
+import { CleanFeatureGeneratorSchema } from './schema';
+export declare function cleanFeatureGenerator(tree: Tree, options: CleanFeatureGeneratorSchema): Promise<void>;
+export default cleanFeatureGenerator;

package/src/generators/clean-feature/generator.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cleanFeatureGenerator = cleanFeatureGenerator;
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+/**
+ * Capitalizes the first letter of a string
+ */
+function capitalizeFirst(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+/**
+ * Converts a kebab-case or camelCase string to PascalCase
+ */
+function toPascalCase(str) {
+    return str
+        .split('-')
+        .map(part => capitalizeFirst(part))
+        .join('');
+}
+function cleanFeatureGenerator(tree, options) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const name = options.name;
+        const targetPath = (0, devkit_1.joinPathFragments)('apps/sandbox/src/app/features', name);
+        // Format names for templates
+        const pascalName = toPascalCase(name);
+        // Parse attributes
+        let attributes = [];
+        if (options.attributes) {
+            attributes = options.attributes.split(',').map(attr => {
+                const [name, type] = attr.split(':');
+                return { name, type: type || 'string' };
+            });
+        }
+        else {
+            // If running in interactive mode (and no attributes provided), we could prompt
+            // But since this runs in Nx context, standard inquirer might conflict if not handled carefully
+            // For now we'll support the --attributes flag passed from the interactive CLI wrapper
+            attributes = [
+                { name: 'createdAt', type: 'Date' },
+                { name: 'updatedAt', type: 'Date' }
+            ];
+        }
+        // Generate files from templates
+        (0, devkit_1.generateFiles)(tree, (0, devkit_1.joinPathFragments)(__dirname, 'files'), targetPath, Object.assign(Object.assign({}, options), { name,
+            pascalName,
+            attributes, tmpl: '' }));
+        yield (0, devkit_1.formatFiles)(tree);
+    });
+}
+exports.default = cleanFeatureGenerator;
+//# sourceMappingURL=generator.js.map

package/src/generators/clean-feature/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../apps/cli/src/generators/clean-feature/generator.ts"],"names":[],"mappings":";;AAyBA,sDA2CC;;AApED,uCAKoB;AAGpB;;GAEG;AACH,SAAS,eAAe,CAAC,GAAW;IAClC,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACpD,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,GAAW;IAC/B,OAAO,GAAG;SACP,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;SAClC,IAAI,CAAC,EAAE,CAAC,CAAC;AACd,CAAC;AAED,SAAsB,qBAAqB,CACzC,IAAU,EACV,OAAoC;;QAEpC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1B,MAAM,UAAU,GAAG,IAAA,0BAAiB,EAAC,+BAA+B,EAAE,IAAI,CAAC,CAAC;QAE5E,6BAA6B;QAC7B,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAEtC,mBAAmB;QACnB,IAAI,UAAU,GAAqC,EAAE,CAAC;QAEtD,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;YACvB,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;gBACpD,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACrC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,+EAA+E;YAC/E,+FAA+F;YAC/F,sFAAsF;YACtF,UAAU,GAAG;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE;gBACnC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE;aACpC,CAAC;QACJ,CAAC;QAED,gCAAgC;QAChC,IAAA,sBAAa,EACX,IAAI,EACJ,IAAA,0BAAiB,EAAC,SAAS,EAAE,OAAO,CAAC,EACrC,UAAU,kCAEL,OAAO,KACV,IAAI;YACJ,UAAU;YACV,UAAU,EACV,IAAI,EAAE,EAAE,IAEX,CAAC;QAEF,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;CAAA;AAED,kBAAe,qBAAqB,CAAC"}

package/src/generators/clean-feature/schema.d.ts

@@ -0,0 +1,4 @@
+export interface CleanFeatureGeneratorSchema {
+  name: string;
+  attributes?: string;
+}

package/src/generators/clean-feature/schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "CleanFeature",
+  "title": "",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the feature to generate",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use?"
+    },
+    "attributes": {
+      "type": "string",
+      "description": "Comma-separated list of attributes (e.g., name:string,age:number)",
+      "x-prompt": "Enter attributes (format: name:string,age:number) or leave empty:"
+    }
+  },
+  "required": ["name"]
+}

package/src/index.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../apps/cli/src/index.ts"],"names":[],"mappings":""}