refactor(@angular/cli): convert workspace access to async

This is in preparation for conversion from the experimental workspace API to the stable workspace API.

Author: clydin

packages/angular/cli/bin/postinstall/analytics-prompt.js

@@ -5,12 +5,12 @@ if ('NG_CLI_ANALYTICS' in process.env) {
   return;
 }
 
-(async () => {
-  try {
-    const analytics = require('../../models/analytics');
+try {
+  var analytics = require('../../models/analytics');
 
-    if (!analytics.hasGlobalAnalyticsConfiguration()) {
-      await analytics.promptGlobalAnalytics();
+  analytics.hasGlobalAnalyticsConfiguration().then(hasGlobalConfig => {
+    if (!hasGlobalConfig) {
+      return analytics.promptGlobalAnalytics();
     }
-  } catch (_) {}
-})();
+  });
+} catch (_) {}

packages/angular/cli/commands/add-impl.ts

@@ -27,7 +27,6 @@ const npa = require('npm-package-arg');
 export class AddCommand extends SchematicCommand<AddCommandSchema> {
   readonly allowPrivateSchematics = true;
   readonly allowAdditionalArgs = true;
-  readonly packageManager = getPackageManager(this.workspace.root);
 
   async run(options: AddCommandSchema & Arguments) {
     if (!options.collection) {
@@ -55,7 +54,8 @@ export class AddCommand extends SchematicCommand<AddCommandSchema> {
       return this.executeSchematic(packageIdentifier.name, options['--']);
     }
 
-    const usingYarn = this.packageManager === 'yarn';
+    const packageManager = await getPackageManager(this.workspace.root);
+    const usingYarn = packageManager === 'yarn';
 
     if (packageIdentifier.type === 'tag' && !packageIdentifier.rawSpec) {
       // only package name provided; search for viable version
@@ -135,7 +135,7 @@ export class AddCommand extends SchematicCommand<AddCommandSchema> {
       }
     }
 
-    await npmInstall(packageIdentifier.raw, this.logger, this.packageManager, this.workspace.root);
+    await npmInstall(packageIdentifier.raw, this.logger, packageManager, this.workspace.root);
 
     return this.executeSchematic(collectionName, options['--']);
   }

packages/angular/cli/commands/config-impl.ts

@@ -28,7 +28,6 @@ import {
 } from '../utilities/config';
 import { Schema as ConfigCommandSchema, Value as ConfigCommandSchemaValue } from './config';
 
-
 function _validateBoolean(value: string) {
   if (('' + value).trim() === 'true') {
     return true;
@@ -71,8 +70,7 @@ function _validateAnalyticsSharingTracking(value: string) {
   return value;
 }
 
-
-const validCliPaths = new Map<string, ((arg: string) => JsonValue)>([
+const validCliPaths = new Map<string, (arg: string) => JsonValue>([
   ['cli.warnings.versionMismatch', _validateBoolean],
   ['cli.defaultCollection', _validateString],
   ['cli.packageManager', _validateString],
@@ -89,9 +87,9 @@ const validCliPaths = new Map<string, ((arg: string) => JsonValue)>([
  * @returns {(string|number)[]} The fragments for the string.
  * @private
  */
-function parseJsonPath(path: string): (string|number)[] {
+function parseJsonPath(path: string): (string | number)[] {
   const fragments = (path || '').split(/\./g);
-  const result: (string|number)[] = [];
+  const result: (string | number)[] = [];
 
   while (fragments.length > 0) {
     const fragment = fragments.shift();
@@ -109,7 +107,7 @@ function parseJsonPath(path: string): (string|number)[] {
       const indices = match[2]
         .slice(1, -1)
         .split('][')
-        .map(x => /^\d$/.test(x) ? +x : x.replace(/\"|\'/g, ''));
+        .map(x => (/^\d$/.test(x) ? +x : x.replace(/\"|\'/g, '')));
       result.push(...indices);
     }
   }
@@ -213,14 +211,12 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
       await this.validateScope(CommandScope.InProject);
     }
 
-    let config =
-      (getWorkspace(level) as {} as { _workspace: experimental.workspace.WorkspaceSchema });
+    let config = await getWorkspace(level);
 
     if (options.global && !config) {
       try {
         if (migrateLegacyGlobalConfig()) {
-          config =
-            (getWorkspace(level) as {} as { _workspace: experimental.workspace.WorkspaceSchema });
+          config = await getWorkspace(level);
           this.logger.info(tags.oneLine`
             We found a global configuration that was used in Angular CLI 1.
             It has been automatically migrated.`);
@@ -235,7 +231,10 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
         return 1;
       }
 
-      return this.get(config._workspace, options);
+      const workspace = ((config as {}) as { _workspace: experimental.workspace.WorkspaceSchema })
+        ._workspace;
+
+      return this.get(workspace, options);
     } else {
       return this.set(options);
     }
@@ -253,7 +252,7 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
         return 0;
       }
 
-      value = getValueFromPath(config as {} as JsonObject, options.jsonPath);
+      value = getValueFromPath((config as {}) as JsonObject, options.jsonPath);
     } else {
       value = config;
     }
@@ -271,7 +270,7 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
     return 0;
   }
 
-  private set(options: ConfigCommandSchema) {
+  private async set(options: ConfigCommandSchema) {
     if (!options.jsonPath || !options.jsonPath.trim()) {
       throw new Error('Invalid Path.');
     }
@@ -283,9 +282,11 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
       return 0;
     }
 
-    if (options.global
-        && !options.jsonPath.startsWith('schematics.')
-        && !validCliPaths.has(options.jsonPath)) {
+    if (
+      options.global &&
+      !options.jsonPath.startsWith('schematics.') &&
+      !validCliPaths.has(options.jsonPath)
+    ) {
       throw new Error('Invalid Path.');
     }
 
@@ -309,7 +310,7 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
     }
 
     try {
-      validateWorkspace(configValue);
+      await validateWorkspace(configValue);
     } catch (error) {
       this.logger.fatal(error.message);
 
@@ -321,5 +322,4 @@ export class ConfigCommand extends Command<ConfigCommandSchema> {
 
     return 0;
   }
-
 }

packages/angular/cli/commands/generate-impl.ts

@@ -17,7 +17,7 @@ export class GenerateCommand extends SchematicCommand<GenerateCommandSchema> {
 
   async initialize(options: GenerateCommandSchema & Arguments) {
     // Fill up the schematics property of the command description.
-    const [collectionName, schematicName] = this.parseSchematicInfo(options);
+    const [collectionName, schematicName] = await this.parseSchematicInfo(options);
     this.collectionName = collectionName;
     this.schematicName = schematicName;
 
@@ -45,7 +45,7 @@ export class GenerateCommand extends SchematicCommand<GenerateCommandSchema> {
         continue;
       }
 
-      if (this.getDefaultSchematicCollection() == collectionName) {
+      if ((await this.getDefaultSchematicCollection()) == collectionName) {
         subcommands[name] = subcommand;
       } else {
         subcommands[`${collectionName}:${name}`] = subcommand;
@@ -78,7 +78,7 @@ export class GenerateCommand extends SchematicCommand<GenerateCommandSchema> {
     paths: string[],
     options: GenerateCommandSchema & Arguments,
   ): Promise<void> {
-    const [collectionName, schematicName] = this.parseSchematicInfo(options);
+    const [collectionName, schematicName] = await this.parseSchematicInfo(options);
 
     if (!schematicName || !collectionName) {
       return;
@@ -91,8 +91,10 @@ export class GenerateCommand extends SchematicCommand<GenerateCommandSchema> {
     );
   }
 
-  private parseSchematicInfo(options: { schematic?: string }): [string, string | undefined] {
-    let collectionName = this.getDefaultSchematicCollection();
+  private async parseSchematicInfo(options: {
+    schematic?: string;
+  }): Promise<[string, string | undefined]> {
+    let collectionName = await this.getDefaultSchematicCollection();
 
     let schematicName = options.schematic;
 

packages/angular/cli/commands/new-impl.ts

@@ -20,7 +20,7 @@ export class NewCommand extends SchematicCommand<NewCommandSchema> {
     if (options.collection) {
       this.collectionName = options.collection;
     } else {
-      this.collectionName = this.parseCollectionName(options);
+      this.collectionName = await this.parseCollectionName(options);
     }
 
     return super.initialize(options);
@@ -43,7 +43,7 @@ export class NewCommand extends SchematicCommand<NewCommandSchema> {
     });
   }
 
-  private parseCollectionName(options: any): string {
+  private async parseCollectionName(options: any): Promise<string> {
     return options.collection || this.getDefaultSchematicCollection();
   }
 }

packages/angular/cli/commands/update-impl.ts

@@ -99,7 +99,7 @@ export class UpdateCommand extends SchematicCommand<UpdateCommandSchema> {
       }
     }
 
-    const packageManager = getPackageManager(this.workspace.root);
+    const packageManager = await getPackageManager(this.workspace.root);
     this.logger.info(`Using package manager: '${packageManager}'`);
 
     // Special handling for Angular CLI 1.x migrations

packages/angular/cli/lib/init.ts

@@ -77,76 +77,79 @@ if (process.env['NG_CLI_PROFILING']) {
   process.on('uncaughtException', () => exitHandler({ exit: true }));
 }
 
-let cli;
-try {
-  const projectLocalCli = require.resolve('@angular/cli', { paths: [process.cwd()] });
-
-  // This was run from a global, check local version.
-  const globalVersion = new SemVer(packageJson['version']);
-  let localVersion;
-  let shouldWarn = false;
-
+(async () => {
+  let cli;
   try {
-    localVersion = _fromPackageJson();
-    shouldWarn = localVersion != null && globalVersion.compare(localVersion) > 0;
-  } catch (e) {
-    // eslint-disable-next-line no-console
-    console.error(e);
-    shouldWarn = true;
-  }
+    const projectLocalCli = require.resolve('@angular/cli', { paths: [process.cwd()] });
 
-  if (shouldWarn && isWarningEnabled('versionMismatch')) {
-    const warning = colors.yellow(tags.stripIndents`
-    Your global Angular CLI version (${globalVersion}) is greater than your local
-    version (${localVersion}). The local Angular CLI version is used.
+    // This was run from a global, check local version.
+    const globalVersion = new SemVer(packageJson['version']);
+    let localVersion;
+    let shouldWarn = false;
 
-    To disable this warning use "ng config -g cli.warnings.versionMismatch false".
-    `);
-    // Don't show warning colorised on `ng completion`
-    if (process.argv[2] !== 'completion') {
-      // eslint-disable-next-line no-console
-      console.error(warning);
-    } else {
+    try {
+      localVersion = _fromPackageJson();
+      shouldWarn = localVersion != null && globalVersion.compare(localVersion) > 0;
+    } catch (e) {
       // eslint-disable-next-line no-console
-      console.error(warning);
-      process.exit(1);
+      console.error(e);
+      shouldWarn = true;
     }
-  }
 
-  // No error implies a projectLocalCli, which will load whatever
-  // version of ng-cli you have installed in a local package.json
-  cli = require(projectLocalCli);
-} catch {
-  // If there is an error, resolve could not find the ng-cli
-  // library from a package.json. Instead, include it from a relative
-  // path to this script file (which is likely a globally installed
-  // npm package). Most common cause for hitting this is `ng new`
-  cli = require('./cli');
-}
+    if (shouldWarn && await isWarningEnabled('versionMismatch')) {
+      const warning = colors.yellow(tags.stripIndents`
+      Your global Angular CLI version (${globalVersion}) is greater than your local
+      version (${localVersion}). The local Angular CLI version is used.
+
+      To disable this warning use "ng config -g cli.warnings.versionMismatch false".
+      `);
+      // Don't show warning colorised on `ng completion`
+      if (process.argv[2] !== 'completion') {
+        // eslint-disable-next-line no-console
+        console.error(warning);
+      } else {
+        // eslint-disable-next-line no-console
+        console.error(warning);
+        process.exit(1);
+      }
+    }
 
-if ('default' in cli) {
-  cli = cli['default'];
-}
+    // No error implies a projectLocalCli, which will load whatever
+    // version of ng-cli you have installed in a local package.json
+    cli = require(projectLocalCli);
+  } catch {
+    // If there is an error, resolve could not find the ng-cli
+    // library from a package.json. Instead, include it from a relative
+    // path to this script file (which is likely a globally installed
+    // npm package). Most common cause for hitting this is `ng new`
+    cli = require('./cli');
+  }
 
-// This is required to support 1.x local versions with a 6+ global
-let standardInput;
-try {
-  standardInput = process.stdin;
-} catch (e) {
-  delete process.stdin;
-  process.stdin = new Duplex();
-  standardInput = process.stdin;
-}
+  if ('default' in cli) {
+    cli = cli['default'];
+  }
 
-cli({
-  cliArgs: process.argv.slice(2),
-  inputStream: standardInput,
-  outputStream: process.stdout,
-})
-  .then((exitCode: number) => {
-    process.exit(exitCode);
-  })
-  .catch((err: Error) => {
-    console.error('Unknown error: ' + err.toString());
-    process.exit(127);
+  return cli;
+})().then(cli => {
+  // This is required to support 1.x local versions with a 6+ global
+  let standardInput;
+  try {
+    standardInput = process.stdin;
+  } catch (e) {
+    delete process.stdin;
+    process.stdin = new Duplex();
+    standardInput = process.stdin;
+  }
+
+  return cli({
+    cliArgs: process.argv.slice(2),
+    inputStream: standardInput,
+    outputStream: process.stdout,
   });
+}).then((exitCode: number) => {
+  process.exit(exitCode);
+})
+.catch((err: Error) => {
+  console.error('Unknown error: ' + err.toString());
+  process.exit(127);
+});