Nest Commander 시도

개시하다

독자 대상

Nest Commander란

작업 환경

라이브러리 작업

작업 방침

샘플 코드

import { Logger } from '@nestjs/common';
import { CommandRunner, Command, Option } from 'nest-commander';

/** コマンドライン引数で渡す変数の型管理 */
type CommandOptions = {
  id?: number;
};

@Command({
  // コマンドライン引数で`sample1`を指定することで起動可能
  name: 'sample1',
  // isDefault=true: コマンドライン引数を指定しない場合に起動できる。アプリケーション内で1つのみ指定可能
  options: { isDefault: true },
})
export class Sample1Command implements CommandRunner {
  /** 
   * --idの数字変換処理
   * --id=数字を指定するとrunのoptions.idに値が設定される
   */
  @Option({
    flags: '--id [number]',
  })
  parseId(value: string): number {
    return Number(value);
  }

  /**
   * @Command.nameで呼び出された時に実行される処理
   */
  async run(passedParams: string[], options?: CommandOptions): Promise<void> {
    Logger.log({ passedParams, options }, Sample1Command.name);
    return Promise.resolve();
  }
}

import { Logger } from '@nestjs/common';
import { CommandRunner, Command } from 'nest-commander';

@Command({
  name: 'sample2',
})
export class Sample2Command implements CommandRunner {
  /**
   * @Command.nameで呼び出された時に実行される処理
   */
  async run(passedParams: string[], options?: Record<string, unknown>): Promise<void> {
    Logger.log({ passedParams, options }, Sample2Command.name);
    return Promise.resolve();
  }
}

import { Module } from '@nestjs/common';
import { Sample1Command } from './sample1.command';
import { Sample2Command } from './sample2.command';

@Module({
  imports: [],
  // Sample1Command, Sample2Commandを指定する
  providers: [Sample1Command, Sample2Command],
})
export class AppModule {}

import { CommandFactory } from 'nest-commander';
import { AppModule } from './app.module';

async function bootstrap() {
  // nest-commanderのCommandFactoryにAppModuleを指定する
  // 出力されるログレベルを指定する（標準だとログ出力されないため）
  await CommandFactory.run(AppModule, ['warn', 'error', 'debug', 'log']);
}
bootstrap();

동작 확인

# Sample1Command実行(デフォルトCommand)
node dist/main --id=123 
node dist/main sample1 --id=123

# Sample2Command実行
node dist/main sample2

소스 코드 세트

끝말

참조 링크