@angular/cli 14.0.0-next.3 → 14.0.0-next.6

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

@@ -0,0 +1,13 @@
+/**
+ * @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 { CommandContext, CommandModule, CommandModuleImplementation } from '../command-module';
+export declare const demandCommandFailureMessage = "You need to specify a command before moving on. Use '--help' to view the available commands.";
+export declare function addCommandModuleToYargs<T, U extends Partial<CommandModuleImplementation> & {
+    new (context: CommandContext): Partial<CommandModuleImplementation> & CommandModule;
+}>(localYargs: Argv<T>, commandModule: U, context: CommandContext): Argv<T>;

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

@@ -0,0 +1,27 @@
+"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.addCommandModuleToYargs = exports.demandCommandFailureMessage = void 0;
+exports.demandCommandFailureMessage = `You need to specify a command before moving on. Use '--help' to view the available commands.`;
+function addCommandModuleToYargs(localYargs, commandModule, context) {
+    const cmd = new commandModule(context);
+    const describe = context.args.options.jsonHelp ? cmd.fullDescribe : cmd.describe;
+    return localYargs.command({
+        command: cmd.command,
+        aliases: cmd.aliases,
+        describe: 
+        // We cannot add custom fields in help, such as long command description which is used in AIO.
+        // Therefore, we get around this by adding a complex object as a string which we later parse when generating the help files.
+        typeof describe === 'object' ? JSON.stringify(describe) : describe,
+        deprecated: cmd.deprecated,
+        builder: (argv) => cmd.builder(argv),
+        handler: (args) => cmd.handler(args),
+    });
+}
+exports.addCommandModuleToYargs = addCommandModuleToYargs;

package/src/command-builder/utilities/json-help.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @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
+ */
+interface JsonHelpOption {
+    name: string;
+    type?: string;
+    deprecated: boolean | string;
+    aliases?: string[];
+    default?: string;
+    required?: boolean;
+    positional?: number;
+    enum?: string[];
+    description?: string;
+}
+interface JsonHelpDescription {
+    shortDescription?: string;
+    longDescription?: string;
+    longDescriptionRelativePath?: string;
+}
+interface JsonHelpSubcommand extends JsonHelpDescription {
+    name: string;
+    aliases: string[];
+    deprecated: string | boolean;
+}
+export interface JsonHelp extends JsonHelpDescription {
+    name: string;
+    command: string;
+    options: JsonHelpOption[];
+    subcommands?: JsonHelpSubcommand[];
+}
+export declare function jsonHelpUsage(): string;
+export {};

package/src/command-builder/utilities/json-help.js

@@ -0,0 +1,94 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonHelpUsage = void 0;
+const yargs_1 = __importDefault(require("yargs"));
+const yargsDefaultCommandRegExp = /^\$0|\*/;
+function jsonHelpUsage() {
+    var _a, _b, _c, _d, _e;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const localYargs = yargs_1.default;
+    const { deprecatedOptions, alias: aliases, array, string, boolean, number, choices, demandedOptions, default: defaultVal, hiddenOptions = [], } = localYargs.getOptions();
+    const internalMethods = localYargs.getInternalMethods();
+    const usageInstance = internalMethods.getUsageInstance();
+    const context = internalMethods.getContext();
+    const descriptions = usageInstance.getDescriptions();
+    const groups = localYargs.getGroups();
+    const positional = groups[usageInstance.getPositionalGroupName()];
+    const hidden = new Set(hiddenOptions);
+    const normalizeOptions = [];
+    const allAliases = new Set([...Object.values(aliases).flat()]);
+    for (const [names, type] of [
+        [array, 'array'],
+        [string, 'string'],
+        [boolean, 'boolean'],
+        [number, 'number'],
+    ]) {
+        for (const name of names) {
+            if (allAliases.has(name) || hidden.has(name)) {
+                // Ignore hidden, aliases and already visited option.
+                continue;
+            }
+            const positionalIndex = (_a = positional === null || positional === void 0 ? void 0 : positional.indexOf(name)) !== null && _a !== void 0 ? _a : -1;
+            const alias = aliases[name];
+            normalizeOptions.push({
+                name,
+                type,
+                deprecated: deprecatedOptions[name],
+                aliases: (alias === null || alias === void 0 ? void 0 : alias.length) > 0 ? alias : undefined,
+                default: defaultVal[name],
+                required: demandedOptions[name],
+                enum: choices[name],
+                description: (_b = descriptions[name]) === null || _b === void 0 ? void 0 : _b.replace('__yargsString__:', ''),
+                positional: positionalIndex >= 0 ? positionalIndex : undefined,
+            });
+        }
+    }
+    // https://github.com/yargs/yargs/blob/00e4ebbe3acd438e73fdb101e75b4f879eb6d345/lib/usage.ts#L124
+    const subcommands = usageInstance.getCommands()
+        .map(([name, rawDescription, isDefault, aliases, deprecated]) => ({
+        name: name.split(' ', 1)[0].replace(yargsDefaultCommandRegExp, ''),
+        command: name.replace(yargsDefaultCommandRegExp, ''),
+        default: isDefault || undefined,
+        ...parseDescription(rawDescription),
+        aliases,
+        deprecated,
+    }))
+        .sort((a, b) => a.name.localeCompare(b.name));
+    const [command, rawDescription] = (_c = usageInstance.getUsage()[0]) !== null && _c !== void 0 ? _c : [];
+    const defaultSubCommand = (_e = (_d = subcommands.find((x) => x.default)) === null || _d === void 0 ? void 0 : _d.command) !== null && _e !== void 0 ? _e : '';
+    const otherSubcommands = subcommands.filter((s) => !s.default);
+    const output = {
+        name: [...context.commands].pop(),
+        command: `${command === null || command === void 0 ? void 0 : command.replace(yargsDefaultCommandRegExp, localYargs['$0'])}${defaultSubCommand}`,
+        ...parseDescription(rawDescription),
+        options: normalizeOptions.sort((a, b) => a.name.localeCompare(b.name)),
+        subcommands: otherSubcommands.length ? otherSubcommands : undefined,
+    };
+    return JSON.stringify(output, undefined, 2);
+}
+exports.jsonHelpUsage = jsonHelpUsage;
+function parseDescription(rawDescription) {
+    try {
+        const { longDescription, describe: shortDescription, longDescriptionRelativePath, } = JSON.parse(rawDescription);
+        return {
+            shortDescription,
+            longDescriptionRelativePath,
+            longDescription,
+        };
+    }
+    catch {
+        return {
+            shortDescription: rawDescription,
+        };
+    }
+}

package/src/command-builder/utilities/json-schema.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @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 { json } from '@angular-devkit/core';
+import yargs from 'yargs';
+/**
+ * An option description.
+ */
+export interface Option extends yargs.Options {
+    /**
+     * The name of the option.
+     */
+    name: string;
+    /**
+     * Whether this option is required or not.
+     */
+    required?: boolean;
+    /**
+     * Format field of this option.
+     */
+    format?: string;
+    /**
+     * Whether this option should be hidden from the help output. It will still show up in JSON help.
+     */
+    hidden?: boolean;
+    /**
+     * If this option can be used as an argument, the position of the argument. Otherwise omitted.
+     */
+    positional?: number;
+    /**
+     * Whether or not to report this option to the Angular Team, and which custom field to use.
+     * If this is falsey, do not report this option.
+     */
+    userAnalytics?: number;
+}
+export declare function parseJsonSchemaToOptions(registry: json.schema.SchemaRegistry, schema: json.JsonObject, interactive?: boolean): Promise<Option[]>;

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/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 {};