@depup/angular-devkit__schematics-cli 21.2.2-depup.0

package/schematic/files/src/my-full-schematic/schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "MyFullSchematicsSchema",
+  "title": "My Full Schematics Schema",
+  "type": "object",
+  "properties": {
+    "index": {
+      "type": "number",
+      "default": 1
+    },
+    "name": {
+      "type": "string"
+    }
+  },
+  "required": ["name"]
+}

package/schematic/files/src/my-other-schematic/index.ts

@@ -0,0 +1,27 @@
+import { Rule, SchematicContext, Tree, chain, schematic } from '@angular-devkit/schematics';
+
+// A factory is a RuleFactory. It takes the options that might have been coming from the command
+// line or another schematic. These can be defined in a schema.json, which will validate
+export default function (options: any): Rule {
+  // The chain rule allows us to chain multiple rules and apply them one after the other.
+  return chain([
+    (tree: Tree, context: SchematicContext) => {
+      // Show the options for this Schematics.
+      context.logger.info('My Other Schematic: ' + JSON.stringify(options));
+
+      // Create a single file. Since this tree is not branched, we are working in the
+      // same staging area as the other schematic, and as such cannot create the same
+      // file twice.
+      tree.create('hola', 'mundo');
+    },
+    // The schematic Rule calls the schematic from the same collection, with the options
+    // passed in. Please note that if the schematic has a schema, the options will be
+    // validated and could throw, e.g. if a required option is missing.
+    schematic('my-schematic', { option: true }),
+    (tree: Tree) => {
+      // But since we're working off the same staging area, we can move the file created
+      // by the schematic above.
+      tree.rename('hello', 'allo');
+    },
+  ]);
+}

package/schematic/files/src/my-other-schematic/index_spec.ts

@@ -0,0 +1,14 @@
+import { Tree } from '@angular-devkit/schematics';
+import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+
+const collectionPath = path.join(__dirname, '../collection.json');
+
+describe('my-other-schematic', () => {
+  it('works', async () => {
+    const runner = new SchematicTestRunner('schematics', collectionPath);
+    const tree = await runner.runSchematic('my-other-schematic', {}, Tree.empty());
+
+    expect(tree.files.sort()).toEqual(['/allo', '/hola']);
+  });
+});

package/schematic/files/src/my-schematic/index.ts

@@ -0,0 +1,26 @@
+import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
+
+// You don't have to export the function as default. You can also have more than one rule factory
+// per file.
+export function mySchematic(options: any): Rule {
+  return (tree: Tree, context: SchematicContext) => {
+    // Show the options for this Schematics.
+    // The logging here is at the discretion of the tooling. It can be ignored or only showing
+    // info/warnings/errors. If you use console.log() there is not guarantee it will be
+    // propagated to a user in any way (for example, an IDE running this schematic might
+    // have a logging window but no support for console.log).
+    context.logger.info('My Schematic: ' + JSON.stringify(options));
+
+    // Create a single file. This is the simplest example of transforming the tree.
+    // If a file with that name already exists, the generation will NOT fail until the tool
+    // is trying to commit this to disk. This is because we allow you to work on what is
+    // called a "staging" area, and only finalize those changes when the schematics is
+    // done. This allows you to create files without having to verify if they exist
+    // already, then rename them later. Templating works in a similar fashion.
+    tree.create('hello', 'world');
+
+    // At the end, you can either return a Tree (that will be used), or an observable of a
+    // Tree (if you have some asynchronous tasks).
+    return tree;
+  };
+}

package/schematic/files/src/my-schematic/index_spec.ts

@@ -0,0 +1,14 @@
+import { Tree } from '@angular-devkit/schematics';
+import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
+import * as path from 'path';
+
+const collectionPath = path.join(__dirname, '../collection.json');
+
+describe('my-schematic', () => {
+  it('works', async () => {
+    const runner = new SchematicTestRunner('schematics', collectionPath);
+    const tree = await runner.runSchematic('my-schematic', {}, Tree.empty());
+
+    expect(tree.files).toEqual(['/hello']);
+  });
+});

package/schematic/files/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/**/*"]
+}

package/schematic/schema.d.ts

@@ -0,0 +1,24 @@
+export type Schema = {
+    /**
+     * Author for the new schematic.
+     */
+    author?: string;
+    /**
+     * The package name for the new schematic.
+     */
+    name: string;
+    /**
+     * The package manager used to install dependencies.
+     */
+    packageManager?: PackageManager;
+    [property: string]: any;
+};
+/**
+ * The package manager used to install dependencies.
+ */
+export declare enum PackageManager {
+    Bun = "bun",
+    Npm = "npm",
+    Pnpm = "pnpm",
+    Yarn = "yarn"
+}

package/schematic/schema.js

@@ -0,0 +1,16 @@
+"use strict";
+// THIS FILE IS AUTOMATICALLY GENERATED. TO UPDATE THIS FILE YOU NEED TO CHANGE THE
+// CORRESPONDING JSON SCHEMA FILE, THEN RUN devkit-admin build (or bazel build ...).
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageManager = void 0;
+/**
+ * The package manager used to install dependencies.
+ */
+var PackageManager;
+(function (PackageManager) {
+    PackageManager["Bun"] = "bun";
+    PackageManager["Npm"] = "npm";
+    PackageManager["Pnpm"] = "pnpm";
+    PackageManager["Yarn"] = "yarn";
+})(PackageManager || (exports.PackageManager = PackageManager = {}));
+//# sourceMappingURL=schema.js.map

package/schematic/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["schema.ts"],"names":[],"mappings":";AACA,mFAAmF;AACnF,oFAAoF;;;AAkBpF;;GAEG;AACH,IAAY,cAKX;AALD,WAAY,cAAc;IACtB,6BAAW,CAAA;IACX,6BAAW,CAAA;IACX,+BAAa,CAAA;IACb,+BAAa,CAAA;AACjB,CAAC,EALW,cAAc,8BAAd,cAAc,QAKzB"}

package/schematic/schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "SchematicsSchematicSchema",
+  "title": "Schematic Options Schema",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The package name for the new schematic."
+    },
+    "author": {
+      "type": "string",
+      "description": "Author for the new schematic."
+    },
+    "packageManager": {
+      "description": "The package manager used to install dependencies.",
+      "type": "string",
+      "enum": ["npm", "yarn", "pnpm", "bun"],
+      "default": "npm"
+    }
+  },
+  "required": ["name"]
+}