# @actions/workflow-parser 中文文档

规范地址：https://npmcn.com/package/%40actions/workflow-parser/

版本：0\.3\.61
npm 元数据更新时间：2026-08-04T19:25:24.305Z
中文译文更新时间：2026-11-05T17:37:33.207Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：618 kB，322 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>= 20
- 运行依赖：3 个
- 首次发布：2023-03-23T21:39:50.812Z
- 最新版本发布：2026-08-04T19:25:23.867Z
- 近 30 天下载量：207004（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：63（近 12 个月 42 个）

## 中文简介

`@actions/workflow-parser` 是分析 GitHub 动作的库 [工作流程](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)。 。 。 .

## 安装

```sh
npm install @actions/workflow-parser
```

也可以使用：`pnpm add @actions/workflow-parser`、`yarn add @actions/workflow-parser`、`bun add @actions/workflow-parser`

## README

# 动作/工作流程-参数

`@actions/workflow-parser` 是分析 GitHub 动作的库 [工作流程](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions)。 。 。 .

## 安装

这个 [软件包](https://www.npmjs.com/package/@actions/workflow-parser) 包含TypeScript类型并编译了ECMAScript模块.

```bash
npm install @actions/workflow-parser
```

## 使用量

解析器是由定义于 [`worflows-v1.0.json`](https://npmcn.com/package/%40actions/workflow-parser/src/workflow-v1.0.json)。 。 。 .

### 简单示例

`parseWorkflow` 将工作流程 YAML 解析为中间代表,并验证它符合计划。 解析错误在 `errors` 结果上下文的属性.

```typescript
var trace: TraceWriter;

const result = parseWorkflow(
  {
    name: "test.yaml",
    content: `on: push
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - run: echo 'hello'`
  },
  trace
);
```

`convertWorkflowTemplate` 然后将中间代表转换为 [`WorkflowTemplate`](https://npmcn.com/package/%40actions/workflow-parser/src/model/workflow-template.ts) 对象,这是比较方便的工作流程表达.

```typescript
const workflowTemplate = await convertWorkflowTemplate(result.context, result.value);

// workflowTemplate.jobs[0].id === "build"
// workflowTemplate.jobs[0].steps[0].run === "echo 'hello'"
```

## 捐款

见 [捐款额](https://npmcn.com/package/%40actions/CONTRIBUTING.md) 作为一般准则和建议存放处的基础.

类似 [\`行动/表现'](https://npmcn.com/package/%40actions/expressions/),这个项目只是GitHub Actions工作流程解析器的多处执行之一. 因此,我们不能接受大大改变方案或分析者总体行为的贡献。 如果你想对行动本身提出修改,请使用我们 [社区论坛](https://github.com/community/community/discussions/categories/actions-and-packages)。 。 。 .

如果你想捐款,请跑 [更美丽](https://prettier.io/) 用于格式化您的代码,并在提交您的PR前酌情添加单位测试. [./测试数据](https://npmcn.com/package/%40actions/workflow-parser/testdata) 包含所有执行都应通过的测试案例,也请确保这些测试仍然通过.

### 构建

```bash
npm run build
```

或监视更改

```bash
npm run watch
```

### 测试

```bash
npm test
```

或监视更改和运行测试:

```bash
npm run test-watch
```

### 林特

```bash
npm run format-check
```

## 许可证

这个项目根据麻省理工学院开源许可证的规定获得许可. 请参考 [麻省理工学院](https://npmcn.com/package/%40actions/LICENSE) 全部条件.

## 常见问题

### @actions/workflow-parser 是什么？

@actions/workflow-parser 是分析 GitHub 动作的库 工作流程。 。 。 \.

### 如何安装 @actions/workflow-parser？

在项目目录运行 npm install @actions/workflow-parser，或使用 pnpm add / yarn add / bun add。

### @actions/workflow-parser 支持 TypeScript 吗？

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

### @actions/workflow-parser 支持 ESM 还是 CommonJS？

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

### @actions/workflow-parser 需要什么版本的 Node\.js？

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

### @actions/workflow-parser 可以商用吗？

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

### @actions/workflow-parser 的下载量有多少？

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

### @actions/workflow-parser 还在维护吗？

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