@hz-9/heft-node-rig

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

介绍

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

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

• default：一个通用配置，导出 CommonJS (CJS) 和 ES 模块 (ESM)。
• tool：一个用于命令行工具的配置，导出 CommonJS (CJS)。

安装

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

关于 @hz-9/heft-node-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-node-rig",
     /**
      * （可选）从 rig 包中选择一个配置文件。名称必须由小写字母和数字单词组成，单词之间用连字符分隔，例如 "sample-profile"。
      * 如果省略，则将使用 "default" 配置文件。"
      */
     "rigProfile": "tool"
   }
   
   

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

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

3. 添加到 config/tsconfig.json：

   {
     "extends": "./node_modules/@hz-9/heft-node-rig/profiles/tool/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