@boost/config

中文文档
5.0.0发布于 2024/03/01MITTypeScriptES Module近 30 天下载 9499

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

中文使用文档
文档目录3 节
  1. 特征
  2. 安装
  3. 文档

配置 - 脚

build status npm version

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

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

文档

版本与发布记录

@boost/config 共发布 39 个版本,首次发布于 2020/06/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.0.0latest2024/03/012 年前
5.0.0-alpha.2next2024/02/272 年前
5.0.0-alpha.12024/02/122 年前
4.0.12023/05/023 年前
4.0.02022/08/194 年前
4.0.0-alpha.12022/05/034 年前

关于 @boost/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 和提交记录判断。