# @contrast/config 中文文档

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

版本：1\.66\.0
npm 元数据更新时间：2026-10-29T19:45:09.253Z
中文译文更新时间：2026-11-10T17:14:09.743Z
软件包许可：SEE LICENSE IN LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/%40contrast/config
原文对照：https://npmcn.com/package/%40contrast/config/?lang=original

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

- 包体积（解压后）：68.1 kB，9 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.9\.0
- 运行依赖：4 个
- 首次发布：2022-06-16T12:51:07.223Z
- 最新版本发布：2026-10-29T19:45:09.039Z
- 近 30 天下载量：17594（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：99（近 12 个月 18 个）

## 中文简介

用于发现对比剂配置数据的 API

## 安装

```sh
npm install @contrast/config
```

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

## README

# `@contrast/config`

发现并解析 Contrast 节点.js 代理配置 `contrast_security.yaml`, (中文(简体) ), `CONTRAST__*` 环境变量和设置 对比的UI.

## 使用量

`@contrast/agentify` 将配置成核心 `core.config`。 。 。 .

```javascript
// resolved values, as a nested object
if (core.config.protect.enable) { /* ... */ }

// a single option by its canonical name, and where its value came from
core.config.getEffectiveValue('assess.enable');
core.config.getEffectiveSource('assess.enable'); // e.g. 'ENVIRONMENT_VARIABLE'

// the effective options grouped by source, credentials redacted
core.config.getReport({ redact: true });
```

每个选项及其默认和描述在 `lib/options.js`。 。 。 .

## 优先发言

对于每个选项,一个环境变量会击败 YAML 文件, 文件击败 默认。 来自对比度 UI 的设置只覆盖尚存的选项 默认值( 或已经由 UI 设置) , 因此本地值总是获胜 .

环境变量名称为 `CONTRAST__` 加上大写中的选项名称, 与 `.` 改为 `__`。例如, `agent.node.app_root` 变成 `CONTRAST__AGENT__NODE__APP_ROOT`。 。 。 .

## 配置文件

`contrast_security.yaml` 上三层,第一层 包含文件的级别 :

1.  当前的工作目录
2.  `/etc/contrast/node/`,则 `/etc/contrast/` (关于视窗, `%ProgramData%\contrast\node\`,则 `%ProgramData%\contrast\`(中文(简体) )
3.  `~/.config/contrast/node/`,则 `~/.config/contrast/`

在该等级中找到的所有文件都合并 `node/` 文件在其中获胜 重叠。 文件包含 `root: true` 用于自行使用并结束搜索.

`CONTRAST_CONFIG_PATH` 以单一文件取代搜索。 设为 无效设备( e)`/dev/null`,或 `\\.\nul` 在Windows上)跳过文件配置 完全没有.

要查看应用程序的有效配置, 请运行 `npx -p @contrast/cli config-diagnostics <entrypoint>` 从它的目录.

## 常见问题

### @contrast/config 是什么？

用于发现对比剂配置数据的 API

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

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

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

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

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

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

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

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

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

@contrast/config 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

最新版本 1\.66\.0 发布于 2026/10/30（11 天前）；至今共发布 99 个版本，其中过去 12 个月发布了 18 个；首次发布于 2022/06/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。