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

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

版本：0\.2\.1
npm 元数据更新时间：2023-08-03T06:12:22.491Z
中文译文更新时间：2026-11-12T01:47:46.133Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：24 kB，16 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2023-07-27T21:36:47.574Z
- 最新版本发布：2023-08-03T06:12:22.371Z
- 近 30 天下载量：8944（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

静态分析结果互换格式构建库

## 安装

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

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

## README

# SarifIt - 静态分析结果互换格式构建器

轻量级\[SARIF\]构建器库,允许您的工具生成统一的代码质量报告.

## 特征

-   简单使用
-   创建 SARIF 对象的折叠器
-   与\[SARIF 2.1.0\]相配

## 使用量

### 定义新的代码质量分析工具

```ts
import * as sarif from "@dev-build-deploy/sarif-it";

const tool = new sarif.Tool("code-scanner")
  .organization("dev-build-deploy")
  .version("0.0.0")
  .informationUri("https://github.com/dev-build-deploy/sarif-it#README.md");

const missingDocsRule = new sarif.Rule("MissingDocumentation")
  .name("Missing Documentation")
  .shortDescription("All repositories must contain a README.md containing basic instructions.")
  .fullDescription({
    text: "As documentation is important, we expect all repositories to contain at least a README.md file.",
    markown: "As documentation is *important*, we expect **all** repositories to contain *at least* a `README.md` file."
  })
  .helpUri("https://github.com/dev-build-deploy/sarif-it#README.md");

tool.addRule(missingDocsRule);
```

### 创建代码质量分析报告

假设我们已经定义了代码质量分析工具([这里](https://npmcn.com/package/%40dev-build-deploy/sarif-it/#readme-define-a-new-code-quality-analysis-tool)(三);

```ts
import * as sarif from "@dev-build-deploy/sarif-it";

const log = new sarif.Log()
  .addRun(new sarif.Run(tool));  // NOTE: Example for creating a `tool` can be found in the previous chapter

const result = new sarif.Result("Missing Documentation")
  .ruleId("MissingDocumentation")
  .level("error")
  .addLocation({
    physicalLocation: {
      artifactLocation: {
        uri: "./README.md",
      },
    },    
  })

log.get("runs")[0].addResult(result);
```

## 捐款

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

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

## 许可证

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

## 常见问题

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

静态分析结果互换格式构建库

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

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

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

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

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

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

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

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

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

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

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

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