@schematics/angular 14.0.0-next.12 → 14.0.0-next.13

package/component/files/__name@dasherize@if-flat__/__name@dasherize__.__type@dasherize__.ts.template

@@ -1,8 +1,10 @@
-import { Component, OnInit<% if(!!viewEncapsulation) { %>, ViewEncapsulation<% }%><% if(changeDetection !== 'Default') { %>, ChangeDetectionStrategy<% }%> } from '@angular/core';
+import { Component, OnInit<% if(!!viewEncapsulation) { %>, ViewEncapsulation<% }%><% if(changeDetection !== 'Default') { %>, ChangeDetectionStrategy<% }%> } from '@angular/core';<% if(standalone) {%>
+import { CommonModule } from '@angular/common';<% } %>
 
 @Component({<% if(!skipSelector) {%>
   selector: '<%= selector %>',<%}%><% if(standalone) {%>
-  standalone: true,<%}%><% if(inlineTemplate) { %>
+  standalone: true,
+  imports: [CommonModule], <%}%><% if(inlineTemplate) { %>
   template: `
     <p>
       <%= dasherize(name) %> works!

package/e2e/index.js

@@ -9,11 +9,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
+const utility_1 = require("../utility");
 const dependencies_1 = require("../utility/dependencies");
 const json_file_1 = require("../utility/json-file");
 const latest_versions_1 = require("../utility/latest-versions");
 const paths_1 = require("../utility/paths");
-const workspace_1 = require("../utility/workspace");
 const workspace_models_1 = require("../utility/workspace-models");
 function addScriptsToPackageJson() {
     return (host) => {
@@ -27,7 +27,7 @@ function addScriptsToPackageJson() {
 function default_1(options) {
     return async (host) => {
         const appProject = options.relatedAppName;
-        const workspace = await (0, workspace_1.getWorkspace)(host);
+        const workspace = await (0, utility_1.readWorkspace)(host);
         const project = workspace.projects.get(appProject);
         if (!project) {
             throw new schematics_1.SchematicsException(`Project name "${appProject}" doesn't not exist.`);
@@ -49,8 +49,8 @@ function default_1(options) {
                 },
             },
         });
