Go契约性能测试体系：NestJS参数配置与性能优化 - 第2节

2.1 NestJS CLI 安装与使用

NestJS CLI 是项目初始化的核心工具，提供从脚手架搭建到代码生成的完整工作流。本节覆盖 CLI 的安装、常用命令及项目结构解析。

2.1.1 全局安装与版本验证

使用 npm 全局安装 NestJS CLI：

npm install -g @nestjs/cli

安装完成后验证版本：

nest --version

输出示例：

10.3.2

2.1.2 常用命令速查

2.2 项目结构解析

执行 nest new nest-demo 后生成的标准项目结构如下：

nest-demo/
├── src/
│   ├── app.controller.spec.ts
│   ├── app.controller.ts
│   ├── app.module.ts
│   ├── app.service.ts
│   └── main.ts
├── test/
│   ├── app.e2e-spec.ts
│   └── jest-e2e.json
├── node_modules/
├── .eslintrc.js
├── .prettierrc
├── nest-cli.json
├── package.json
├── tsconfig.build.json
├── tsconfig.json
└── README.md

2.2.1 核心文件职责

2.3 nest generate 命令详解

nest generate（简写 nest g）是日常开发中使用频率最高的命令，支持生成多种代码构件。

2.3.1 生成语法

nest generate <schematic> <name> [options]

常用 schematic 类型：

2.3.2 常用选项

2.3.3 生成完整 CRUD 资源

nest g resource 是最强大的生成命令，一次性创建模块、控制器、服务、DTO、实体文件及 REST 或 GraphQL 模板：

nest g resource user

? What transport layer do you use? REST API
? Would you like to generate CRUD entry points? Yes

执行后生成的文件结构：

src/user/
├── dto/
│   ├── create-user.dto.ts
│   └── update-user.dto.ts
├── entities/
│   └── user.entity.ts
├── user.controller.spec.ts
├── user.controller.ts
├── user.module.ts
├── user.service.spec.ts
└── user.service.ts

2.4 自定义 CLI 配置

nest-cli.json 是 CLI 行为的配置文件，位于项目根目录。通过修改该文件可以控制生成代码的默认行为、编译选项和项目元数据。

2.4.1 默认配置结构

{
  "$schema": "https://json.schemastore.org/nest-cli",
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "deleteOutDir": true,
    "webpack": false,
    "tsConfigPath": "tsconfig.build.json"
  }
}

2.4.2 常用配置项

2.4.3 自定义生成行为示例

以下配置关闭所有测试文件生成，并启用扁平目录结构：

{
  "$schema": "https://json.schemastore.org/nest-cli",
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "deleteOutDir": true
  },
  "generateOptions": {
    "spec": false,
    "flat": true
  }
}

2.5 CLI 工作流与项目初始化流程

下图展示了从 CLI 安装到项目启动的完整工作流：

2.6 项目初始化最佳实践

1. 版本锁定： 在 package.json 中锁定 @nestjs/cli 版本，避免团队间环境不一致。
2. 自定义模板： 通过修改 nest-cli.json 的 generateOptions 统一团队代码风格。
3. 资源生成优先： 使用 nest g resource 替代手动创建模块/控制器/服务，减少遗漏。
4. 测试文件策略： 在 CI 环境中开启 --no-spec 加速生成，开发阶段保留测试文件。
5. 目录结构规范： 按功能域划分模块目录，避免将所有代码放在 src 根目录。