# @dev-build-deploy/diagnose-it 中文文档

规范地址：https://npmcn.com/package/%40dev-build-deploy/diagnose-it/

版本：1\.4\.2
npm 元数据更新时间：2023-12-11T10:04:24.389Z
中文译文更新时间：2026-11-12T01:47:41.469Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40dev-build-deploy/diagnose-it
原文对照：https://npmcn.com/package/%40dev-build-deploy/diagnose-it/?lang=original
项目主页：https://github.com/dev-build-deploy/diagnose-it#readme
源码仓库：https://github.com/dev-build-deploy/diagnose-it

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

- 包体积（解压后）：44.7 kB，12 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2023-06-14T13:32:50.110Z
- 最新版本发布：2023-12-11T10:04:24.219Z
- 近 30 天下载量：9171（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 0 个）

## 中文简介

表达式诊断库

## 安装

```sh
npm install @dev-build-deploy/diagnose-it
```

也可以使用：`pnpm add @dev-build-deploy/diagnose-it`、`yarn add @dev-build-deploy/diagnose-it`、`bun add @dev-build-deploy/diagnose-it`

## README

# 诊断 它 - 表达性诊断库

轻量级诊断记录器,基于 [LLVMS 表达式诊断规格](https://clang.llvm.org/diagnostics.html)数字 :

![](https://npmcn.com/package/%40dev-build-deploy/diagnose-it/docs/example.svg)

## 特征

-   简单使用
-   受到 [LLVMS 表达式诊断规格](https://clang.llvm.org/diagnostics.html)
-   提供诊断信息的背景

## 使用量

### 创建表达式诊断信息

```ts
import { DiagnosticsMessage, FixItHint } from '@dev-build-deploy/diagnose-it';
const lines = `steps:
  - uses: actions/checkout@v2
  - neds: [build, test]
    - uses: actions/setup-node@v2`;
  
// Example use case
const message = DiagnosticsMessage.createError(
  "example.yaml",
  {
    text: "Invalid keyword 'neds'",
    linenumber: 9,
    column: 5
  }
)
  // Add context to the diagnostics message
  .setContext(7, lines)
  // Add a FixIt Hint
  .addFixitHint(FixItHint.createReplacement({ index: 5, length: 4 }, "needs"));

// Convert to string
console.log(message.toString());

// Apply FixIt Hints
console.log("Results after applying FixIt Hints:", message.applyFixitHints());

// Throw as an Error
throw message;
```

### 解析文件

您可以解析一个( 编译输出) 文件以获取任何表达式诊断消息 :

```ts
import * as diagnoseIt from '@dev-build-deploy/diagnose-it';

for await(const message of diagnoseIt.extractFromFile("build.log")) {
  if (message.toJSON().type === "error") {
    // Oh noes!
  }
}
```

> **页:1**任意 `.sarif` 或者说 `.sarif.json` 文件将被解析为有效的 SARIF 结果内容

## 输出格式

`DiagnoseIt` 灵感来自 [LLVMS 表达式诊断格式化](https://clang.llvm.org/diagnostics.html)· ;

![](https://npmcn.com/package/%40dev-build-deploy/diagnose-it/docs/formatting.svg)

_然而,它并非旨在提供完全相容性._

## 捐款

有建议的话 `DiagnoseIt` 可以改进, 或者想要报告一个错误, 打开一个问题! 我们很乐意所有的贡献.

更多,请检查 [贡献指南](https://npmcn.com/package/%40dev-build-deploy/diagnose-it/CONTRIBUTING.md)。 。 。 .

## 许可证

-   [麻省理工学院](https://npmcn.com/package/%40dev-build-deploy/diagnose-it/LICENSES/MIT.txt) 2023 凯文·德·钟 <monkaii@hotmail.com>

## 常见问题

### @dev-build-deploy/diagnose-it 是什么？

表达式诊断库

### 如何安装 @dev-build-deploy/diagnose-it？

在项目目录运行 npm install @dev-build-deploy/diagnose-it，或使用 pnpm add / yarn add / bun add。

### @dev-build-deploy/diagnose-it 支持 TypeScript 吗？

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

### @dev-build-deploy/diagnose-it 支持 ESM 还是 CommonJS？

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

### @dev-build-deploy/diagnose-it 可以商用吗？

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

### @dev-build-deploy/diagnose-it 的下载量有多少？

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

### @dev-build-deploy/diagnose-it 还在维护吗？

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