+        await (0, utility_1.writeWorkspace)(host, workspace);
         return (0, schematics_1.chain)([
-            (0, workspace_1.updateWorkspace)(workspace),
             (0, schematics_1.mergeWith)((0, schematics_1.apply)((0, schematics_1.url)('./files'), [
                 (0, schematics_1.applyTemplates)({
                     utils: schematics_1.strings,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schematics/angular",
-  "version": "14.0.0-next.12",
+  "version": "14.0.0-next.13",
   "description": "Schematics specific to Angular",
   "homepage": "https://github.com/angular/angular-cli",
   "keywords": [
@@ -13,10 +13,17 @@
     "code generation",
     "schematics"
   ],
+  "exports": {
+    "./package.json": "./package.json",
+    "./utility": "./utility/index.js",
+    "./utility/*": "./utility/*.js",
+    "./migrations/migration-collection.json": "./migrations/migration-collection.json",
+    "./*": "./*.js"
+  },
   "schematics": "./collection.json",
   "dependencies": {
-    "@angular-devkit/core": "14.0.0-next.12",
-    "@angular-devkit/schematics": "14.0.0-next.12",
+    "@angular-devkit/core": "14.0.0-next.13",
+    "@angular-devkit/schematics": "14.0.0-next.13",
     "jsonc-parser": "3.0.0"
   },
   "repository": {

package/service-worker/index.js

@@ -34,13 +34,13 @@ const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
 const tasks_1 = require("@angular-devkit/schematics/tasks");
 const ts = __importStar(require("../third_party/github.com/Microsoft/TypeScript/lib/typescript"));
+const utility_1 = require("../utility");
 const ast_utils_1 = require("../utility/ast-utils");
 const change_1 = require("../utility/change");
 const dependencies_1 = require("../utility/dependencies");
 const ng_ast_utils_1 = require("../utility/ng-ast-utils");
 const paths_1 = require("../utility/paths");
 const project_targets_1 = require("../utility/project-targets");
-const workspace_1 = require("../utility/workspace");
 function addDependencies() {
     return (host, context) => {
         const packageName = '@angular/service-worker';
@@ -119,7 +119,7 @@ function getTsSourceFile(host, path) {
 }
 function default_1(options) {
     return async (host, context) => {
-        const workspace = await (0, workspace_1.getWorkspace)(host);
+        const workspace = await (0, utility_1.readWorkspace)(host);
         const project = workspace.projects.get(options.project);
         if (!project) {
             throw new schematics_1.SchematicsException(`Invalid project name (${options.project})`);
@@ -148,9 +148,9 @@ function default_1(options) {
             (0, schematics_1.move)(project.root),
         ]);
         context.addTask(new tasks_1.NodePackageInstallTask());
+        await (0, utility_1.writeWorkspace)(host, workspace);
         return (0, schematics_1.chain)([
             (0, schematics_1.mergeWith)(templateSource),
-            (0, workspace_1.updateWorkspace)(workspace),
             addDependencies(),
             updateAppModule(buildOptions.main),
         ]);

package/utility/dependency.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import { Rule } from '@angular-devkit/schematics';
+/**
+ * An enum used to specify the type of a dependency found within a package manifest
+ * file (`package.json`).
+ */
+export declare enum DependencyType {
+    Default = "dependencies",
+    Dev = "devDependencies",
+    Peer = "peerDependencies"
+}
+/**
+ * Adds a package as a dependency to a `package.json`. By default the `package.json` located
+ * at the schematic's root will be used. The `manifestPath` option can be used to explicitly specify
+ * a `package.json` in different location. The type of the dependency can also be specified instead
+ * of the default of the `dependencies` section by using the `type` option for either `devDependencies`
+ * or `peerDependencies`.
+ *
+ * When using this rule, {@link NodePackageInstallTask} does not need to be included directly by
+ * a schematic. A package manager install task will be automatically scheduled as needed.
+ *
+ * @param name The name of the package to add.
+ * @param specifier The package specifier for the package to add. Typically a SemVer range.
+ * @param options An optional object that can contain the `type` of the dependency
+ * and/or a path (`packageJsonPath`) of a manifest file (`package.json`) to modify.
+ * @returns A Schematics {@link Rule}
+ */
+export declare function addDependency(name: string, specifier: string, options?: {
+    /**
+     * The type of the dependency determines the section of the `package.json` to which the
+     * dependency will be added. Defaults to {@link DependencyType.Default} (`dependencies`).
+     */
+    type?: DependencyType;
+    /**
+     * The path of the package manifest file (`package.json`) that will be modified.
+     * Defaults to `/package.json`.
+     */
+    packageJsonPath?: string;
+}): Rule;

package/utility/dependency.js

@@ -0,0 +1,97 @@
+"use strict";
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addDependency = exports.DependencyType = void 0;
+const tasks_1 = require("@angular-devkit/schematics/tasks");
+const path = __importStar(require("path"));
+const installTasks = new WeakMap();
+/**
+ * An enum used to specify the type of a dependency found within a package manifest
+ * file (`package.json`).
+ */
+var DependencyType;
+(function (DependencyType) {
+    DependencyType["Default"] = "dependencies";
+    DependencyType["Dev"] = "devDependencies";
+    DependencyType["Peer"] = "peerDependencies";
+})(DependencyType = exports.DependencyType || (exports.DependencyType = {}));
+/**
+ * Adds a package as a dependency to a `package.json`. By default the `package.json` located
+ * at the schematic's root will be used. The `manifestPath` option can be used to explicitly specify
+ * a `package.json` in different location. The type of the dependency can also be specified instead
+ * of the default of the `dependencies` section by using the `type` option for either `devDependencies`
+ * or `peerDependencies`.
+ *
+ * When using this rule, {@link NodePackageInstallTask} does not need to be included directly by
+ * a schematic. A package manager install task will be automatically scheduled as needed.
+ *
+ * @param name The name of the package to add.
+ * @param specifier The package specifier for the package to add. Typically a SemVer range.
+ * @param options An optional object that can contain the `type` of the dependency
+ * and/or a path (`packageJsonPath`) of a manifest file (`package.json`) to modify.
+ * @returns A Schematics {@link Rule}
+ */
+function addDependency(name, specifier, options = {}) {
+    const { type = DependencyType.Default, packageJsonPath = '/package.json' } = options;
+    return (tree, context) => {
+        var _a;
+        const manifest = tree.readJson(packageJsonPath);
+        const dependencySection = manifest[type];
+        if (!dependencySection) {
+            // Section is not present. The dependency can be added to a new object literal for the section.
+            manifest[type] = { [name]: specifier };
+        }
+        else if (dependencySection[name] === specifier) {
+            // Already present with same specifier
+            return;
+        }
+        else if (dependencySection[name]) {
+            // Already present but different specifier
+            throw new Error(`Package dependency "${name}" already exists with a different specifier.`);
+        }
+        else {
+            // Add new dependency in alphabetical order
+            const entries = Object.entries(dependencySection);
+            entries.push([name, specifier]);
+            entries.sort((a, b) => a[0].localeCompare(b[0]));
+            manifest[type] = Object.fromEntries(entries);
+        }
+        tree.overwrite(packageJsonPath, JSON.stringify(manifest, null, 2));
+        const installPaths = (_a = installTasks.get(context)) !== null && _a !== void 0 ? _a : new Set();
+        if (!installPaths.has(packageJsonPath)) {
+            context.addTask(new tasks_1.NodePackageInstallTask({ workingDirectory: path.dirname(packageJsonPath) }));
+            installPaths.add(packageJsonPath);
+            installTasks.set(context, installPaths);
+        }
+    };
+}
+exports.addDependency = addDependency;

package/utility/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+export { ProjectDefinition, TargetDefinition, WorkspaceDefinition, getWorkspace as readWorkspace, updateWorkspace, writeWorkspace, } from './workspace';
+export { Builders as AngularBuilder } from './workspace-models';
+export { DependencyType, addDependency } from './dependency';

package/utility/index.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * @license
+ * Copyright Google LLC All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addDependency = exports.DependencyType = exports.AngularBuilder = exports.writeWorkspace = exports.updateWorkspace = exports.readWorkspace = void 0;
+// Workspace related rules and types
+var workspace_1 = require("./workspace");
+Object.defineProperty(exports, "readWorkspace", { enumerable: true, get: function () { return workspace_1.getWorkspace; } });
+Object.defineProperty(exports, "updateWorkspace", { enumerable: true, get: function () { return workspace_1.updateWorkspace; } });
+Object.defineProperty(exports, "writeWorkspace", { enumerable: true, get: function () { return workspace_1.writeWorkspace; } });
+var workspace_models_1 = require("./workspace-models");
+Object.defineProperty(exports, "AngularBuilder", { enumerable: true, get: function () { return workspace_models_1.Builders; } });
+// Package dependency related rules and types
+var dependency_1 = require("./dependency");
+Object.defineProperty(exports, "DependencyType", { enumerable: true, get: function () { return dependency_1.DependencyType; } });
+Object.defineProperty(exports, "addDependency", { enumerable: true, get: function () { return dependency_1.addDependency; } });

package/utility/workspace-models.d.ts

@@ -9,6 +9,12 @@ export declare enum ProjectType {
     Application = "application",
     Library = "library"
 }
+/**
+ * An enum of the official Angular builders.
+ * Each enum value provides the fully qualified name of the associated builder.
+ * This enum can be used when analyzing the `builder` fields of project configurations from the
+ * `angular.json` workspace file.
+ */
 export declare enum Builders {
     AppShell = "@angular-devkit/build-angular:app-shell",
     Server = "@angular-devkit/build-angular:server",

package/utility/workspace-models.js

@@ -13,6 +13,12 @@ var ProjectType;
     ProjectType["Application"] = "application";
     ProjectType["Library"] = "library";
 })(ProjectType = exports.ProjectType || (exports.ProjectType = {}));
+/**
+ * An enum of the official Angular builders.
+ * Each enum value provides the fully qualified name of the associated builder.
+ * This enum can be used when analyzing the `builder` fields of project configurations from the
+ * `angular.json` workspace file.
+ */
 var Builders;
 (function (Builders) {
     Builders["AppShell"] = "@angular-devkit/build-angular:app-shell";

package/utility/workspace.d.ts

@@ -7,9 +7,42 @@
  */
 import { json, workspaces } from '@angular-devkit/core';
 import { Rule, Tree } from '@angular-devkit/schematics';
-export declare function updateWorkspace(updater: (workspace: workspaces.WorkspaceDefinition) => void | Rule | PromiseLike<void | Rule>): Rule;
-export declare function updateWorkspace(workspace: workspaces.WorkspaceDefinition): Rule;
-export declare function getWorkspace(tree: Tree, path?: string): Promise<workspaces.WorkspaceDefinition>;
+export declare type WorkspaceDefinition = workspaces.WorkspaceDefinition;
+export declare type ProjectDefinition = workspaces.ProjectDefinition;
+export declare type TargetDefinition = workspaces.TargetDefinition;
+/**
+ * Updates the workspace file (`angular.json`) found within the root of the schematic's tree.
+ * The workspace object model can be directly modified within the provided updater function
+ * with changes being written to the workspace file after the updater function returns.
+ * The spacing and overall layout of the file (including comments) will be maintained where
+ * possible when updating the file.
+ *
+ * @param updater An update function that can be used to modify the object model for the
+ * workspace. A {@link WorkspaceDefinition} is provided as the first argument to the function.
+ */
+export declare function updateWorkspace(updater: (workspace: WorkspaceDefinition) => void | Rule | PromiseLike<void | Rule>): Rule;
+/**
+ * Reads a workspace file (`angular.json`) from the provided {@link Tree} instance.
+ *
+ * @param tree A schematics {@link Tree} instance used to access the workspace file.
+ * @param path The path where a workspace file should be found. If a file is specified, the file
+ * path will be used. If a directory is specified, the file `angular.json` will be used from
+ * within the specified directory. Defaults to `/angular.json`.
+ * @returns A {@link WorkspaceDefinition} representing the workspace found at the specified path.
+ */
+export declare function getWorkspace(tree: Tree, path?: string): Promise<WorkspaceDefinition>;
+/**
+ * Writes a workspace file (`angular.json`) to the provided {@link Tree} instance.
+ * The spacing and overall layout of an exisitng file (including comments) will be maintained where
+ * possible when writing the file.
+ *
+ * @param tree A schematics {@link Tree} instance used to access the workspace file.
+ * @param workspace The {@link WorkspaceDefinition} to write.
+ * @param path The path where a workspace file should be written. If a file is specified, the file
+ * path will be used. If not provided, the definition's underlying file path stored during reading
+ * will be used.
+ */
+export declare function writeWorkspace(tree: Tree, workspace: WorkspaceDefinition, path?: string): Promise<void>;
 /**
  * Build a default project path for generating.
  * @param project The project which will have its default path generated.

package/utility/workspace.js

@@ -7,49 +7,89 @@
  * found in the LICENSE file at https://angular.io/license
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.allTargetOptions = exports.allWorkspaceTargets = exports.createDefaultPath = exports.buildDefaultPath = exports.getWorkspace = exports.updateWorkspace = void 0;
+exports.allTargetOptions = exports.allWorkspaceTargets = exports.createDefaultPath = exports.buildDefaultPath = exports.writeWorkspace = exports.getWorkspace = exports.updateWorkspace = void 0;
 const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
 const workspace_models_1 = require("./workspace-models");
-function createHost(tree) {
-    return {
-        async readFile(path) {
-            return tree.readText(path);
-        },
-        async writeFile(path, data) {
-            return tree.overwrite(path, data);
-        },
-        async isDirectory(path) {
-            // approximate a directory check
-            return !tree.exists(path) && tree.getDir(path).subfiles.length > 0;
-        },
-        async isFile(path) {
-            return tree.exists(path);
-        },
-    };
-}
-function updateWorkspace(updaterOrWorkspace) {
-    return async (tree) => {
-        const host = createHost(tree);
-        if (typeof updaterOrWorkspace === 'function') {
-            const { workspace } = await core_1.workspaces.readWorkspace('/', host);
-            const result = await updaterOrWorkspace(workspace);
-            await core_1.workspaces.writeWorkspace(workspace, host);
-            return result || schematics_1.noop;
+const DEFAULT_WORKSPACE_PATH = '/angular.json';
+/**
+ * A {@link workspaces.WorkspaceHost} backed by a Schematics {@link Tree} instance.
+ */
+class TreeWorkspaceHost {
+    constructor(tree) {
+        this.tree = tree;
+    }
+    async readFile(path) {
+        return this.tree.readText(path);
+    }
+    async writeFile(path, data) {
+        if (this.tree.exists(path)) {
+            this.tree.overwrite(path, data);
         }
         else {
-            await core_1.workspaces.writeWorkspace(updaterOrWorkspace, host);
-            return schematics_1.noop;
+            this.tree.create(path, data);
         }
+    }
+    async isDirectory(path) {
+        // approximate a directory check
+        return !this.tree.exists(path) && this.tree.getDir(path).subfiles.length > 0;
+    }
+    async isFile(path) {
+        return this.tree.exists(path);
+    }
+}
+/**
+ * Updates the workspace file (`angular.json`) found within the root of the schematic's tree.
+ * The workspace object model can be directly modified within the provided updater function
+ * with changes being written to the workspace file after the updater function returns.
+ * The spacing and overall layout of the file (including comments) will be maintained where
+ * possible when updating the file.
+ *
+ * @param updater An update function that can be used to modify the object model for the
+ * workspace. A {@link WorkspaceDefinition} is provided as the first argument to the function.
+ */
+function updateWorkspace(updater) {
+    return async (tree) => {
+        const host = new TreeWorkspaceHost(tree);
+        const { workspace } = await core_1.workspaces.readWorkspace(DEFAULT_WORKSPACE_PATH, host);
+        const result = await updater(workspace);
+        await core_1.workspaces.writeWorkspace(workspace, host);
+        return result || schematics_1.noop;
     };
 }
 exports.updateWorkspace = updateWorkspace;
-async function getWorkspace(tree, path = '/') {
-    const host = createHost(tree);
+// TODO: This should be renamed `readWorkspace` once deep imports are restricted (already exported from `utility` with that name)
+/**
+ * Reads a workspace file (`angular.json`) from the provided {@link Tree} instance.
+ *
+ * @param tree A schematics {@link Tree} instance used to access the workspace file.
+ * @param path The path where a workspace file should be found. If a file is specified, the file
+ * path will be used. If a directory is specified, the file `angular.json` will be used from
+ * within the specified directory. Defaults to `/angular.json`.
+ * @returns A {@link WorkspaceDefinition} representing the workspace found at the specified path.
+ */
+async function getWorkspace(tree, path = DEFAULT_WORKSPACE_PATH) {
+    const host = new TreeWorkspaceHost(tree);
     const { workspace } = await core_1.workspaces.readWorkspace(path, host);
     return workspace;
 }
 exports.getWorkspace = getWorkspace;
+/**
+ * Writes a workspace file (`angular.json`) to the provided {@link Tree} instance.
+ * The spacing and overall layout of an exisitng file (including comments) will be maintained where
+ * possible when writing the file.
+ *
+ * @param tree A schematics {@link Tree} instance used to access the workspace file.
+ * @param workspace The {@link WorkspaceDefinition} to write.
+ * @param path The path where a workspace file should be written. If a file is specified, the file
+ * path will be used. If not provided, the definition's underlying file path stored during reading
+ * will be used.
+ */
+async function writeWorkspace(tree, workspace, path) {
+    const host = new TreeWorkspaceHost(tree);
+    return core_1.workspaces.writeWorkspace(workspace, host, path);
+}
+exports.writeWorkspace = writeWorkspace;
 /**
  * Build a default project path for generating.
  * @param project The project which will have its default path generated.