@ngflow/ng-architect 1.0.1 → 1.0.3

package/README.md

@@ -1,28 +1,43 @@
-# Getting Started With Schematics
+# ![ng-architect](https://img.shields.io/badge/ng--architect-angular-blue)
 
-This repository is a basic Schematic implementation that serves as a starting point to create and publish Schematics to NPM.
+[![npm version](https://img.shields.io/npm/v/@ngflow/ng-architect?color=blue)](https://www.npmjs.com/package/@ngflow/ng-architect) [![License](https://img.shields.io/npm/l/@ngflow/ng-architect)](https://opensource.org/licenses/MIT)
 
-### Testing
+`ng-architect` is an **Angular schematic** that automates the creation of **complete features** while keeping a clean and consistent **project structure and architecture**.  
 
-To test locally, install `@angular-devkit/schematics-cli` globally and use the `schematics` command line tool. That tool acts the same as the `generate` command of the Angular CLI, but also has a debug mode.
+It generates **pages, services, models, store, and routes**, making your development faster and more organized.
 
-Check the documentation with
+---
+
+## 📦 Installation
 
 ```bash
-schematics --help
+# Install as a dev dependency
+npm install @ngflow/ng-architect --save-dev
 ```
 
-### Unit Testing
-
-`npm run test` will run the unit tests, using Jasmine as a runner and test framework.
-
-### Publishing
+## Usage
+```bash 
+ng g @ngflow/ng-architect:ng-architect --name=<feature-name>
 
-To publish, simply do:
 
-```bash
-npm run build
-npm publish
+example: 
+ng g @ngflow/ng-architect:ng-architect --name=user-profile
 ```
 
-That's it!
+```bash
+This will create the following structure:
+
+src/app/features/user-profile/
+ ├─ data/
+ │   ├─ user-profile.service.ts
+ │   └─ user-profile.store.ts
+ ├─ models/
+ │   └─ user-profile.model.ts
+ └─ pages/
+     ├─ user-profile.page.ts
+     ├─ user-profile.page.html
+     └─ user-profile.page.scss
+
+
+If app.routes.ts exists, the feature route will be added automatically.
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ngflow/ng-architect",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Angular schematics to generate files and maintain clean architecture",
   "scripts": {
     "build": "tsc -p tsconfig.json",

package/src/ng-architect/files/src/app/features/__featureKebab__/__featureKebab__.routes.ts

@@ -0,0 +1,9 @@
+import { Routes } from '@angular/router';
+import { <%= featurePascal %>Page } from './pages/<%= featureKebab %>.page';
+
+export const <%= featurePascal %>Routes: Routes = [
+  {
+    path: '',
+    component: <%= featurePascal %>Page,
+  },
+];

package/src/ng-architect/files/src/app/features/__featureKebab__/data/__featureKebab__.service.ts

@@ -0,0 +1,4 @@
+import { Injectable } from '@angular/core';
+
+@Injectable({ providedIn: 'root' })
+export class <%= featurePascal %>Service {}

package/src/ng-architect/files/src/app/features/__featureKebab__/data/__featureKebab__.store.ts

@@ -0,0 +1,13 @@
+import { signal } from '@angular/core';
+
+export interface <%= featurePascal %>State {
+  data: unknown;
+  loading: boolean;
+}
+
+export const <%= featurePascal %>Store = {
+  state: signal<<%= featurePascal %>State>({
+    data: null,
+    loading: false,
+  }),
+};

package/src/ng-architect/files/src/app/features/__featureKebab__/models/__featureKebab__.model.ts

@@ -0,0 +1,3 @@
+export interface <%= featurePascal %> {
+  id: string;
+}

package/src/ng-architect/files/src/app/features/__featureKebab__/pages/__featureKebab__.page.ts

@@ -0,0 +1,11 @@
+import { ChangeDetectionStrategy, Component } from '@angular/core';
+
+@Component({
+  selector: 'app-<%= featureKebab %>',
+  standalone: true,
+  imports: [],
+  templateUrl: './<%= featureKebab %>.page.html',
+  styleUrl: './<%= featureKebab %>.page.scss',
+  changeDetection: ChangeDetectionStrategy.OnPush,
+})
+export class <%= featurePascal %>Page {}

package/src/ng-architect/index.js

@@ -9,7 +9,7 @@ const toKebabCase = (value) => value
     .toLowerCase();
 const toPascalCase = (value) => value
     .split(/[-_]/)
-    .map(part => part.charAt(0).toUpperCase() + part.slice(1))
+    .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
     .join('');
 function default_1(options) {
     const featureKebab = toKebabCase(options.name);
@@ -20,7 +20,7 @@ function default_1(options) {
         },
         // Generate files from templates
         (0, schematics_1.mergeWith)((0, schematics_1.apply)((0, schematics_1.url)('./files'), [
-            (0, schematics_1.filter)(path => !path.endsWith('.swp')),
+            (0, schematics_1.filter)((path) => !path.endsWith('.swp')),
             (0, schematics_1.template)({
                 featureKebab,
                 featurePascal,
@@ -28,9 +28,10 @@ function default_1(options) {
         ])),
         // Update app.routes.ts if it exists
         (tree, context) => {
+            var _a;
             const appRoutesPath = 'src/app/app.routes.ts';
             if (tree.exists(appRoutesPath)) {
-                let content = tree.read(appRoutesPath)?.toString('utf-8') || '';
+                let content = ((_a = tree.read(appRoutesPath)) === null || _a === void 0 ? void 0 : _a.toString('utf-8')) || '';
                 const routePattern = new RegExp(`path:\\s*['"]${featureKebab}['"]`);
                 if (!routePattern.test(content)) {
                     const routeBlock = `  {

package/src/ng-architect/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;AAyBA,4BAkDC;AA3ED,2DAUoC;AAEpC,mBAAmB;AACnB,MAAM,WAAW,GAAG,CAAC,KAAa,EAAU,EAAE,CAC5C,KAAK;KACF,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;KACnC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;KAClB,WAAW,EAAE,CAAC;AAEnB,MAAM,YAAY,GAAG,CAAC,KAAa,EAAU,EAAE,CAC7C,KAAK;KACF,KAAK,CAAC,MAAM,CAAC;KACb,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KACzD,IAAI,CAAC,EAAE,CAAC,CAAC;AAEd,mBAAyB,OAAY;IACnC,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD,OAAO,IAAA,kBAAK,EAAC;QACX,CAAC,KAAW,EAAE,OAAyB,EAAE,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,aAAa,KAAK,YAAY,GAAG,CAAC,CAAC;QAC/E,CAAC;QAED,gCAAgC;QAChC,IAAA,sBAAS,EACP,IAAA,kBAAK,EAAC,IAAA,gBAAG,EAAC,SAAS,CAAC,EAAE;YACpB,IAAA,mBAAM,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACtC,IAAA,qBAAQ,EAAC;gBACP,YAAY;gBACZ,aAAa;aACd,CAAC;SACH,CAAC,CACH;QAED,oCAAoC;QACpC,CAAC,IAAU,EAAE,OAAyB,EAAE,EAAE;YACxC,MAAM,aAAa,GAAG,uBAAuB,CAAC;YAE9C,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC/B,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;gBAEhE,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,gBAAgB,YAAY,MAAM,CAAC,CAAC;gBACpE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBAChC,MAAM,UAAU,GAAG;aAChB,YAAY;;2BAEE,YAAY,IAAI,YAAY;uBAChC,aAAa;KAC/B,CAAC;oBAEI,oCAAoC;oBACpC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,UAAU,MAAM,CAAC,CAAC;oBAC9D,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;oBACvC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,YAAY,8BAA8B,CAAC,CAAC;gBAC7E,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,YAAY,8BAA8B,CAAC,CAAC;gBAC9E,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,qEAAqE,CAAC,CAAC;YAC7F,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;AAyBA,4BAkDC;AA3ED,2DAUoC;AAEpC,mBAAmB;AACnB,MAAM,WAAW,GAAG,CAAC,KAAa,EAAU,EAAE,CAC5C,KAAK;KACF,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;KACnC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;KAClB,WAAW,EAAE,CAAC;AAEnB,MAAM,YAAY,GAAG,CAAC,KAAa,EAAU,EAAE,CAC7C,KAAK;KACF,KAAK,CAAC,MAAM,CAAC;KACb,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;KAC3D,IAAI,CAAC,EAAE,CAAC,CAAC;AAEd,mBAAyB,OAAY;IACnC,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD,OAAO,IAAA,kBAAK,EAAC;QACX,CAAC,KAAW,EAAE,OAAyB,EAAE,EAAE;YACzC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,aAAa,KAAK,YAAY,GAAG,CAAC,CAAC;QAC/E,CAAC;QAED,gCAAgC;QAChC,IAAA,sBAAS,EACP,IAAA,kBAAK,EAAC,IAAA,gBAAG,EAAC,SAAS,CAAC,EAAE;YACpB,IAAA,mBAAM,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACxC,IAAA,qBAAQ,EAAC;gBACP,YAAY;gBACZ,aAAa;aACd,CAAC;SACH,CAAC,CACH;QAED,oCAAoC;QACpC,CAAC,IAAU,EAAE,OAAyB,EAAE,EAAE;;YACxC,MAAM,aAAa,GAAG,uBAAuB,CAAC;YAE9C,IAAI,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC/B,IAAI,OAAO,GAAG,CAAA,MAAA,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,0CAAE,QAAQ,CAAC,OAAO,CAAC,KAAI,EAAE,CAAC;gBAEhE,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,gBAAgB,YAAY,MAAM,CAAC,CAAC;gBACpE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBAChC,MAAM,UAAU,GAAG;aAChB,YAAY;;2BAEE,YAAY,IAAI,YAAY;uBAChC,aAAa;KAC/B,CAAC;oBAEI,oCAAoC;oBACpC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,UAAU,MAAM,CAAC,CAAC;oBAC9D,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;oBACvC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,YAAY,8BAA8B,CAAC,CAAC;gBAC7E,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,YAAY,8BAA8B,CAAC,CAAC;gBAC9E,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,qEAAqE,CAAC,CAAC;YAC7F,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}

package/src/ng-architect/index.ts

@@ -0,0 +1,76 @@
+import {
+  Rule,
+  SchematicContext,
+  Tree,
+  apply,
+  chain,
+  filter,
+  mergeWith,
+  template,
+  url,
+} from '@angular-devkit/schematics';
+
+// Helper functions
+const toKebabCase = (value: string): string =>
+  value
+    .replace(/([a-z])([A-Z])/g, '$1-$2')
+    .replace(/_/g, '-')
+    .toLowerCase();
+
+const toPascalCase = (value: string): string =>
+  value
+    .split(/[-_]/)
+    .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+    .join('');
+
+export default function (options: any): Rule {
+  const featureKebab = toKebabCase(options.name);
+  const featurePascal = toPascalCase(options.name);
+
+  return chain([
+    (_tree: Tree, context: SchematicContext) => {
+      context.logger.info(`✅ Criando feature: ${featurePascal} (${featureKebab})`);
+    },
+
+    // Generate files from templates
+    mergeWith(
+      apply(url('./files'), [
+        filter((path) => !path.endsWith('.swp')),
+        template({
+          featureKebab,
+          featurePascal,
+        }),
+      ])
+    ),
+
+    // Update app.routes.ts if it exists
+    (tree: Tree, context: SchematicContext) => {
+      const appRoutesPath = 'src/app/app.routes.ts';
+
+      if (tree.exists(appRoutesPath)) {
+        let content = tree.read(appRoutesPath)?.toString('utf-8') || '';
+
+        const routePattern = new RegExp(`path:\\s*['"]${featureKebab}['"]`);
+        if (!routePattern.test(content)) {
+          const routeBlock = `  {
+    path: '${featureKebab}',
+    loadChildren: () =>
+      import('./features/${featureKebab}/${featureKebab}.routes')
+        .then(m => m.${featurePascal}Routes),
+  },`;
+
+          // Insert before the closing bracket
+          content = content.replace(/\n\];\s*$/, `\n${routeBlock}\n];`);
+          tree.overwrite(appRoutesPath, content);
+          context.logger.info(`➕ Rota "${featureKebab}" registada em app.routes.ts`);
+        } else {
+          context.logger.warn(`ℹ️ Rota "${featureKebab}" já existe em app.routes.ts`);
+        }
+      } else {
+        context.logger.warn('⚠️ app.routes.ts não encontrado, rota não registada automaticamente');
+      }
+
+      return tree;
+    },
+  ]);
+}

package/src/ng-architect/index_spec.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const schematics_1 = require("@angular-devkit/schematics");
 const testing_1 = require("@angular-devkit/schematics/testing");
@@ -6,16 +15,16 @@ const path = require("path");
 // SchematicTestRunner needs an absolute path to the collection to test.
 const collectionPath = path.join(__dirname, '../collection.json');
 describe('my-full-schematic', () => {
-    it('requires required option', async () => {
+    it('requires required option', () => __awaiter(void 0, void 0, void 0, function* () {
         // We test that
         const runner = new testing_1.SchematicTestRunner('schematics', collectionPath);
-        await expectAsync(runner.runSchematic('my-full-schematic', {}, schematics_1.Tree.empty())).toBeRejected();
-    });
-    it('works', async () => {
+        yield expectAsync(runner.runSchematic('my-full-schematic', {}, schematics_1.Tree.empty())).toBeRejected();
+    }));
+    it('works', () => __awaiter(void 0, void 0, void 0, function* () {
         const runner = new testing_1.SchematicTestRunner('schematics', collectionPath);
-        const tree = await runner.runSchematic('my-full-schematic', { name: 'str' }, schematics_1.Tree.empty());
+        const tree = yield runner.runSchematic('my-full-schematic', { name: 'str' }, schematics_1.Tree.empty());
         // Listing files
         expect(tree.files.sort()).toEqual(['/allo', '/hola', '/test1', '/test2']);
-    });
+    }));
 });
 //# sourceMappingURL=index_spec.js.map

package/src/ng-architect/index_spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"index_spec.js","sourceRoot":"","sources":["index_spec.ts"],"names":[],"mappings":";;AAAA,2DAAkD;AAClD,gEAAyE;AACzE,6BAA6B;AAE7B,wEAAwE;AACxE,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;AAElE,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,eAAe;QACf,MAAM,MAAM,GAAG,IAAI,6BAAmB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACrE,MAAM,WAAW,CACf,MAAM,CAAC,YAAY,CAAC,mBAAmB,EAAE,EAAE,EAAE,iBAAI,CAAC,KAAK,EAAE,CAAC,CAC3D,CAAC,YAAY,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;QACrB,MAAM,MAAM,GAAG,IAAI,6BAAmB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACrE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,iBAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAE3F,gBAAgB;QAChB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"index_spec.js","sourceRoot":"","sources":["index_spec.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,2DAAkD;AAClD,gEAAyE;AACzE,6BAA6B;AAE7B,wEAAwE;AACxE,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;AAElE,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,0BAA0B,EAAE,GAAS,EAAE;QACxC,eAAe;QACf,MAAM,MAAM,GAAG,IAAI,6BAAmB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACrE,MAAM,WAAW,CACf,MAAM,CAAC,YAAY,CAAC,mBAAmB,EAAE,EAAE,EAAE,iBAAI,CAAC,KAAK,EAAE,CAAC,CAC3D,CAAC,YAAY,EAAE,CAAC;IACnB,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,OAAO,EAAE,GAAS,EAAE;QACrB,MAAM,MAAM,GAAG,IAAI,6BAAmB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;QACrE,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,iBAAI,CAAC,KAAK,EAAE,CAAC,CAAC;QAE3F,gBAAgB;QAChB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/src/ng-architect/index_spec.ts

@@ -0,0 +1,24 @@
+import { Tree } from '@angular-devkit/schematics';
+import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+
+// SchematicTestRunner needs an absolute path to the collection to test.
+const collectionPath = path.join(__dirname, '../collection.json');
+
+describe('my-full-schematic', () => {
+  it('requires required option', async () => {
+    // We test that
+    const runner = new SchematicTestRunner('schematics', collectionPath);
+    await expectAsync(
+      runner.runSchematic('my-full-schematic', {}, Tree.empty())
+    ).toBeRejected();
+  });
+
+  it('works', async () => {
+    const runner = new SchematicTestRunner('schematics', collectionPath);
+    const tree = await runner.runSchematic('my-full-schematic', { name: 'str' }, Tree.empty());
+
+    // Listing files
+    expect(tree.files.sort()).toEqual(['/allo', '/hola', '/test1', '/test2']);
+  });
+});