@schematics/angular 14.0.0-next.7 → 14.0.0-rc.0

package/universal/index.js

@@ -96,11 +96,7 @@ function updateConfigFile(options, tsConfigDirectory) {
     });
 }
 function findBrowserModuleImport(host, modulePath) {
-    const moduleBuffer = host.read(modulePath);
-    if (!moduleBuffer) {
-        throw new schematics_1.SchematicsException(`Module file (${modulePath}) not found`);
-    }
-    const moduleFileText = moduleBuffer.toString('utf-8');
+    const moduleFileText = host.readText(modulePath);
     const source = ts.createSourceFile(modulePath, moduleFileText, ts.ScriptTarget.Latest, true);
     const decoratorMetadata = (0, ast_utils_1.getDecoratorMetadata)(source, 'NgModule', '@angular/core')[0];
     const browserModuleNode = (0, ast_utils_1.findNode)(decoratorMetadata, ts.SyntaxKind.Identifier, 'BrowserModule');
@@ -230,7 +226,7 @@ function default_1(options) {
         }
         const templateSource = (0, schematics_1.apply)((0, schematics_1.url)('./files/src'), [
             (0, schematics_1.applyTemplates)({
-                ...core_1.strings,
+                ...schematics_1.strings,
                 ...options,
                 stripTsExtension: (s) => s.replace(/\.ts$/, ''),
                 hasLocalizePackage: !!(0, dependencies_1.getPackageJsonDependency)(host, '@angular/localize'),
@@ -239,7 +235,7 @@ function default_1(options) {
         ]);
         const rootSource = (0, schematics_1.apply)((0, schematics_1.url)('./files/root'), [
             (0, schematics_1.applyTemplates)({
-                ...core_1.strings,
+                ...schematics_1.strings,
                 ...options,
                 stripTsExtension: (s) => s.replace(/\.ts$/, ''),
                 tsConfigExtends,

package/utility/ast-utils.js

@@ -144,7 +144,6 @@ function getSourceNodes(sourceFile) {
 exports.getSourceNodes = getSourceNodes;
 function findNode(node, kind, text) {
     if (node.kind === kind && node.getText() === text) {
-        // throw new Error(node.getText());
         return node;
     }
     let foundNode = null;
@@ -284,27 +283,26 @@ function getMetadataField(node, metadataField) {
 exports.getMetadataField = getMetadataField;
 function addSymbolToNgModuleMetadata(source, ngModulePath, metadataField, symbolName, importPath = null) {
     const nodes = getDecoratorMetadata(source, 'NgModule', '@angular/core');
-    let node = nodes[0]; // eslint-disable-line @typescript-eslint/no-explicit-any
+    const node = nodes[0];
     // Find the decorator declaration.
-    if (!node) {
+    if (!node || !ts.isObjectLiteralExpression(node)) {
         return [];
     }
     // Get all the children property assignment of object literals.
     const matchingProperties = getMetadataField(node, metadataField);
     if (matchingProperties.length == 0) {
         // We haven't found the field in the metadata declaration. Insert a new field.
-        const expr = node;
         let position;
         let toInsert;
-        if (expr.properties.length == 0) {
-            position = expr.getEnd() - 1;
+        if (node.properties.length == 0) {
+            position = node.getEnd() - 1;
             toInsert = `\n  ${metadataField}: [\n${core_1.tags.indentBy(4) `${symbolName}`}\n  ]\n`;
         }
         else {
-            node = expr.properties[expr.properties.length - 1];
-            position = node.getEnd();
+            const childNode = node.properties[node.properties.length - 1];
+            position = childNode.getEnd();
             // Get the indentation of the last element, if any.
-            const text = node.getFullText(source);
+            const text = childNode.getFullText(source);
             const matches = text.match(/^(\r?\n)(\s*)/);
             if (matches) {
                 toInsert =
@@ -327,35 +325,33 @@ function addSymbolToNgModuleMetadata(source, ngModulePath, metadataField, symbol
     }
     const assignment = matchingProperties[0];
     // If it's not an array, nothing we can do really.
-    if (assignment.initializer.kind !== ts.SyntaxKind.ArrayLiteralExpression) {
+    if (!ts.isPropertyAssignment(assignment) ||
+        !ts.isArrayLiteralExpression(assignment.initializer)) {
         return [];
     }
-    const arrLiteral = assignment.initializer;
-    if (arrLiteral.elements.length == 0) {
-        // Forward the property.
-        node = arrLiteral;
-    }
-    else {
-        node = arrLiteral.elements;
-    }
-    if (Array.isArray(node)) {
-        const nodeArray = node;
-        const symbolsArray = nodeArray.map((node) => core_1.tags.oneLine `${node.getText()}`);
+    let expresssion;
+    const assignmentInit = assignment.initializer;
+    const elements = assignmentInit.elements;
+    if (elements.length) {
+        const symbolsArray = elements.map((node) => core_1.tags.oneLine `${node.getText()}`);
         if (symbolsArray.includes(core_1.tags.oneLine `${symbolName}`)) {
             return [];
         }
-        node = node[node.length - 1];
+        expresssion = elements[elements.length - 1];
+    }
+    else {
+        expresssion = assignmentInit;
     }
     let toInsert;
-    let position = node.getEnd();
-    if (node.kind == ts.SyntaxKind.ArrayLiteralExpression) {
+    let position = expresssion.getEnd();
+    if (ts.isArrayLiteralExpression(expresssion)) {
         // We found the field but it's empty. Insert it just before the `]`.
         position--;
         toInsert = `\n${core_1.tags.indentBy(4) `${symbolName}`}\n  `;
     }
     else {
         // Get the indentation of the last element, if any.
-        const text = node.getFullText(source);
+        const text = expresssion.getFullText(source);
         const matches = text.match(/^(\r?\n)(\s*)/);
         if (matches) {
             toInsert = `,${matches[1]}${core_1.tags.indentBy(matches[2].length) `${symbolName}`}`;
@@ -470,6 +466,9 @@ exports.getEnvironmentExportName = getEnvironmentExportName;
 function getRouterModuleDeclaration(source) {
     const result = getDecoratorMetadata(source, 'NgModule', '@angular/core');
     const node = result[0];
+    if (!node || !ts.isObjectLiteralExpression(node)) {
+        return undefined;
+    }
     const matchingProperties = getMetadataField(node, 'imports');
     if (!matchingProperties) {
         return;
@@ -490,7 +489,8 @@ exports.getRouterModuleDeclaration = getRouterModuleDeclaration;
 function addRouteDeclarationToModule(source, fileToAdd, routeLiteral) {
     const routerModuleExpr = getRouterModuleDeclaration(source);
     if (!routerModuleExpr) {
-        throw new Error(`Couldn't find a route declaration in ${fileToAdd}.`);
+        throw new Error(`Couldn't find a route declaration in ${fileToAdd}.\n` +
+            `Use the '--module' option to specify a different routing module.`);
     }
     const scopeConfigMethodArgs = routerModuleExpr.arguments;
     if (!scopeConfigMethodArgs.length) {

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/find-module.d.ts

@@ -15,6 +15,7 @@ export interface ModuleOptions {
     skipImport?: boolean;
     moduleExt?: string;
     routingModuleExt?: string;
+    standalone?: boolean;
 }
 export declare const MODULE_EXT = ".module.ts";
 export declare const ROUTING_MODULE_EXT = "-routing.module.ts";

package/utility/find-module.js

@@ -15,8 +15,7 @@ exports.ROUTING_MODULE_EXT = '-routing.module.ts';
  * Find the module referred by a set of options passed to the schematics.
  */
 function findModuleFromOptions(host, options) {
-    // eslint-disable-next-line no-prototype-builtins
-    if (options.hasOwnProperty('skipImport') && options.skipImport) {
+    if (options.standalone || options.skipImport) {
         return undefined;
     }
     const moduleExt = options.moduleExt || exports.MODULE_EXT;
@@ -38,11 +37,7 @@ function findModuleFromOptions(host, options) {
         }
         const candidatesDirs = [...candidateSet].sort((a, b) => b.length - a.length);
         for (const c of candidatesDirs) {
-            const candidateFiles = [
-                '',
-                `${moduleBaseName}.ts`,
-                `${moduleBaseName}${moduleExt}`,
-            ].map((x) => (0, core_1.join)(c, x));
+            const candidateFiles = ['', `${moduleBaseName}.ts`, `${moduleBaseName}${moduleExt}`].map((x) => (0, core_1.join)(c, x));
             for (const sc of candidateFiles) {
                 if (host.exists(sc)) {
                     return (0, core_1.normalize)(sc);
@@ -68,7 +63,7 @@ function findModule(host, generateDir, moduleExt = exports.MODULE_EXT, routingMo
             return (0, core_1.join)(dir.path, filteredMatches[0]);
         }
         else if (filteredMatches.length > 1) {
-            throw new Error('More than one module matches. Use the skip-import option to skip importing ' +
+            throw new Error(`More than one module matches. Use the '--skip-import' option to skip importing ` +
                 'the component into the closest module or use the module option to specify a module.');
         }
         dir = dir.parent;
@@ -76,8 +71,8 @@ function findModule(host, generateDir, moduleExt = exports.MODULE_EXT, routingMo
     const errorMsg = foundRoutingModule
         ? 'Could not find a non Routing NgModule.' +
             `\nModules with suffix '${routingModuleExt}' are strictly reserved for routing.` +
-            '\nUse the skip-import option to skip importing in NgModule.'
-        : 'Could not find an NgModule. Use the skip-import option to skip importing in NgModule.';
+            `\nUse the '--skip-import' option to skip importing in NgModule.`
+        : `Could not find an NgModule. Use the '--skip-import' option to skip importing in NgModule.`;
     throw new Error(errorMsg);
 }
 exports.findModule = findModule;

package/utility/generate-from-files.js

@@ -8,7 +8,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateFromFiles = void 0;
-const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
 const parse_name_1 = require("./parse-name");
 const workspace_1 = require("./workspace");
@@ -24,11 +23,11 @@ function generateFromFiles(options, extraTemplateValues = {}) {
         const templateSource = (0, schematics_1.apply)((0, schematics_1.url)('./files'), [
             options.skipTests ? (0, schematics_1.filter)((path) => !path.endsWith('.spec.ts.template')) : (0, schematics_1.noop)(),
             (0, schematics_1.applyTemplates)({
-                ...core_1.strings,
+                ...schematics_1.strings,
                 ...options,
                 ...extraTemplateValues,
             }),
-            (0, schematics_1.move)(parsedPath.path + (options.flat ? '' : '/' + core_1.strings.dasherize(options.name))),
+            (0, schematics_1.move)(parsedPath.path + (options.flat ? '' : '/' + schematics_1.strings.dasherize(options.name))),
         ]);
         return (0, schematics_1.chain)([(0, schematics_1.mergeWith)(templateSource)]);
     };

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/json-file.js

@@ -14,13 +14,7 @@ class JSONFile {
     constructor(host, path) {
         this.host = host;
         this.path = path;
-        const buffer = this.host.read(this.path);
-        if (buffer) {
-            this.content = buffer.toString();
-        }
-        else {
-            throw new Error(`Could not read '${path}'.`);
-        }
+        this.content = this.host.readText(this.path);
     }
     get JsonAst() {
         if (this._jsonAst) {

package/utility/latest-versions/package.json

@@ -5,15 +5,16 @@
   "dependencies": {
     "@types/jasmine": "~4.0.0",
     "@types/node": "^14.15.0",
-    "jasmine-core": "~4.0.0",
+    "jasmine-core": "~4.1.0",
     "karma-chrome-launcher": "~3.1.0",
     "karma-coverage": "~2.2.0",
     "karma-jasmine-html-reporter": "~1.7.0",
-    "karma-jasmine": "~4.0.0",
+    "karma-jasmine": "~5.0.0",
     "karma": "~6.3.0",
-    "ng-packagr": "^14.0.0-next.2",
+    "ng-packagr": "^14.0.0-next.8",
     "rxjs": "~7.5.0",
     "tslib": "^2.3.0",
+    "ts-node": "~10.7.0",
     "typescript": "~4.6.2",
     "zone.js": "~0.11.4"
   }

package/utility/latest-versions.js

@@ -13,7 +13,7 @@ exports.latestVersions = {
     // but ts_library doesn't support JSON inputs.
     ...require('./latest-versions/package.json')['dependencies'],
     // As Angular CLI works with same minor versions of Angular Framework, a tilde match for the current
-    Angular: '^14.0.0-next.0',
+    Angular: '^14.0.0-rc.0',
     // Since @angular-devkit/build-angular and @schematics/angular are always
     // published together from the same monorepo, and they are both
     // non-experimental, they will always have the same version.

package/utility/ng-ast-utils.js

@@ -37,11 +37,7 @@ const path_1 = require("path");
 const ts = __importStar(require("../third_party/github.com/Microsoft/TypeScript/lib/typescript"));
 const ast_utils_1 = require("../utility/ast-utils");
 function findBootstrapModuleCall(host, mainPath) {
-    const mainBuffer = host.read(mainPath);
-    if (!mainBuffer) {
-        throw new schematics_1.SchematicsException(`Main file (${mainPath}) not found`);
-    }
-    const mainText = mainBuffer.toString('utf-8');
+    const mainText = host.readText(mainPath);
     const source = ts.createSourceFile(mainPath, mainText, ts.ScriptTarget.Latest, true);
     const allNodes = (0, ast_utils_1.getSourceNodes)(source);
     let bootstrapCall = null;
@@ -70,11 +66,7 @@ function findBootstrapModulePath(host, mainPath) {
         throw new schematics_1.SchematicsException('Bootstrap call not found');
     }
     const bootstrapModule = bootstrapCall.arguments[0];
-    const mainBuffer = host.read(mainPath);
-    if (!mainBuffer) {
-        throw new schematics_1.SchematicsException(`Client application main file (${mainPath}) not found`);
-    }
-    const mainText = mainBuffer.toString('utf-8');
+    const mainText = host.readText(mainPath);
     const source = ts.createSourceFile(mainPath, mainText, ts.ScriptTarget.Latest, true);
     const allNodes = (0, ast_utils_1.getSourceNodes)(source);
     const bootstrapModuleRelativePath = allNodes

package/utility/parse-name.js

@@ -8,7 +8,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseName = void 0;
-// import { relative, Path } from "../../../angular_devkit/core/src/virtual-fs";
 const core_1 = require("@angular-devkit/core");
 function parseName(path, name) {
     const nameWithoutPath = (0, core_1.basename)((0, core_1.normalize)(name));

package/utility/validation.js

@@ -8,15 +8,13 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateHtmlSelector = exports.htmlSelectorRe = void 0;
-const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
 // Must start with a letter, and must contain only alphanumeric characters or dashes.
 // When adding a dash the segment after the dash must also start with a letter.
 exports.htmlSelectorRe = /^[a-zA-Z][.0-9a-zA-Z]*(:?-[a-zA-Z][.0-9a-zA-Z]*)*$/;
 function validateHtmlSelector(selector) {
     if (selector && !exports.htmlSelectorRe.test(selector)) {
-        throw new schematics_1.SchematicsException(core_1.tags.oneLine `Selector (${selector})
-        is invalid.`);
+        throw new schematics_1.SchematicsException(`Selector (${selector}) is invalid.`);
     }
 }
 exports.validateHtmlSelector = validateHtmlSelector;

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.