@ngflow/ng-architect 1.0.0

package/README.md

@@ -0,0 +1,28 @@
+# Getting Started With Schematics
+
+This repository is a basic Schematic implementation that serves as a starting point to create and publish Schematics to NPM.
+
+### Testing
+
+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.
+
+Check the documentation with
+
+```bash
+schematics --help
+```
+
+### Unit Testing
+
+`npm run test` will run the unit tests, using Jasmine as a runner and test framework.
+
+### Publishing
+
+To publish, simply do:
+
+```bash
+npm run build
+npm publish
+```
+
+That's it!

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@ngflow/ng-architect",
+  "version": "1.0.0",
+  "description": "Angular schematics to generate files and maintain clean architecture",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "npm run build && jasmine src/**/*_spec.js"
+  },
+  "keywords": ["schematics", "angular", "automation", "architecture"],
+  "author": "João Fernandes",
+  "license": "MIT",
+  "schematics": "./src/collection.json",
+  "dependencies": {
+    "@angular-devkit/core": "^21.0.4",
+    "@angular-devkit/schematics": "^21.0.4"
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.19",
+    "@types/jasmine": "~5.1.0",
+    "jasmine": "~5.12.0",
+    "typescript": "~5.9.2"
+  }
+}

package/src/collection.json

@@ -0,0 +1,28 @@
+// By default, collection.json is a Loose-format JSON5 format, which means it's loaded using a
+// special loader and you can use comments, as well as single quotes or no-quotes for standard
+// JavaScript identifiers.
+// Note that this is only true for collection.json and it depends on the tooling itself.
+// We read package.json using a require() call, which is standard JSON.
+{
+  // This is just to indicate to your IDE that there is a schema for collection.json.
+  "$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",
+
+  // Schematics are listed as a map of schematicName => schematicDescription.
+  // Each description contains a description field which is required, a factory reference,
+  // an extends field and a schema reference.
+  // The extends field points to another schematic (either in the same collection or a
+  // separate collection using the format collectionName:schematicName).
+  // The factory is required, except when using the extends field. Then the factory can
+  // overwrite the extended schematic factory.
+  "schematics": {
+  "ng-architect": {
+    "description": "Gera uma feature Angular completa com rotas e arquivos",
+    "factory": "./ng-architect/index#default",
+    "schema": "./ng-architect/schema.json"
+  },
+    "my-extend-schematic": {
+      "description": "A schematic that extends another schematic.",
+      "extends": "my-full-schematic"
+    }
+  }
+}

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

@@ -0,0 +1 @@
+<p><%= featureKebab %> works!</p>

package/src/ng-architect/index.d.ts

@@ -0,0 +1,2 @@
+import { Rule } from '@angular-devkit/schematics';
+export default function (options: any): Rule;

package/src/ng-architect/index.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+const schematics_1 = require("@angular-devkit/schematics");
+// Helper functions
+const toKebabCase = (value) => value
+    .replace(/([a-z])([A-Z])/g, '$1-$2')
+    .replace(/_/g, '-')
+    .toLowerCase();
+const toPascalCase = (value) => value
+    .split(/[-_]/)
+    .map(part => part.charAt(0).toUpperCase() + part.slice(1))
+    .join('');
+function default_1(options) {
+    const featureKebab = toKebabCase(options.name);
+    const featurePascal = toPascalCase(options.name);
+    return (0, schematics_1.chain)([
+        (_tree, context) => {
+            context.logger.info(`✅ Criando feature: ${featurePascal} (${featureKebab})`);
+        },
+        // 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.template)({
+                featureKebab,
+                featurePascal,
+            }),
+        ])),
+        // Update app.routes.ts if it exists
+        (tree, context) => {
+            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;
+        },
+    ]);
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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"}

package/src/ng-architect/index_spec.d.ts

@@ -0,0 +1 @@
+export {};

package/src/ng-architect/index_spec.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schematics_1 = require("@angular-devkit/schematics");
+const testing_1 = require("@angular-devkit/schematics/testing");
+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 () => {
+        // 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 () => {
+        const runner = new testing_1.SchematicTestRunner('schematics', collectionPath);
+        const tree = await 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

@@ -0,0 +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"}

package/src/ng-architect/schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "MyFullSchematicsSchema",
+  "title": "Angular Feature Generator",
+  "description": "Generates a complete Angular feature with pages, services, store, models and routes",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the feature (e.g., user-profile, product-list)",
+      "minLength": 1
+    }
+  },
+  "required": ["name"]
+}

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "baseUrl": "tsconfig",
+    "lib": ["es2018", "dom"],
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "noUnusedParameters": true,
+    "noUnusedLocals": true,
+    "rootDir": "src/",
+    "skipDefaultLibCheck": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strictNullChecks": true,
+    "target": "es6",
+    "types": ["jasmine", "node"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["src/*/files/**/*"]
+}