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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular/cli",
-  "version": "14.0.0-next.12",
+  "version": "14.0.0-next.13",
   "description": "CLI tool for Angular",
   "main": "lib/cli/index.js",
   "bin": {
@@ -25,15 +25,15 @@
   },
   "homepage": "https://github.com/angular/angular-cli",
   "dependencies": {
-    "@angular-devkit/architect": "0.1400.0-next.12",
-    "@angular-devkit/core": "14.0.0-next.12",
-    "@angular-devkit/schematics": "14.0.0-next.12",
-    "@schematics/angular": "14.0.0-next.12",
+    "@angular-devkit/architect": "0.1400.0-next.13",
+    "@angular-devkit/core": "14.0.0-next.13",
+    "@angular-devkit/schematics": "14.0.0-next.13",
+    "@schematics/angular": "14.0.0-next.13",
     "@yarnpkg/lockfile": "1.1.0",
     "ansi-colors": "4.1.1",
     "debug": "4.3.4",
     "ini": "3.0.0",
-    "inquirer": "8.2.2",
+    "inquirer": "8.2.4",
     "jsonc-parser": "3.0.0",
     "npm-package-arg": "9.0.2",
     "npm-pick-manifest": "7.0.1",
@@ -49,12 +49,12 @@
   "ng-update": {
     "migrations": "@schematics/angular/migrations/migration-collection.json",
     "packageGroup": {
-      "@angular/cli": "14.0.0-next.12",
-      "@angular-devkit/architect": "0.1400.0-next.12",
-      "@angular-devkit/build-angular": "14.0.0-next.12",
-      "@angular-devkit/build-webpack": "0.1400.0-next.12",
-      "@angular-devkit/core": "14.0.0-next.12",
-      "@angular-devkit/schematics": "14.0.0-next.12"
+      "@angular/cli": "14.0.0-next.13",
+      "@angular-devkit/architect": "0.1400.0-next.13",
+      "@angular-devkit/build-angular": "14.0.0-next.13",
+      "@angular-devkit/build-webpack": "0.1400.0-next.13",
+      "@angular-devkit/core": "14.0.0-next.13",
+      "@angular-devkit/schematics": "14.0.0-next.13"
     }
   },
   "engines": {

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

@@ -42,6 +42,7 @@ const fs_1 = require("fs");
 const path = __importStar(require("path"));
 const helpers_1 = require("yargs/helpers");
 const analytics_1 = require("../analytics/analytics");
+const completion_1 = require("../utilities/completion");
 const memoize_1 = require("../utilities/memoize");
 var CommandScope;
 (function (CommandScope) {
@@ -89,6 +90,12 @@ class CommandModule {
         for (const [key, value] of Object.entries(options)) {
             camelCasedOptions[helpers_1.Parser.camelCase(key)] = value;
         }
+        // Set up autocompletion if appropriate.
+        const autocompletionExitCode = await (0, completion_1.considerSettingUpAutocompletion)(this.commandName, this.context.logger);
+        if (autocompletionExitCode !== undefined) {
+            process.exitCode = autocompletionExitCode;
+            return;
+        }
         // Gather and report analytics.
         const analytics = await this.getAnalytics();
         if (this.shouldReportAnalytics) {

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

@@ -12,5 +12,5 @@ export declare class CompletionCommandModule extends CommandModule implements Co
     describe: string;
     longDescriptionPath: string;
     builder(localYargs: Argv): Argv;
-    run(): void;
+    run(): Promise<number>;
 }

package/src/commands/completion/cli.js

@@ -14,13 +14,44 @@ exports.CompletionCommandModule = void 0;
 const path_1 = require("path");
 const yargs_1 = __importDefault(require("yargs"));
 const command_module_1 = require("../../command-builder/command-module");
+const command_1 = require("../../command-builder/utilities/command");
+const color_1 = require("../../utilities/color");
+const completion_1 = require("../../utilities/completion");
 class CompletionCommandModule extends command_module_1.CommandModule {
     constructor() {
         super(...arguments);
         this.command = 'completion';
-        this.describe = 'Generate a bash and zsh real-time type-ahead autocompletion script.';
+        this.describe = 'Set up Angular CLI autocompletion for your terminal.';
         this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
     }
+    builder(localYargs) {
+        return (0, command_1.addCommandModuleToYargs)(localYargs, CompletionScriptCommandModule, this.context);
+    }
+    async run() {
+        let rcFile;
+        try {
+            rcFile = await (0, completion_1.initializeAutocomplete)();
+        }
+        catch (err) {
+            this.context.logger.error(err.message);
+            return 1;
+        }
+        this.context.logger.info(`
+Appended \`source <(ng completion script)\` to \`${rcFile}\`. Restart your terminal or run the following to autocomplete \`ng\` commands:
+
+    ${color_1.colors.yellow('source <(ng completion script)')}
+      `.trim());
+        return 0;
+    }
+}
+exports.CompletionCommandModule = CompletionCommandModule;
+class CompletionScriptCommandModule extends command_module_1.CommandModule {
+    constructor() {
+        super(...arguments);
+        this.command = 'script';
+        this.describe = 'Generate a bash and zsh real-time type-ahead autocompletion script.';
+        this.longDescriptionPath = undefined;
+    }
     builder(localYargs) {
         return localYargs;
     }
@@ -28,4 +59,3 @@ class CompletionCommandModule extends command_module_1.CommandModule {
         yargs_1.default.showCompletionScript();
     }
 }
-exports.CompletionCommandModule = CompletionCommandModule;

package/src/commands/completion/long-description.md

@@ -1 +1,5 @@
-To enable bash and zsh real-time type-ahead autocompletion, copy and paste the generated script to your `.bashrc`, `.bash_profile`, `.zshrc` or `.zsh_profile`.
+To enable Bash and Zsh real-time type-ahead autocompletion, run
+`ng completion` and restart your terminal.
+
+Alternatively, append `source <(ng completion script)` to the appropriate `.bashrc`,
+`.bash_profile`, `.zshrc`, `.zsh_profile`, or `.profile` file.

package/src/commands/config/cli.js

@@ -83,6 +83,7 @@ class ConfigCommandModule extends command_module_1.CommandModule {
             'cli.analytics',
             'cli.analyticsSharing.tracking',
             'cli.analyticsSharing.uuid',
+            'cli.completion.prompted',
         ]);
         if (options.global &&
             !options.jsonPath.startsWith('schematics.') &&

package/src/utilities/completion.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @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';
+/**
+ * Checks if it is appropriate to prompt the user to setup autocompletion. If not, does nothing. If
+ * so prompts and sets up autocompletion for the user. Returns an exit code if the program should
+ * terminate, otherwise returns `undefined`.
+ * @returns an exit code if the program should terminate, undefined otherwise.
+ */
+export declare function considerSettingUpAutocompletion(command: string, logger: logging.Logger): Promise<number | undefined>;
+/**
+ * Sets up autocompletion for the user's terminal. This attempts to find the configuration file for
+ * the current shell (`.bashrc`, `.zshrc`, etc.) and append a command which enables autocompletion
+ * for the Angular CLI. Supports only Bash and Zsh. Returns whether or not it was successful.
+ * @return The full path of the configuration file modified.
+ */
+export declare function initializeAutocomplete(): Promise<string>;

package/src/utilities/completion.js

@@ -0,0 +1,217 @@
+"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.initializeAutocomplete = exports.considerSettingUpAutocompletion = void 0;
+const core_1 = require("@angular-devkit/core");
+const fs_1 = require("fs");
+const path = __importStar(require("path"));
+const process_1 = require("process");
+const color_1 = require("../utilities/color");
+const config_1 = require("../utilities/config");
+const environment_options_1 = require("../utilities/environment-options");
+const tty_1 = require("../utilities/tty");
+/**
+ * Checks if it is appropriate to prompt the user to setup autocompletion. If not, does nothing. If
+ * so prompts and sets up autocompletion for the user. Returns an exit code if the program should
+ * terminate, otherwise returns `undefined`.
+ * @returns an exit code if the program should terminate, undefined otherwise.
+ */
+async function considerSettingUpAutocompletion(command, logger) {
+    // Check if we should prompt the user to setup autocompletion.
+    const completionConfig = await getCompletionConfig();
+    if (!(await shouldPromptForAutocompletionSetup(command, completionConfig))) {
+        return undefined; // Already set up or prompted previously, nothing to do.
+    }
+    // Prompt the user and record their response.
+    const shouldSetupAutocompletion = await promptForAutocompletion();
+    if (!shouldSetupAutocompletion) {
+        // User rejected the prompt and doesn't want autocompletion.
+        logger.info(`
+Ok, you won't be prompted again. Should you change your mind, the following command will set up autocompletion for you:
+
+    ${color_1.colors.yellow(`ng completion`)}
+    `.trim());
+        // Save configuration to remember that the user was prompted and avoid prompting again.
+        await setCompletionConfig({ ...completionConfig, prompted: true });
+        return undefined;
+    }
+    // User accepted the prompt, set up autocompletion.
+    let rcFile;
+    try {
+        rcFile = await initializeAutocomplete();
+    }
+    catch (err) {
+        // Failed to set up autocompeletion, log the error and abort.
+        logger.error(err.message);
+        return 1;
+    }
+    // Notify the user autocompletion was set up successfully.
+    logger.info(`
+Appended \`source <(ng completion script)\` to \`${rcFile}\`. Restart your terminal or run the following to autocomplete \`ng\` commands:
+
+    ${color_1.colors.yellow(`source <(ng completion script)`)}
+    `.trim());
+    // Save configuration to remember that the user was prompted.
+    await setCompletionConfig({ ...completionConfig, prompted: true });
+    return undefined;
+}
+exports.considerSettingUpAutocompletion = considerSettingUpAutocompletion;
+async function getCompletionConfig() {
+    var _a;
+    const wksp = await (0, config_1.getWorkspace)('global');
+    return (_a = wksp === null || wksp === void 0 ? void 0 : wksp.getCli()) === null || _a === void 0 ? void 0 : _a['completion'];
+}
+async function setCompletionConfig(config) {
+    var _a;
+    var _b;
+    const wksp = await (0, config_1.getWorkspace)('global');
+    if (!wksp) {
+        throw new Error(`Could not find global workspace`);
+    }
+    (_a = (_b = wksp.extensions)['cli']) !== null && _a !== void 0 ? _a : (_b['cli'] = {});
+    const cli = wksp.extensions['cli'];
+    if (!core_1.json.isJsonObject(cli)) {
+        throw new Error(`Invalid config found at ${wksp.filePath}. \`extensions.cli\` should be an object.`);
+    }
+    cli.completion = config;
+    await wksp.save();
+}
+async function shouldPromptForAutocompletionSetup(command, config) {
+    // Force whether or not to prompt for autocomplete to give an easy path for e2e testing to skip.
+    if (environment_options_1.forceAutocomplete !== undefined) {
+        return environment_options_1.forceAutocomplete;
+    }
+    // Don't prompt on `ng update` or `ng completion`.
+    if (command === 'update' || command === 'completion') {
+        return false;
+    }
+    // Non-interactive and continuous integration systems don't care about autocompletion.
+    if (!(0, tty_1.isTTY)()) {
+        return false;
+    }
+    // Skip prompt if the user has already been prompted.
+    if (config === null || config === void 0 ? void 0 : config.prompted) {
+        return false;
+    }
+    // `$HOME` variable is necessary to find RC files to modify.
+    const home = process_1.env['HOME'];
+    if (!home) {
+        return false;
+    }
+    // Get possible RC files for the current shell.
+    const shell = process_1.env['SHELL'];
+    if (!shell) {
+        return false;
+    }
+    const rcFiles = getShellRunCommandCandidates(shell, home);
+    if (!rcFiles) {
+        return false; // Unknown shell.
+    }
+    // Check each RC file if they already use `ng completion script` in any capacity and don't prompt.
+    for (const rcFile of rcFiles) {
+        const contents = await fs_1.promises.readFile(rcFile, 'utf-8').catch(() => undefined);
+        if (contents === null || contents === void 0 ? void 0 : contents.includes('ng completion script')) {
+            return false;
+        }
+    }
+    return true;
+}
+async function promptForAutocompletion() {
+    // Dynamically load `inquirer` so users don't have to pay the cost of parsing and executing it for
+    // the 99% of builds that *don't* prompt for autocompletion.
+    const { prompt } = await Promise.resolve().then(() => __importStar(require('inquirer')));
+    const { autocomplete } = await prompt([
+        {
+            name: 'autocomplete',
+            type: 'confirm',
+            message: `
+Would you like to enable autocompletion? This will set up your terminal so pressing TAB while typing
+Angular CLI commands will show possible options and autocomplete arguments. (Enabling autocompletion
+will modify configuration files in your home directory.)
+      `
+                .split('\n')
+                .join(' ')
+                .trim(),
+            default: true,
+        },
+    ]);
+    return autocomplete;
+}
+/**
+ * Sets up autocompletion for the user's terminal. This attempts to find the configuration file for
+ * the current shell (`.bashrc`, `.zshrc`, etc.) and append a command which enables autocompletion
+ * for the Angular CLI. Supports only Bash and Zsh. Returns whether or not it was successful.
+ * @return The full path of the configuration file modified.
+ */
+async function initializeAutocomplete() {
+    var _a, _b;
+    // Get the currently active `$SHELL` and `$HOME` environment variables.
+    const shell = process_1.env['SHELL'];
+    if (!shell) {
+        throw new Error('`$SHELL` environment variable not set. Angular CLI autocompletion only supports Bash or' +
+            ' Zsh.');
+    }
+    const home = process_1.env['HOME'];
+    if (!home) {
+        throw new Error('`$HOME` environment variable not set. Setting up autocompletion modifies configuration files' +
+            ' in the home directory and must be set.');
+    }
+    // Get all the files we can add `ng completion` to which apply to the user's `$SHELL`.
+    const runCommandCandidates = getShellRunCommandCandidates(shell, home);
+    if (!runCommandCandidates) {
+        throw new Error(`Unknown \`$SHELL\` environment variable value (${shell}). Angular CLI autocompletion only supports Bash or Zsh.`);
+    }
+    // Get the first file that already exists or fallback to a new file of the first candidate.
+    const candidates = await Promise.allSettled(runCommandCandidates.map((rcFile) => fs_1.promises.access(rcFile).then(() => rcFile)));
+    const rcFile = (_b = (_a = candidates.find((result) => result.status === 'fulfilled')) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : runCommandCandidates[0];
+    // Append Angular autocompletion setup to RC file.
+    try {
+        await fs_1.promises.appendFile(rcFile, '\n\n# Load Angular CLI autocompletion.\nsource <(ng completion script)\n');
+    }
+    catch (err) {
+        throw new Error(`Failed to append autocompletion setup to \`${rcFile}\`:\n${err.message}`);
+    }
+    return rcFile;
+}
+exports.initializeAutocomplete = initializeAutocomplete;
+/** Returns an ordered list of possibile candidates of RC files used by the given shell. */
+function getShellRunCommandCandidates(shell, home) {
+    if (shell.toLowerCase().includes('bash')) {
+        return ['.bashrc', '.bash_profile', '.profile'].map((file) => path.join(home, file));
+    }
+    else if (shell.toLowerCase().includes('zsh')) {
+        return ['.zshrc', '.zsh_profile', '.profile'].map((file) => path.join(home, file));
+    }
+    else {
+        return undefined;
+    }
+}

package/src/utilities/environment-options.d.ts

@@ -10,3 +10,4 @@ export declare const analyticsShareDisabled: boolean;
 export declare const isCI: boolean;
 export declare const disableVersionCheck: boolean;
 export declare const ngDebug: boolean;
+export declare const forceAutocomplete: boolean | undefined;

package/src/utilities/environment-options.js

@@ -7,7 +7,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ngDebug = exports.disableVersionCheck = exports.isCI = exports.analyticsShareDisabled = exports.analyticsDisabled = void 0;
+exports.forceAutocomplete = exports.ngDebug = exports.disableVersionCheck = exports.isCI = exports.analyticsShareDisabled = exports.analyticsDisabled = void 0;
 function isPresent(variable) {
     return typeof variable === 'string' && variable !== '';
 }
@@ -17,8 +17,15 @@ function isDisabled(variable) {
 function isEnabled(variable) {
     return isPresent(variable) && (variable === '1' || variable.toLowerCase() === 'true');
 }
+function optional(variable) {
+    if (!isPresent(variable)) {
+        return undefined;
+    }
+    return isEnabled(variable);
+}
 exports.analyticsDisabled = isDisabled(process.env['NG_CLI_ANALYTICS']);
 exports.analyticsShareDisabled = isDisabled(process.env['NG_CLI_ANALYTICS_SHARE']);
 exports.isCI = isEnabled(process.env['CI']);
 exports.disableVersionCheck = isEnabled(process.env['NG_DISABLE_VERSION_CHECK']);
 exports.ngDebug = isEnabled(process.env['NG_DEBUG']);
+exports.forceAutocomplete = optional(process.env['NG_FORCE_AUTOCOMPLETE']);