You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
pac-auth/docs/nestcli.md

2.7 KiB

这个输出是 NestJS CLI (nest-cli) 的帮助命令 nest g -hnest generate -h 的结果,它解释了如何使用 nest generate 或其简写 nest g 命令来生成 NestJS 应用程序的不同部分。以下是命令和选项的详细解释:

命令用法

nest generate|g [options] <schematic> [name] [path]
  • nest generatenest g:这是用来生成新元素的命令。
  • [options]:可选的命令行选项。
  • <schematic>:要生成的元素类型,例如 controllerservice 等。
  • [name]:新生成元素的名称。
  • [path]:指定一个路径,在该路径下生成元素(如果未指定,则在项目根目录生成)。

可用的 Schematics

列表显示了所有可用的 schematics(即元素类型),它们是:

  • applicationapplication生成一个新的应用程序工作区。
  • classcl生成一个新的类。
  • configurationconfig生成一个 CLI 配置文件。
  • controllerco生成一个控制器声明。
  • decoratord生成一个自定义装饰器。
  • filterf生成一个异常过滤器声明。
  • gatewayga生成一个网关声明(用于 NestJS 微服务)。
  • guardgu生成一个守卫声明。
  • interceptoritc生成一个拦截器声明。
  • interfaceitf生成一个接口。
  • librarylib在 monorepo(单一代码库)中生成一个新的库。
  • middlewaremi生成一个中间件声明。
  • modulemo生成一个模块声明。
  • pipepi生成一个管道声明。
  • providerpr生成一个服务提供者声明。
  • resolverr生成一个 GraphQL 解析器声明。
  • resourceres生成一个新的 CRUD 资源。
  • services生成一个服务声明。
  • sub-appapp在 monorepo 中生成一个新的应用程序。

选项

  • --dry-run-d:模拟操作,报告将要执行的动作,但不会实际写入任何结果。
  • --project [project]-p:指定在哪个项目中生成文件。
  • --flat:强制生成的元素结构为扁平化,即不创建额外的目录。
  • --no-flat:确保为生成的元素创建目录。
  • --spec:强制生成相应的测试文件(spec 文件),这是默认行为。
  • --spec-file-suffix [suffix]:为测试文件使用自定义的后缀。
  • --skip-import:跳过导入步骤。
  • --no-spec:禁用生成测试文件。
  • --collection [collectionName]-c:使用指定的 schematics 集合。

帮助选项

  • --help-h:输出命令的使用信息。

通过这些命令和选项,你可以快速生成 NestJS 应用程序的骨架代码,从而加速开发过程。