# @boost/config 中文文档

规范地址：https://npmcn.com/package/%40boost/config/

版本：5\.0\.0
npm 元数据更新时间：2024-03-01T06:45:56.667Z
中文译文更新时间：2026-11-08T11:22:10.748Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40boost/config
原文对照：https://npmcn.com/package/%40boost/config/?lang=original
项目主页：https://github.com/milesj/boost#readme
源码仓库：https://github.com/milesj/boost

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：151 kB，124 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.12\.0
- 运行依赖：6 个
- 首次发布：2020-06-21T01:15:47.308Z
- 最新版本发布：2024-03-01T06:45:56.227Z
- 近 30 天下载量：9499（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 0 个）

## 中文简介

强大的基于会话的查找器,加载器,以及两个配置和忽略文件的管理器.

## 安装

```sh
npm install @boost/config
```

也可以使用：`pnpm add @boost/config`、`yarn add @boost/config`、`bun add @boost/config`

## README

# 配置 - 脚

![build status](https://img.shields.io/github/actions/workflow/status/milesj/boost/build.yml) ![npm version](https://img.shields.io/npm/v/@boost/config)

强大的基于会话的查找器,加载器,以及两个配置和忽略文件的管理器.

```ts
import { Blueprint, Schemas } from '@boost/common';
import { Configuration } from '@boost/config';

interface ConfigFile {
  debug: boolean;
  sourceMaps: boolean;
}

class ConfigManager extends Configuration<ConfigFile> {
  blueprint({ bool }: Schemas): Blueprint<ConfigFile> {
    return {
      debug: bool(),
      sourceMaps: bool(),
    };
  }
}

const configManager = new ConfigManager('boost');

// Load `.config/boost.js`, `boost.production.json`, `.boost.yaml`, etc
const { config } = await configManager.loadConfigFromRoot('.');

// Load `.boostignore` files
const ignore = await configManager.loadIgnoreFromBranchToRoot('./some/deep/path');
```

## 特征

-   装入根配置( R)`.config/<name>.js`)和分支配置(`.<name>.js`) (中文(简体) ).
-   装入忽略文件( E)`.<name>ignore`) (中文(简体) ).
-   支持多个配置类型 : `js`, (中文(简体) ), `cjs`, (中文(简体) ), `mjs`, (中文(简体) ), `json`, (中文(简体) ), `yaml`
-   支持基于环境和根级的覆盖.
-   支持从其他配置文件扩展 .
-   翻转树时在每个分支文件夹中查找文件 .
-   Caches finder 提高了效率.
-   自定义密钥值设置处理器 .

## 安装

```
yarn add @boost/config
```

## 文档

-   [https://boostlib.dev/docs/config 互联网档案馆的存檔,存档日期2013-12-11](https://boostlib.dev/docs/config)
-   [https://boostlib.dev/api/config 互联网档案馆的存檔,存档日期2013-12-02](https://boostlib.dev/api/config)

## 常见问题

### @boost/config 是什么？

强大的基于会话的查找器,加载器,以及两个配置和忽略文件的管理器\.

### 如何安装 @boost/config？

在项目目录运行 npm install @boost/config，或使用 pnpm add / yarn add / bun add。

### @boost/config 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @boost/config 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @boost/config 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.12\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @boost/config 可以商用吗？

@boost/config 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @boost/config 的下载量有多少？

根据 npm 官方下载统计，@boost/config 在 2026/10/09 – 2026/11/07 这 30 天内被下载 9,499 次，日均约 317 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @boost/config 还在维护吗？

最新版本 5\.0\.0 发布于 2024/03/01（2 年前）；至今共发布 39 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/06/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。