@angular/cli 14.0.0-next.8 → 14.0.0-rc.1

package/src/utilities/completion.js

@@ -0,0 +1,282 @@
+"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.hasGlobalCliInstall = exports.initializeAutocomplete = exports.considerSettingUpAutocompletion = void 0;
+const core_1 = require("@angular-devkit/core");
+const child_process_1 = require("child_process");
+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());
+    if ((await hasGlobalCliInstall()) === false) {
+        logger.warn('Setup completed successfully, but there does not seem to be a global install of the' +
+            ' Angular CLI. For autocompletion to work, the CLI will need to be on your `$PATH`, which' +
+            ' is typically done with the `-g` flag in `npm install -g @angular/cli`.' +
+            '\n\n' +
+            'For more information, see https://angular.io/cli/completion#global-install');
+    }
+    // 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.
+    }
+    // Don't prompt if the user is missing a global CLI install. Autocompletion won't work after setup
+    // anyway and could be annoying for users running one-off commands via `npx` or using `npm start`.
+    if ((await hasGlobalCliInstall()) === false) {
+        return false;
+    }
+    // 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. If you're on Windows, Cmd and Powershell don't support command autocompletion," +
+            ' but Git Bash or Windows Subsystem for Linux should work, so please try again in one of' +
+            ' those environments.');
+    }
+    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 possible 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;
+    }
+}
+/**
+ * Returns whether the user has a global CLI install or `undefined` if this can't be determined.
+ * Execution from `npx` is *not* considered a global CLI install.
+ *
+ * This does *not* mean the current execution is from a global CLI install, only that a global
+ * install exists on the system.
+ */
+async function hasGlobalCliInstall() {
+    var _a;
+    // List all binaries with the `ng` name on the user's `$PATH`.
+    const proc = (0, child_process_1.execFile)('which', ['-a', 'ng']);
+    let stdout = '';
+    (_a = proc.stdout) === null || _a === void 0 ? void 0 : _a.addListener('data', (content) => {
+        stdout += content;
+    });
+    const exitCode = await new Promise((resolve) => {
+        proc.addListener('exit', (exitCode) => {
+            resolve(exitCode);
+        });
+    });
+    switch (exitCode) {
+        case 0:
+            // Successfully listed all `ng` binaries on the `$PATH`. Look for at least one line which is a
+            // global install. We can't easily identify global installs, but local installs are typically
+            // placed in `node_modules/.bin` by NPM / Yarn. `npx` also currently caches files at
+            // `~/.npm/_npx/*/node_modules/.bin/`, so the same logic applies.
+            const lines = stdout.split('\n').filter((line) => line !== '');
+            const hasGlobalInstall = lines.some((line) => {
+                // A binary is a local install if it is a direct child of a `node_modules/.bin/` directory.
+                const parent = path.parse(path.parse(line).dir);
+                const grandparent = path.parse(parent.dir);
+                const localInstall = grandparent.base === 'node_modules' && parent.base === '.bin';
+                return !localInstall;
+            });
+            return hasGlobalInstall;
+        case 1:
+            // No instances of `ng` on the user's `$PATH`.
+            return false;
+        case null:
+            // `which` was killed by a signal and did not exit gracefully. Maybe it hung or something else
+            // went very wrong, so treat this as inconclusive.
+            return undefined;
+        default:
+            // `which` returns exit code 2 if an invalid option is specified and `-a` doesn't appear to be
+            // supported on all systems. Other exit codes mean unknown errors occurred. Can't tell whether
+            // CLI is globally installed, so treat this as inconclusive.
+            return undefined;
+    }
+}
+exports.hasGlobalCliInstall = hasGlobalCliInstall;

package/src/utilities/config.d.ts

@@ -10,14 +10,15 @@ import { PackageManager } from '../../lib/config/workspace-schema';
 import { JSONFile } from './json-file';
 export declare const workspaceSchemaPath: string;
 export declare class AngularWorkspace {
-    private workspace;
+    private readonly workspace;
     readonly filePath: string;
     readonly basePath: string;
     constructor(workspace: workspaces.WorkspaceDefinition, filePath: string);
     get extensions(): Record<string, json.JsonValue | undefined>;
     get projects(): workspaces.ProjectDefinitionCollection;
-    getCli(): Record<string, any>;
-    getProjectCli(projectName: string): Record<string, any>;
+    getCli(): Record<string, any> | undefined;
+    getProjectCli(projectName: string): Record<string, any> | undefined;
+    save(): Promise<void>;
     static load(workspaceFilePath: string): Promise<AngularWorkspace>;
 }
 export declare function getWorkspace(level?: 'local' | 'global'): Promise<AngularWorkspace | undefined>;

package/src/utilities/config.js

@@ -134,12 +134,15 @@ class AngularWorkspace {
     // Temporary helper functions to support refactoring
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     getCli() {
-        return this.workspace.extensions['cli'] || {};
+        return this.workspace.extensions['cli'];
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     getProjectCli(projectName) {
         const project = this.workspace.projects.get(projectName);
-        return (project === null || project === void 0 ? void 0 : project.extensions['cli']) || {};
+        return project === null || project === void 0 ? void 0 : project.extensions['cli'];
+    }
+    save() {
+        return core_1.workspaces.writeWorkspace(this.workspace, createWorkspaceHost(), this.filePath);
     }
     static async load(workspaceFilePath) {
         const result = await core_1.workspaces.readWorkspace(workspaceFilePath, createWorkspaceHost(), core_1.workspaces.WorkspaceFormat.JSON);
@@ -152,10 +155,13 @@ async function getWorkspace(level = 'local') {
     if (cachedWorkspaces.has(level)) {
         return cachedWorkspaces.get(level);
     }
-    const configPath = level === 'local' ? projectFilePath() : globalFilePath();
+    let configPath = level === 'local' ? projectFilePath() : globalFilePath();
     if (!configPath) {
-        cachedWorkspaces.set(level, undefined);
-        return undefined;
+        if (level === 'local') {
+            cachedWorkspaces.set(level, undefined);
+            return undefined;
+        }
+        configPath = createGlobalSettings();
     }
     try {
         const workspace = await AngularWorkspace.load(configPath);

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']);

package/src/utilities/json-file.js

@@ -59,6 +59,7 @@ class JSONFile {
         }
         const edits = (0, jsonc_parser_1.modify)(this.content, jsonPath, value, {
             getInsertionIndex,
+            // TODO: use indentation from original file.
             formattingOptions: {
                 insertSpaces: true,
                 tabSize: 2,