# @github/dependency-submission-toolkit 中文文档

规范地址：https://npmcn.com/package/%40github/dependency-submission-toolkit/

版本：3\.0\.0
npm 元数据更新时间：2026-11-05T11:59:18.629Z
中文译文更新时间：2026-11-16T12:24:07.964Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40github/dependency-submission-toolkit
原文对照：https://npmcn.com/package/%40github/dependency-submission-toolkit/?lang=original
项目主页：https://github.com/github/dependency-submission-toolkit
源码仓库：https://github.com/github/dependency-submission-toolkit

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

- 包体积（解压后）：57.5 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：5 个
- 首次发布：2022-06-28T16:10:53.992Z
- 最新版本发布：2026-11-05T11:59:17.899Z
- 近 30 天下载量：2816（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 2 个）

## 中文简介

用于创建依赖快照的 TypeScript 库 .

## 安装

```sh
npm install @github/dependency-submission-toolkit
```

也可以使用：`pnpm add @github/dependency-submission-toolkit`、`yarn add @github/dependency-submission-toolkit`、`bun add @github/dependency-submission-toolkit`

## README

# 依赖性提交工具包

`@github/dependency-submission-toolkit` 是一个用于创建的 TypeScript 库 依赖性快照并将其提交给依赖性提交的API. 抓图是一组依附物,按表与一些相关 元数据。 清单可以是物理文件,也可以是较抽象的 a 依赖分组(这种程序产出的处理)。 提交之后 aPI,包含的依赖性出现在寄存器 [依赖图](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph)。 。 。 .

## 安装

第3版要求节点.js 24或更后. 两个共同JS(`require`和无害环境管理 (单位:千美元)`import`) 得到支持.

```
npm install @github/dependency-submission-toolkit
```

## 写入您自己的依赖性提交动作

您可使用来自 `@github/dependency-submission-toolkit` 帮助 创建您自己的 GitHub 动作, 以向依赖提交依赖性 呈报API. 在高级别,使用这些课程的步骤是:

1.  创建一个 `PackageCache` 包含在您的 明确,并明确界定它们之间的关系.
    
2.  使用定义的软件包 `PackageCache`创建一个 `Manifest` 或一个 `BuildTarget`,定义建筑环境的依赖性或 特定的建筑文物.
    
3.  创建一个 `Snapshot` 包含一个或多个 `Manifests` 或者说 `BuildTargets`编辑 快照是向依赖提交依赖性的基准容器 呈报API.
    
4.  遵循指示 [创建 Java 脚本动作](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action)。 。 。 . 其中包括:
    
    -   定义一个 `action.yml` 动作元数据文件
    -   使用 JavaScript 编译为单一脚本 `ncc`
    -   在工作流程中测试您的动作

使用此库的完整实例动作包含在 `example/` 目录。 此示例使用来自 `npm list` 创建 准确完整的图解此库使用的依赖性. 这个 动作也包含在这个仓库中的工作流程中,并为每个数据库运行 承诺 `main` 树枝.

## 常见问题

### @github/dependency-submission-toolkit 是什么？

用于创建依赖快照的 TypeScript 库 \.

### 如何安装 @github/dependency-submission-toolkit？

在项目目录运行 npm install @github/dependency-submission-toolkit，或使用 pnpm add / yarn add / bun add。

### @github/dependency-submission-toolkit 支持 TypeScript 吗？

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

### @github/dependency-submission-toolkit 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @github/dependency-submission-toolkit 需要什么版本的 Node\.js？

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

### @github/dependency-submission-toolkit 可以商用吗？

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

### @github/dependency-submission-toolkit 的下载量有多少？

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

### @github/dependency-submission-toolkit 还在维护吗？

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

