convert command to typescript

Author: mshima

src/cli/index.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import process from 'node:process';
-import YeomanCommand from '../util/command.js';
+import YeomanCommand, { addEnvironmentOptions } from '../util/command.js';
 import packageJson from '../package.json';
 import Env from '../index.js';
 import { printGroupedGenerator, environmentAction } from './utils.js';
@@ -9,10 +9,11 @@ const program = new YeomanCommand();
 
 program.version(packageJson.version).allowExcessArguments(false).enablePositionalOptions();
 
-Env.addEnvironmentOptions(
+addEnvironmentOptions(
   program
     .command('run <namespace>')
-    .description('Run a generator', { namespace: 'Generator to run' })
+    .description('Run a generator')
+    .argument('<namespace>', 'Generator to run')
     .passThroughOptions()
     .allowUnknownOption()
     .allowExcessArguments(true)

src/command.js

@@ -1,58 +1,18 @@
 import { requireNamespace } from '@yeoman/namespace';
 import createdLogger from 'debug';
-import { Option } from 'commander';
 import YeomanCommand from './util/command.js';
 
 const debug = createdLogger('yeoman:environment:command');
 
 const commandMixin = cls =>
   class EnvironmentCommand extends cls {
-    static addEnvironmentOptions(command = new YeomanCommand()) {
-      /* Environment options */
-      return (
-        command
-          .option('--cwd', 'Path to use as current dir')
-          /* Environment/Legacy generator options */
-          .option('--skip-install', 'Do not automatically install dependencies', false)
-          /* Generator options */
-          .option('--skip-cache', 'Do not remember prompt answers', false)
-          .option('--local-config-only', 'Generate .yo-rc-global.json locally', false)
-          .option('--ask-answered', 'Show prompts for already configured options', false)
-          /* Conflicter options */
-          .option('--force', 'Override every file', false)
-          .option('--dry-run', 'Print conflicts', false)
-          .option('--whitespace', 'Whitespace changes will not trigger conflicts', false)
-          .option('--bail', 'Fail on first conflict', false)
-          .option('--skip-yo-resolve', 'Ignore .yo-resolve files', false)
-          /* Hidden options, used for api */
-          .addOption(new Option('--skip-local-cache', 'Skip local answers cache').default(true).hideHelp())
-          .addOption(new Option('--skip-parse-options', 'Skip legacy options parsing').default(false).hideHelp())
-          .addOption(new Option('--experimental', 'Experimental features').default(false).hideHelp())
-          .addOption(new Option('--log-cwd', 'Path for log purpose').hideHelp())
-      );
-    }
-
-    /**
-     * Load Generator options into a commander instance.
-     *
-     * @param {Command} command - Command to load options
-     * @param {Generator} generator - Generator
-     * @return {Command} return command
-     */
-    static addGeneratorOptions(command, generator) {
-      command.addGeneratorOptions(generator._options);
-      command.addGeneratorArguments(generator._arguments);
-      return command;
-    }
-
     /**
      * Generate a command for the generator and execute.
      *
      * @param {string} generatorNamespace
      * @param {string[]} args
      */
     async execute(generatorNamespace, args = []) {
-      const env = this;
       const namespace = requireNamespace(generatorNamespace);
       if (!this.get(namespace.namespace)) {
         await this.lookup({
@@ -72,11 +32,11 @@ const commandMixin = cls =>
 
       // Instantiate the generator for options
       const generator = await this.create(namespace.namespace, { help: true });
-      EnvironmentCommand.addGeneratorOptions(namespaceCommand, generator);
+      namespaceCommand.registerGenerator(generator);
 
       namespaceCommand._parseCommand([], args);
       debug('Running generator with arguments %o, options %o', namespaceCommand.args, namespaceCommand.opts());
-      return env.run([namespace.namespace, ...namespaceCommand.args], {
+      return this.run([namespace.namespace, ...namespaceCommand.args], {
         ...namespaceCommand.opts(),
       });
     }

src/environment.js

@@ -26,7 +26,7 @@ import Store from './store.js';
 import composability from './composability.js';
 import resolver from './resolver.js';
 import YeomanRepository from './util/repository.js';
-import YeomanCommand from './util/command.js';
+import YeomanCommand, { addEnvironmentOptions } from './util/command.js';
 import commandMixin from './command.js';
 import { packageManagerInstallTask } from './package-manager.js';
 import { ComposedStore } from './composed-store.js';
@@ -138,7 +138,7 @@ class Environment extends Base {
    * @return {Command} Return a Command instance
    */
   static prepareCommand(GeneratorClass, command = new YeomanCommand()) {
-    command = Base.addEnvironmentOptions(command);
+    command = addEnvironmentOptions(command);
     return Environment.prepareGeneratorCommand(command, GeneratorClass);
   }
 
@@ -151,7 +151,7 @@ class Environment extends Base {
    */
   static prepareGeneratorCommand(command, GeneratorClass, namespace) {
     const generator = new GeneratorClass([], { help: true, env: {} });
-    Base.addGeneratorOptions(command, generator);
+    command.registerGenerator(generator);
 
     command.action(async function () {
       let rootCommand = this;

src/util/command.js src/util/command.ts

@@ -1,7 +1,8 @@
+import { BaseGenerator } from '@yeoman/types';
 import { Command, Option } from 'commander';
 
 export default class YeomanCommand extends Command {
-  createCommand(name) {
+  override createCommand(name?: string) {
     return new YeomanCommand(name);
   }
 
@@ -10,7 +11,7 @@ export default class YeomanCommand extends Command {
    * @param {Option} option
    * @return {YeomanCommand} this;
    */
-  addOption(option) {
+  addOption(option: Option) {
     if (!option.long || option.required || option.optional) {
       return super.addOption(option);
     }
@@ -30,12 +31,22 @@ export default class YeomanCommand extends Command {
     return result;
   }
 
+  /**
+   * Load Generator options into a commander instance.
+   *
+   * @param {Generator} generator - Generator
+   * @return {Command} return command
+   */
+  registerGenerator(generator: any) {
+    return this.addGeneratorOptions(generator._options).addGeneratorArguments(generator._arguments);
+  }
+
   /**
    * Register arguments using generator._arguments structure.
    * @param {object[]} generatorArgs
    * @return {YeomanCommand} this;
    */
-  addGeneratorArguments(generatorArgs = []) {
+  addGeneratorArguments(generatorArgs: any[] = []) {
     if (!generatorArgs || generatorArgs.length === 0) {
       return this;
     }
@@ -56,7 +67,7 @@ export default class YeomanCommand extends Command {
    * @param {string} blueprintOptionDescription - description of the blueprint that adds the option
    * @return {YeomanCommand} this;
    */
-  addGeneratorOptions(options) {
+  addGeneratorOptions(options: Record<string, any>) {
     options = options || {};
     for (const [key, value] of Object.entries(options)) {
       this._addGeneratorOption(key, value);
@@ -65,14 +76,14 @@ export default class YeomanCommand extends Command {
     return this;
   }
 
-  _addGeneratorOption(optionName, optionDefinition, additionalDescription = '') {
+  _addGeneratorOption(optionName: string, optionDefinition: any, additionalDescription = '') {
     if (optionName === 'help') {
       return undefined;
     }
 
     const longOption = `--${optionName}`;
-    const existingOption = this._findOption(longOption);
-    if (this._findOption(longOption)) {
+    const existingOption = (this as any)._findOption(longOption);
+    if ((this as any)._findOption(longOption)) {
       return existingOption;
     }
 
@@ -89,9 +100,31 @@ export default class YeomanCommand extends Command {
     }
 
     return this.addOption(
-      new Option(cmdString, optionDefinition.description + additionalDescription)
+      new Option(cmdString, `${optionDefinition.description}${additionalDescription}`)
         .default(optionDefinition.default)
         .hideHelp(optionDefinition.hide),
     );
   }
 }
+
+/* Add Environment options */
+export const addEnvironmentOptions = (command = new YeomanCommand()) =>
+  command
+    .option('--cwd', 'Path to use as current dir')
+    /* Environment options */
+    .option('--skip-install', 'Do not automatically install dependencies', false)
+    /* Generator options */
+    .option('--skip-cache', 'Do not remember prompt answers', false)
+    .option('--local-config-only', 'Generate .yo-rc-global.json locally', false)
+    .option('--ask-answered', 'Show prompts for already configured options', false)
+    /* Conflicter options */
+    .option('--force', 'Override every file', false)
+    .option('--dry-run', 'Print conflicts', false)
+    .option('--whitespace', 'Whitespace changes will not trigger conflicts', false)
+    .option('--bail', 'Fail on first conflict', false)
+    .option('--skip-yo-resolve', 'Ignore .yo-resolve files', false)
+    /* Hidden options, used for api */
+    .addOption(new Option('--skip-local-cache', 'Skip local answers cache').default(true).hideHelp())
+    .addOption(new Option('--skip-parse-options', 'Skip legacy options parsing').default(false).hideHelp())
+    .addOption(new Option('--experimental', 'Experimental features').default(false).hideHelp())
+    .addOption(new Option('--log-cwd', 'Path for log purpose').hideHelp());