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

/**
 * @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 { Arguments, SubCommandDescription } from '../models/interface';
import { SchematicCommand } from '../models/schematic-command';
import { colors } from '../utilities/color';
import { parseJsonSchemaToSubCommandDescription } from '../utilities/json-schema';
import { Schema as GenerateCommandSchema } from './generate';

export class GenerateCommand extends SchematicCommand<GenerateCommandSchema> {
  // Allows us to resolve aliases before reporting analytics
  longSchematicName: string | undefined;

  override async initialize(options: GenerateCommandSchema & Arguments) {
    // Fill up the schematics property of the command description.
    const [collectionName, schematicName] = await this.parseSchematicInfo(options);
    this.collectionName = collectionName;
    this.schematicName = schematicName;

    await super.initialize(options);

    const collection = this.getCollection(collectionName);
    const subcommands: { [name: string]: SubCommandDescription } = {};

    const schematicNames = schematicName ? [schematicName] : collection.listSchematicNames();
    // Sort as a courtesy for the user.
    schematicNames.sort();

    for (const name of schematicNames) {
      const schematic = this.getSchematic(collection, name, true);
      this.longSchematicName = schematic.description.name;
      let subcommand: SubCommandDescription;
      if (schematic.description.schemaJson) {
        subcommand = await parseJsonSchemaToSubCommandDescription(
          name,
          schematic.description.path,
          this._workflow.registry,
          schematic.description.schemaJson,
        );
      } else {
        continue;
      }

      if ((await this.getDefaultSchematicCollection()) == collectionName) {
        subcommands[name] = subcommand;
      } else {
        subcommands[`${collectionName}:${name}`] = subcommand;
      }
    }

    this.description.options.forEach((option) => {
      if (option.name == 'schematic') {
        option.subcommands = subcommands;
      }
    });
  }

  public async run(options: GenerateCommandSchema & Arguments) {
    if (!this.schematicName || !this.collectionName) {
      return this.printHelp();
    }

    return this.runSchematic({
      collectionName: this.collectionName,
      schematicName: this.schematicName,
      schematicOptions: options['--'] || [],
      debug: !!options.debug || false,
      dryRun: !!options.dryRun || false,
      force: !!options.force || false,
    });
  }

  override async reportAnalytics(
    paths: string[],
    options: GenerateCommandSchema & Arguments,
  ): Promise<void> {
    if (!this.collectionName || !this.schematicName) {
      return;
    }
    const escapedSchematicName = (this.longSchematicName || this.schematicName).replace(/\//g, '_');

    return super.reportAnalytics(
      ['generate', this.collectionName.replace(/\//g, '_'), escapedSchematicName],
      options,
    );
  }

  private async parseSchematicInfo(
    options: GenerateCommandSchema,
  ): Promise<[string, string | undefined]> {
    let collectionName = await this.getDefaultSchematicCollection();

    let schematicName = options.schematic;

    if (schematicName && schematicName.includes(':')) {
      [collectionName, schematicName] = schematicName.split(':', 2);
    }

    return [collectionName, schematicName];
  }

  public override async printHelp() {
    await super.printHelp();

    this.logger.info('');
    // Find the generate subcommand.
    const subcommand = this.description.options.filter((x) => x.subcommands)[0];
    if (Object.keys((subcommand && subcommand.subcommands) || {}).length == 1) {
      this.logger.info(`\nTo see help for a schematic run:`);
      this.logger.info(colors.cyan(`  ng generate <schematic> --help`));
    }

    return 0;
  }
}