# @bugron/validate-dependabot-yaml 中文文档

规范地址：https://npmcn.com/package/%40bugron/validate-dependabot-yaml/

版本：0\.3\.4
npm 元数据更新时间：2026-11-07T09:56:29.155Z
中文译文更新时间：2026-11-09T19:36:56.640Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bugron/validate-dependabot-yaml
原文对照：https://npmcn.com/package/%40bugron/validate-dependabot-yaml/?lang=original
项目主页：https://github.com/bugron/validate-dependabot-cli#readme
源码仓库：https://github.com/bugron/validate-dependabot-cli

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

- 包体积（解压后）：299 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：3 个
- 首次发布：2024-09-01T02:42:16.776Z
- 最新版本发布：2026-11-07T09:56:28.583Z
- 近 30 天下载量：1778（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 3 个）

## 中文简介

验证 Dependabot v2 YAML 配置文件的 CLI

## 安装

```sh
npm install @bugron/validate-dependabot-yaml
```

也可以使用：`pnpm add @bugron/validate-dependabot-yaml`、`yarn add @bugron/validate-dependabot-yaml`、`bun add @bugron/validate-dependabot-yaml`

## README

此 CLI 对捆绑的拷贝进行测试 [官方 v2 JSON 计划](https://json.schemastore.org/dependabot-2.0.json)。它不检测所有无效的依赖文件,因为依赖文件在 JSON 计划之外还有额外的验证.

除了对 Disableabot 配置文件进行比对外,该工具还执行以下验证:

-   目录/目录值必须是独一无二的,不能与具有相同生态系统和目标分支的区块中的目录或目录条目相重叠. [文档](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#directory)
-   确保依赖型选项与支持的一揽子生态系统使用. [文档](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#dependency-type-groups)
-   确保与支持的一揽子生态系统一起使用冷却主要天数、小天数、平板天数选项 [文档](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#configuration-of-cooldown)

## 为什么?

如果您在编辑您的配置时得到一个验证错误, 在下一个依赖运行之前, 您不会知道是否有问题 . 而如果周期长而警报没有设定,则可能更后被检测出. 这个CLI允许您在进行tourbot.yml之前找到一些问题.

## 使用量

```
$ npx @bugron/validate-dependabot-yaml@latest --help

  CLI for validating Dependabot v2 YAML configuration files

  Usage
    $ npx @bugron/validate-dependabot-yaml [path]

  [path]
    Optional path to dependabot configuration file relative to current working directory (default: .github/dependabot.yml)

  Options
    --format, -f    Logger type, either json or markdown (default: markdown)
    --pretty, -p    Only used for json logger, prettifies JSON output

  Output
    Success: process exits with status 0, no output is logged
    Failure: process exits with status 1, JSON or Markdown formatted validation error messages are logged

  Examples
    $ npx @bugron/validate-dependabot-yaml
    $ npx @bugron/validate-dependabot-yaml config/dependabot.yaml
    $ npx @bugron/validate-dependabot-yaml .github/dependabot.yml --f=json --p
    $ npx @bugron/validate-dependabot-yaml .github/dependabot.yml --format=json --pretty
    $ npx @bugron/validate-dependabot-yaml .github/dependabot.yml --f=markdown
    $ npx @bugron/validate-dependabot-yaml .github/dependabot.yml --format=markdown
```

## 测试覆盖率

几乎所有案例/实例都测试了验证逻辑 [正式文件](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file) 还有更多.

## 有什么问题吗?

随意报出问题

## 常见问题

### @bugron/validate-dependabot-yaml 是什么？

验证 Dependabot v2 YAML 配置文件的 CLI

### 如何安装 @bugron/validate-dependabot-yaml？

在项目目录运行 npm install @bugron/validate-dependabot-yaml，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 validate-dependabot-yaml，可以用 npx validate-dependabot-yaml 直接运行。

### @bugron/validate-dependabot-yaml 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bugron\_\_validate-dependabot-yaml 是否存在。

### @bugron/validate-dependabot-yaml 支持 ESM 还是 CommonJS？

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

### @bugron/validate-dependabot-yaml 需要什么版本的 Node\.js？

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

### @bugron/validate-dependabot-yaml 可以商用吗？

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

### @bugron/validate-dependabot-yaml 的下载量有多少？

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

### @bugron/validate-dependabot-yaml 还在维护吗？

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