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

package/utility/workspace.js

@@ -7,53 +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) {
-            const data = tree.read(path);
-            if (!data) {
-                throw new Error('File not found.');
-            }
-            return core_1.virtualFs.fileBufferToString(data);
-        },
-        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.

package/web-worker/index.js

@@ -46,7 +46,7 @@ function addSnippet(options) {
       }
     `;
         // Append the worker creation snippet.
-        const originalContent = host.read(siblingModulePath);
+        const originalContent = host.readText(siblingModulePath);
         host.overwrite(siblingModulePath, originalContent + '\n' + workerCreationSnippet);
         return host;
     };
@@ -72,7 +72,7 @@ function default_1(options) {
         options.name = parsedPath.name;
         options.path = parsedPath.path;
         const templateSourceWorkerCode = (0, schematics_1.apply)((0, schematics_1.url)('./files/worker'), [
-            (0, schematics_1.applyTemplates)({ ...options, ...core_1.strings }),
+            (0, schematics_1.applyTemplates)({ ...options, ...schematics_1.strings }),
             (0, schematics_1.move)(parsedPath.path),
         ]);
         const root = project.root || '';

package/workspace/index.js

@@ -7,14 +7,13 @@
  * found in the LICENSE file at https://angular.io/license
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@angular-devkit/core");
 const schematics_1 = require("@angular-devkit/schematics");
 const latest_versions_1 = require("../utility/latest-versions");
 function default_1(options) {
     return (0, schematics_1.mergeWith)((0, schematics_1.apply)((0, schematics_1.url)('./files'), [
         options.minimal ? (0, schematics_1.filter)((path) => !path.endsWith('editorconfig.template')) : (0, schematics_1.noop)(),
         (0, schematics_1.applyTemplates)({
-            utils: core_1.strings,
+            utils: schematics_1.strings,
             ...options,
             'dot': '.',
             latestVersions: latest_versions_1.latestVersions,