@angular/cli 14.0.0-next.1 → 14.0.0-next.12

package/{utilities → src/command-builder/utilities}/json-schema.js

@@ -7,102 +7,9 @@
  * found in the LICENSE file at https://angular.io/license
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseJsonSchemaToOptions = exports.parseJsonSchemaToCommandDescription = exports.parseJsonSchemaToSubCommandDescription = exports.CommandJsonPathException = void 0;
+exports.parseJsonSchemaToOptions = void 0;
 const core_1 = require("@angular-devkit/core");
-const tools_1 = require("@angular-devkit/schematics/tools");
-const fs_1 = require("fs");
-const path_1 = require("path");
-const interface_1 = require("../models/interface");
-class CommandJsonPathException extends core_1.BaseException {
-    constructor(path, name) {
-        super(`File ${path} was not found while constructing the subcommand ${name}.`);
-        this.path = path;
-        this.name = name;
-    }
-}
-exports.CommandJsonPathException = CommandJsonPathException;
-function _getEnumFromValue(value, enumeration, defaultValue) {
-    if (typeof value !== 'string') {
-        return defaultValue;
-    }
-    if (Object.values(enumeration).includes(value)) {
-        return value;
-    }
-    return defaultValue;
-}
-async function parseJsonSchemaToSubCommandDescription(name, jsonPath, registry, schema) {
-    const options = await parseJsonSchemaToOptions(registry, schema);
-    const aliases = [];
-    if (core_1.json.isJsonArray(schema.$aliases)) {
-        schema.$aliases.forEach((value) => {
-            if (typeof value == 'string') {
-                aliases.push(value);
-            }
-        });
-    }
-    if (core_1.json.isJsonArray(schema.aliases)) {
-        schema.aliases.forEach((value) => {
-            if (typeof value == 'string') {
-                aliases.push(value);
-            }
-        });
-    }
-    if (typeof schema.alias == 'string') {
-        aliases.push(schema.alias);
-    }
-    let longDescription = '';
-    if (typeof schema.$longDescription == 'string' && schema.$longDescription) {
-        const ldPath = (0, path_1.resolve)((0, path_1.dirname)(jsonPath), schema.$longDescription);
-        try {
-            longDescription = (0, fs_1.readFileSync)(ldPath, 'utf-8');
-        }
-        catch (e) {
-            throw new CommandJsonPathException(ldPath, name);
-        }
-    }
-    let usageNotes = '';
-    if (typeof schema.$usageNotes == 'string' && schema.$usageNotes) {
-        const unPath = (0, path_1.resolve)((0, path_1.dirname)(jsonPath), schema.$usageNotes);
-        try {
-            usageNotes = (0, fs_1.readFileSync)(unPath, 'utf-8');
-        }
-        catch (e) {
-            throw new CommandJsonPathException(unPath, name);
-        }
-    }
-    const description = '' + (schema.description === undefined ? '' : schema.description);
-    return {
-        name,
-        description,
-        ...(longDescription ? { longDescription } : {}),
-        ...(usageNotes ? { usageNotes } : {}),
-        options,
-        aliases,
-    };
-}
-exports.parseJsonSchemaToSubCommandDescription = parseJsonSchemaToSubCommandDescription;
-async function parseJsonSchemaToCommandDescription(name, jsonPath, registry, schema) {
-    const subcommand = await parseJsonSchemaToSubCommandDescription(name, jsonPath, registry, schema);
-    // Before doing any work, let's validate the implementation.
-    if (typeof schema.$impl != 'string') {
-        throw new Error(`Command ${name} has an invalid implementation.`);
-    }
-    const ref = new tools_1.ExportStringRef(schema.$impl, (0, path_1.dirname)(jsonPath));
-    const impl = ref.ref;
-    if (impl === undefined || typeof impl !== 'function') {
-        throw new Error(`Command ${name} has an invalid implementation.`);
-    }
-    const scope = _getEnumFromValue(schema.$scope, interface_1.CommandScope, interface_1.CommandScope.Default);
-    const hidden = !!schema.$hidden;
-    return {
-        ...subcommand,
-        scope,
-        hidden,
-        impl,
-    };
-}
-exports.parseJsonSchemaToCommandDescription = parseJsonSchemaToCommandDescription;
-async function parseJsonSchemaToOptions(registry, schema) {
+async function parseJsonSchemaToOptions(registry, schema, interactive = true) {
     const options = [];
     function visitor(current, pointer, parentSchema) {
         if (!parentSchema) {
@@ -131,8 +38,7 @@ async function parseJsonSchemaToOptions(registry, schema) {
             throw new Error('Cannot find type of schema.');
         }
         // We only support number, string or boolean (or array of those), so remove everything else.
-        const types = [...typeSet]
-            .filter((x) => {
+        const types = [...typeSet].filter((x) => {
             switch (x) {
                 case 'boolean':
                 case 'number':
@@ -149,8 +55,7 @@ async function parseJsonSchemaToOptions(registry, schema) {
                 default:
                     return false;
             }
-        })
-            .map((x) => _getEnumFromValue(x, interface_1.OptionType, interface_1.OptionType.String));
+        });
         if (types.length == 0) {
             // This means it's not usable on the command line. e.g. an Object.
             return;
@@ -190,10 +95,11 @@ async function parseJsonSchemaToOptions(registry, schema) {
         const $default = current.$default;
         const $defaultIndex = core_1.json.isJsonObject($default) && $default['$source'] == 'argv' ? $default['index'] : undefined;
         const positional = typeof $defaultIndex == 'number' ? $defaultIndex : undefined;
-        const required = core_1.json.isJsonArray(current.required)
-            ? current.required.indexOf(name) != -1
-            : false;
-        const aliases = core_1.json.isJsonArray(current.aliases)
+        let required = core_1.json.isJsonArray(schema.required) ? schema.required.includes(name) : false;
+        if (required && interactive && current['x-prompt']) {
+            required = false;
+        }
+        const alias = core_1.json.isJsonArray(current.aliases)
             ? [...current.aliases].map((x) => '' + x)
             : current.alias
                 ? ['' + current.alias]
@@ -209,37 +115,30 @@ async function parseJsonSchemaToOptions(registry, schema) {
         const option = {
             name,
             description: '' + (current.description === undefined ? '' : current.description),
-            ...(types.length == 1 ? { type } : { type, types }),
-            ...(defaultValue !== undefined ? { default: defaultValue } : {}),
-            ...(enumValues && enumValues.length > 0 ? { enum: enumValues } : {}),
+            type,
+            default: defaultValue,
+            choices: enumValues.length ? enumValues : undefined,
             required,
-            aliases,
-            ...(format !== undefined ? { format } : {}),
+            alias,
+            format,
             hidden,
-            ...(userAnalytics ? { userAnalytics } : {}),
-            ...(deprecated !== undefined ? { deprecated } : {}),
-            ...(positional !== undefined ? { positional } : {}),
+            userAnalytics,
+            deprecated,
+            positional,
         };
         options.push(option);
     }
     const flattenedSchema = await registry.flatten(schema).toPromise();
     core_1.json.schema.visitJsonSchema(flattenedSchema, visitor);
-    // Sort by positional.
+    // Sort by positional and name.
     return options.sort((a, b) => {
         if (a.positional) {
-            if (b.positional) {
-                return a.positional - b.positional;
-            }
-            else {
-                return 1;
-            }
+            return b.positional ? a.positional - b.positional : a.name.localeCompare(b.name);
         }
         else if (b.positional) {
             return -1;
         }
-        else {
-            return 0;
-        }
+        return a.name.localeCompare(b.name);
     });
 }
 exports.parseJsonSchemaToOptions = parseJsonSchemaToOptions;

package/src/command-builder/utilities/normalize-options-middleware.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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 * as yargs from 'yargs';
+/**
+ * A Yargs middleware that normalizes non Array options when the argument has been provided multiple times.
+ *
+ * By default, when an option is non array and it is provided multiple times in the command line, yargs
+ * will not override it's value but instead it will be changed to an array unless `duplicate-arguments-array` is disabled.
+ * But this option also have an effect on real array options which isn't desired.
+ *
+ * See: https://github.com/yargs/yargs-parser/pull/163#issuecomment-516566614
+ */
+export declare function normalizeOptionsMiddleware(args: yargs.Arguments): void;

package/src/command-builder/utilities/normalize-options-middleware.js

@@ -0,0 +1,59 @@
+"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.normalizeOptionsMiddleware = void 0;
+const yargs = __importStar(require("yargs"));
+/**
+ * A Yargs middleware that normalizes non Array options when the argument has been provided multiple times.
+ *
+ * By default, when an option is non array and it is provided multiple times in the command line, yargs
+ * will not override it's value but instead it will be changed to an array unless `duplicate-arguments-array` is disabled.
+ * But this option also have an effect on real array options which isn't desired.
+ *
+ * See: https://github.com/yargs/yargs-parser/pull/163#issuecomment-516566614
+ */
+function normalizeOptionsMiddleware(args) {
+    // `getOptions` is not included in the types even though it's public API.
+    // https://github.com/yargs/yargs/issues/2098
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const { array } = yargs.getOptions();
+    const arrayOptions = new Set(array);
+    for (const [key, value] of Object.entries(args)) {
+        if (key !== '_' && Array.isArray(value) && !arrayOptions.has(key)) {
+            const newValue = value.pop();
+            // eslint-disable-next-line no-console
+            console.warn(`Option '${key}' has been specified multiple times. The value '${newValue}' will be used.`);
+            args[key] = newValue;
+        }
+    }
+}
+exports.normalizeOptionsMiddleware = normalizeOptionsMiddleware;

package/{models → src/command-builder/utilities}/schematic-engine-host.d.ts

@@ -6,9 +6,9 @@
  * found in the LICENSE file at https://angular.io/license
  */
 import { RuleFactory } from '@angular-devkit/schematics';
-import { NodeModulesEngineHost } from '@angular-devkit/schematics/tools';
+import { FileSystemCollectionDesc, NodeModulesEngineHost } from '@angular-devkit/schematics/tools';
 export declare class SchematicEngineHost extends NodeModulesEngineHost {
-    protected _resolveReferenceString(refString: string, parentPath: string): {
+    protected _resolveReferenceString(refString: string, parentPath: string, collectionDescription?: FileSystemCollectionDesc): {
         ref: RuleFactory<{}>;
         path: string;
     } | null;

package/{models → src/command-builder/utilities}/schematic-engine-host.js

@@ -21,21 +21,18 @@ const path_1 = require("path");
 const vm_1 = require("vm");
 /**
  * Environment variable to control schematic package redirection
- * Default: Angular schematics only
  */
 const schematicRedirectVariable = (_a = process.env['NG_SCHEMATIC_REDIRECT']) === null || _a === void 0 ? void 0 : _a.toLowerCase();
-function shouldWrapSchematic(schematicFile) {
+function shouldWrapSchematic(schematicFile, schematicEncapsulation) {
     // Check environment variable if present
-    if (schematicRedirectVariable !== undefined) {
-        switch (schematicRedirectVariable) {
-            case '0':
-            case 'false':
-            case 'off':
-            case 'none':
-                return false;
-            case 'all':
-                return true;
-        }
+    switch (schematicRedirectVariable) {
+        case '0':
+        case 'false':
+        case 'off':
+        case 'none':
+            return false;
+        case 'all':
+            return true;
     }
     const normalizedSchematicFile = schematicFile.replace(/\\/g, '/');
     // Never wrap the internal update schematic when executed directly
@@ -45,17 +42,21 @@ function shouldWrapSchematic(schematicFile) {
         !normalizedSchematicFile.includes('node_modules/@angular/cli/node_modules/')) {
         return false;
     }
-    // Default is only first-party Angular schematic packages
+    // Check for first-party Angular schematic packages
     // Angular schematics are safe to use in the wrapped VM context
-    return /\/node_modules\/@(?:angular|schematics|nguniversal)\//.test(normalizedSchematicFile);
+    if (/\/node_modules\/@(?:angular|schematics|nguniversal)\//.test(normalizedSchematicFile)) {
+        return true;
+    }
+    // Otherwise use the value of the schematic collection's encapsulation option (current default of false)
+    return schematicEncapsulation;
 }
 class SchematicEngineHost extends tools_1.NodeModulesEngineHost {
-    _resolveReferenceString(refString, parentPath) {
+    _resolveReferenceString(refString, parentPath, collectionDescription) {
         const [path, name] = refString.split('#', 2);
         // Mimic behavior of ExportStringRef class used in default behavior
         const fullPath = path[0] === '.' ? (0, path_1.resolve)(parentPath !== null && parentPath !== void 0 ? parentPath : process.cwd(), path) : path;
         const schematicFile = require.resolve(fullPath, { paths: [parentPath] });
-        if (shouldWrapSchematic(schematicFile)) {
+        if (shouldWrapSchematic(schematicFile, !!(collectionDescription === null || collectionDescription === void 0 ? void 0 : collectionDescription.encapsulation))) {
             const schematicPath = (0, path_1.dirname)(schematicFile);
             const moduleCache = new Map();
             const factoryInitializer = wrap(schematicFile, schematicPath, moduleCache, name || 'default');
@@ -66,7 +67,7 @@ class SchematicEngineHost extends tools_1.NodeModulesEngineHost {
             return { ref: factory, path: schematicPath };
         }
         // All other schematics use default behavior
-        return super._resolveReferenceString(refString, parentPath);
+        return super._resolveReferenceString(refString, parentPath, collectionDescription);
     }
 }
 exports.SchematicEngineHost = SchematicEngineHost;
@@ -108,6 +109,15 @@ function wrap(schematicFile, schematicDirectory, moduleCache, exportName) {
             // Provide compatibility modules for older versions of @angular/cdk
             return legacyModules[id];
         }
+        else if (id.startsWith('schematics:')) {
+            // Schematics built-in modules use the `schematics` scheme (similar to the Node.js `node` scheme)
+            const builtinId = id.slice(11);
+            const builtinModule = loadBuiltinModule(builtinId);
+            if (!builtinModule) {
+                throw new Error(`Unknown schematics built-in module '${id}' requested from schematic '${schematicFile}'`);
+            }
+            return builtinModule;
+        }
         else if (id.startsWith('@angular-devkit/') || id.startsWith('@schematics/')) {
             // Files should not redirect `@angular/core` and instead use the direct
             // dependency if available. This allows old major version migrations to continue to function
@@ -151,7 +161,9 @@ function wrap(schematicFile, schematicDirectory, moduleCache, exportName) {
     const schematicCode = (0, fs_1.readFileSync)(schematicFile, 'utf8');
     // `module` is required due to @angular/localize ng-add being in UMD format
     const headerCode = '(function() {\nvar exports = {};\nvar module = { exports };\n';
-    const footerCode = exportName ? `\nreturn exports['${exportName}'];});` : '\nreturn exports;});';
+    const footerCode = exportName
+        ? `\nreturn module.exports['${exportName}'];});`
+        : '\nreturn module.exports;});';
     const script = new vm_1.Script(headerCode + schematicCode + footerCode, {
         filename: schematicFile,
         lineOffset: 3,
@@ -170,3 +182,6 @@ function wrap(schematicFile, schematicDirectory, moduleCache, exportName) {
     const exportsFactory = script.runInNewContext(context);
     return exportsFactory;
 }
+function loadBuiltinModule(id) {
+    return undefined;
+}

package/src/command-builder/utilities/schematic-workflow.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @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 { logging } from '@angular-devkit/core';
+import { NodeWorkflow } from '@angular-devkit/schematics/tools';
+export declare function subscribeToWorkflow(workflow: NodeWorkflow, logger: logging.LoggerApi): {
+    files: Set<string>;
+    error: boolean;
+    unsubscribe: () => void;
+};

package/src/command-builder/utilities/schematic-workflow.js

@@ -0,0 +1,68 @@
+"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.subscribeToWorkflow = void 0;
+const core_1 = require("@angular-devkit/core");
+const color_1 = require("../../utilities/color");
+function subscribeToWorkflow(workflow, logger) {
+    const files = new Set();
+    let error = false;
+    let logs = [];
+    const reporterSubscription = workflow.reporter.subscribe((event) => {
+        // Strip leading slash to prevent confusion.
+        const eventPath = event.path.charAt(0) === '/' ? event.path.substring(1) : event.path;
+        switch (event.kind) {
+            case 'error':
+                error = true;
+                const desc = event.description == 'alreadyExist' ? 'already exists' : 'does not exist';
+                logger.error(`ERROR! ${eventPath} ${desc}.`);
+                break;
+            case 'update':
+                logs.push(core_1.tags.oneLine `
+              ${color_1.colors.cyan('UPDATE')} ${eventPath} (${event.content.length} bytes)
+            `);
+                files.add(eventPath);
+                break;
+            case 'create':
+                logs.push(core_1.tags.oneLine `
+              ${color_1.colors.green('CREATE')} ${eventPath} (${event.content.length} bytes)
+            `);
+                files.add(eventPath);
+                break;
+            case 'delete':
+                logs.push(`${color_1.colors.yellow('DELETE')} ${eventPath}`);
+                files.add(eventPath);
+                break;
+            case 'rename':
+                const eventToPath = event.to.charAt(0) === '/' ? event.to.substring(1) : event.to;
+                logs.push(`${color_1.colors.blue('RENAME')} ${eventPath} => ${eventToPath}`);
+                files.add(eventPath);
+                break;
+        }
+    });
+    const lifecycleSubscription = workflow.lifeCycle.subscribe((event) => {
+        if (event.kind == 'end' || event.kind == 'post-tasks-start') {
+            if (!error) {
+                // Output the logging queue, no error happened.
+                logs.forEach((log) => logger.info(log));
+            }
+            logs = [];
+            error = false;
+        }
+    });
+    return {
+        files,
+        error,
+        unsubscribe: () => {
+            reporterSubscription.unsubscribe();
+            lifecycleSubscription.unsubscribe();
+        },
+    };
+}
+exports.subscribeToWorkflow = subscribeToWorkflow;

package/src/commands/add/cli.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @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 { Argv } from 'yargs';
+import { CommandModuleImplementation, Options, OtherOptions } from '../../command-builder/command-module';
+import { SchematicsCommandArgs, SchematicsCommandModule } from '../../command-builder/schematics-command-module';
+interface AddCommandArgs extends SchematicsCommandArgs {
+    collection: string;
+    verbose?: boolean;
+    registry?: string;
+    'skip-confirmation'?: boolean;
+}
+export declare class AddCommandModule extends SchematicsCommandModule implements CommandModuleImplementation<AddCommandArgs> {
+    command: string;
+    describe: string;
+    longDescriptionPath: string;
+    protected allowPrivateSchematics: boolean;
+    private readonly schematicName;
+    builder(argv: Argv): Promise<Argv<AddCommandArgs>>;
+    run(options: Options<AddCommandArgs> & OtherOptions): Promise<number | void>;
+    private isProjectVersionValid;
+    reportAnalytics(options: OtherOptions, paths: string[]): Promise<void>;
+    private getCollectionName;
+    private isPackageInstalled;
+    private executeSchematic;
+    private findProjectVersion;
+    private hasMismatchedPeer;
+}
+export {};