# @actions/languageservice 中文文档

规范地址：https://npmcn.com/package/%40actions/languageservice/

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

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

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

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

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

## 中文简介

GitHub 动作的语文服务

## 安装

```sh
npm install @actions/languageservice
```

也可以使用：`pnpm add @actions/languageservice`、`yarn add @actions/languageservice`、`bun add @actions/languageservice`

## README

# 行动/语言服务

此软件包包含 GitHub 动作工作流程语言服务器的逻辑 .

## 安装

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

```bash
npm install @actions/languageservice
```

## 使用量

### 基本用途

#### 概念

语文服务的特点使用三个信息来源:

-   工作流程 YAML 文件的内置静态方案
-   _价值提供者_ 可以动态地将值添加到计划中,例如,在验证时,可以为寄存器添加可用的标签列表 `runs-on`。 。 。 .
-   _上下文提供者_ 能够动态地提供用于 [表达式](https://docs.github.com/actions/reference/context-and-expression-syntax-for-github-actions#about-contexts-and-expressions)。例如,该指南的内容 `github.event` 上下文.

#### 验证

验证工作流程文件,返回一组 [`Diagnostic`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#diagnostic) 对象.

```typescript
const config: ValidationConfig = {
  valueProviderConfig: valueProviders(sessionToken, repoContext, cache),
  contextProviderConfig: contextProviders(sessionToken, repoContext, cache),
};

const result = await validate(textDocument, config); // result is an array of `Diagnostic`
```

#### 缓冲

何时获取信息 [徘徊着](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_hover) 超过工作流程文件中的一个符号.

```typescript
import {hover} from "@actions/languageservice";

const document = {
  uri: "file:///path/to/file",
  getText: () => "on: push\n  jobs:\n    build:\n      runs-on: ubuntu-latest\n      steps:\n        - run: echo hello"
};

const hover = await hover(document, {line: 0, character: 1}); // { contents: { kind: "markdown", value: "The event that triggers the workflow" } }
```

#### 自动补全

```typescript
import {complete} from "@actions/languageservice";

const document = {
  uri: "file:///path/to/file",
  getText: () => `on: 
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - run: echo hello`
};

// Trigger completion for `on: |`
const suggestions = await complete(document, {line: 0, character: 4});
```

将返回

```jsonc
[{
  "documentation": {
    "kind": "markdown",
    "value": "Runs your workflow when branch protection rules in the workflow repository are changed.",
  },
  "label": "branch_protection_rule",
  "textEdit": {
    "newText": "branch_protection_rule",
    "range": {
      "end": {"character": 4, "line": 0,},
      "start": {"character": 4, "line": 0},
    },
  },
},
//... other events
]
```

## 捐款

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

如果你想捐款,请跑 [更美丽](https://prettier.io/) 用于格式化您的代码,并在提交您的PR前酌情添加单位测试.

### 构建

```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/languageservice 是什么？

GitHub 动作的语文服务

### 如何安装 @actions/languageservice？

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

### @actions/languageservice 支持 TypeScript 吗？

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

### @actions/languageservice 支持 ESM 还是 CommonJS？

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

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

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

### @actions/languageservice 可以商用吗？

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

### @actions/languageservice 的下载量有多少？

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

### @actions/languageservice 还在维护吗？

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