@hz-9/heft-nest-rig

一个用于构建使用 Heft 构建系统的 Nest.js 项目的 rig 包。要了解更多关于 rig 包的信息，请参阅 @rushstack/rig-package 文档。

介绍

@hz-9/heft-nest-rig 是一个 rig 包。因此，项目必须已经使用了 Heft。

@hz-9/heft-nest-rig提供了两种配置文件。

• library：一个为 Nest.js 组件库准备的配置，目前用于 @hz-9/a4-* 系列仓库，导出CommonJS (CJS)。
• service：一个为 Nest.js 服务准备的配置，导出CommonJS (CJS)。

安装

npm install @hz-9/heft-nest-rig --save-dev

关于 @hz-9/heft-nest-rig 的 PeerDependencies 信息，请 查看.

使用方法

1. 添加文件 config/rig.json:

   // "rig.json"文件指导工具在外部包中查找它们的配置文件。
   // 此系统的文档：https://www.npmjs.com/package/@rushstack/rig-package
   {
     "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
     /**
      * （必需）要继承的rig包的名称。
      * 它应该是一个带有"-rig"后缀的NPM包名。
      */
     "rigPackageName": "@hz-9/heft-nest-rig",
     /**
      * （可选）从rig包中选择一个配置文件。名称必须由小写字母数字单词组成，单词之间用连字符分隔，例如"sample-profile"。
      * 如果省略，则将使用"default"配置文件。"
      */
     "rigProfile": "service"
   }
   
   

2. 添加文件 config/jest.config.json:

   {
     "extends": "@hz-9/heft-nest-rig/profiles/service/config/jest.config.json"
   }
   
   

3. 添加到 config/tsconfig.json:

   {
     "extends": "./node_modules/@hz-9/heft-nest-rig/profiles/service/tsconfig.json",
     "compilerOptions": {
       // ...
     }
   }
   
   

4. 添加到 package.json:

   {
     "scripts": {
       // ...
   
       "build": "heft test --clean",
       "test": "heft test --clean",
       "test:watch": "heft test-watch --clean"
     }
   }
   

5. 现在，你可以运行:

   npm run build