如何通过 Nest-commander 创建和使用终端命令？

Question

所以，我有这个 NestJS 项目，出于学习目的，我想使用Nest-commander创建一个可以在终端上执行的命令（这样我可以从其他服务调用函数），也出于学习目的，每当我调用它时命令，它应该调用服务文件上的函数，从数据库中获取用户。

它看起来像这样：

> run myCommand -username UsernameString

每当从终端调用该命令时，我都会调用getUser()fromAnotherService来查找具有特定 UsernameString 的用户。我阅读了文档，但无法理解其中的内容，所以......

1. 如何从终端调用命令？
2. 是否可以在应用程序中调用相同的命令？

Answer 1

基本上，如果我们举这个例子：

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

interface BasicCommandOptions {
  string?: string;
  boolean?: boolean;
  number?: number;
}

@Command({ name: 'basic', description: 'A parameter parse' })
export class BasicCommand extends CommandRunner {
  async run(
    passedParam: string[],
    options?: BasicCommandOptions,
  ): Promise<void> {
    if (options?.number) {
      this.runWithNumber(passedParam, options.number);
    } else if (options?.string) {
      this.runWithString(passedParam, options.string);
    } else {
      this.runWithNone(passedParam);
    }
  }

  @Option({
    flags: '-n, --number [number]',
    description: 'A basic number parser',
  })
  parseNumber(val: string): number {
    return Number(val);
  }

  @Option({
    flags: '-s, --string [string]',
    description: 'A string return',
  })
  parseString(val: string): string {
    return val;
  }

  @Option({
    flags: '-b, --boolean [boolean]',
    description: 'A boolean parser',
  })
  parseBoolean(val: string): boolean {
    return JSON.parse(val);
  }

  runWithString(param: string[], option: string): void {
    console.log({ param, string: option });
  }

  runWithNumber(param: string[], option: number): void {
    console.log({ param, number: option });
  }

  runWithNone(param: string[]): void {
    console.log({ param });
  }
}

@Module({
  providers: [BasicCommand],
})
export class AppModule {}

async function bootstrap() {
  await CommandFactory.run(AppModule);
}

bootstrap();

您可以使用该方法运行它：

ts-node ./test.ts basic -s test-value -n 1234

首先调用命令的名称，然后调用参数