open-index/open-npm huggingface dataset:
npm package: @nardy/build-setup
Description: 项目基础构建库
Author: Chen Jincan
Latest version: 3.0.3

# build-setup

项目基础构建库

<br/><br/>
> ## 使用方法:

#### 安装`@nardy/build-setup`模块后，在`package.json`中添加如下代码：

```json
{
    "scripts": {
      "dev": "build-setup --mode=development --format=cjs --rm=dist/* --base=./src/ --src=./src/**/*.ts",
      "dev:bundle": "build-setup --format=cjs --mode=development --rm=dist/* --bundle --src=./src/main.ts",
      "build": "build-setup --format=cjs --rm=dist/* --base=./src/ --src=./src/**/*.ts",
      "build:bundle": "build-setup --format=cjs --rm=dist/* --bundle --src=./src/main.ts",
      "test": "build-setup --mode=test --src=tests/**/*.spec.ts"
  }
}
```
<br/><br/>
> ## 命令行参数：

|参数名称|类型|描述|
|---|---|---|
|--rm|boolean\|string|是否删除指定的文件(夹),默认为`false`, 支持`glob pattern`, 参考：[rimraf](https://www.npmjs.com/package/rimraf)|
|--bundle|boolean|是否打包成单一文件。当`--format=esm`时，此参数无效，默认为`false`|
|--format|string|构建格式。可选为: `cjs`，`esm`。默认为：`cjs`|
|--outdir|string|打包输出目录，默认为`dist`|
|--src|string|输入源，支持`glob pattern`，默认值为`src/**/*`|
|--mode|string|指定打包环境。支持：`development`, `production`, `test`, 默认为`production`|
|--entry|string|可选，指定打包后执行的文件入口，默认使用`package.json`顶层配置中的`entry`字段配置，未配置时，默认值为：`${outdir}/index.js`，仅`mode=development`时有效|

> 注：当`--format=esm`时，必须在`package.json`顶层配置中配置好`type`字段