# @codacy/tooling 中文文档

规范地址：https://npmcn.com/package/%40codacy/tooling/

版本：0\.28\.0
npm 元数据更新时间：2026-11-09T13:46:37.393Z
中文译文更新时间：2026-11-10T05:29:52.909Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：481 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- 首次发布：2026-03-24T13:15:53.438Z
- 最新版本发布：2026-11-09T13:46:37.092Z
- 近 30 天下载量：15380（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：36（近 12 个月 36 个）

## 中文简介

开发Codacy工具适配器的共享合同、接口和公用事业

## 安装

```sh
npm install @codacy/tooling
```

也可以使用：`pnpm add @codacy/tooling`、`yarn add @codacy/tooling`、`bun add @codacy/tooling`

## README

# @ codacy/ 工具

## 目录

-   [概览](https://npmcn.com/package/%40codacy/tooling/#readme-overview)
-   [出口](https://npmcn.com/package/%40codacy/tooling/#readme-exports)
-   [ToolAdapter合同](https://npmcn.com/package/%40codacy/tooling/#readme-tooladapter-contract)
-   [公用事业](https://npmcn.com/package/%40codacy/tooling/#readme-utilities)

* * *

## 概览

共有合同、类型和公用设施,用于Codacy Analysis CLI monorepo。 每个适配器和跑道都依赖于这个包.

## 出口

| 导出 | 目的 |
| --- | --- |
| 类型(`Issue`, (中文(简体) ), `AnalysisError`, (中文(简体) ), `ToolAdapter`页:1 | 整个管道的共享接口 |
| `defineToolAdapter()` | 定义适配器的帮助类型 |
| `buildPatternId()` | 从工具 ID + 规则 ID 构造模式 ID |
| `spawnTool()` | CLI 策略适配器的儿童流程包 |
| `validateIssue()` | 运行时验证问题对象 |
| `downloadFile()` 编号 : `downloadAndExtract()` | HTTP 工具安装下载工具 |

## ToolAdapter合同

每个工具适配器必须执行四种方法:

```
checkAvailability → install → checkLocalConfigurationFile → analyze
```

| 方法 | 目的 |
| --- | --- |
| `checkAvailability(ctx)` | 工具二进制存在且可运行吗 ? |
| `install(ctx)` | 下载/安装二进制( 或返回) `NotSupported`(中文(简体) ) |
| `checkLocalConfigurationFile(ctx)` | 在 repo 中查找本地配置文件 |
| `analyze(ctx, config)` | 运行工具并返回问题+出错 |

三项执行战略: **国 际** (儿童过程), **图书馆** (节点.js API), **土著** (纯TypeScript).

## 公用事业

### `spawnTool(binary, args, options)`

生出一个孩子的过程,抓取stdout/stderr/exitCode. 所有CLI战略适应器都使用.

### `downloadFile(url, destPath)` 编号 : `downloadAndExtract(url, destDir, options)`

HTTP 为工具安装提供下载帮助. `downloadAndExtract` 手柄 `.tar.gz` 可选的归档 `stripComponents`。 。 。 .

## 常见问题

### @codacy/tooling 是什么？

开发Codacy工具适配器的共享合同、接口和公用事业

### 如何安装 @codacy/tooling？

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

### @codacy/tooling 支持 TypeScript 吗？

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

### @codacy/tooling 支持 ESM 还是 CommonJS？

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

### @codacy/tooling 需要什么版本的 Node\.js？

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

### @codacy/tooling 可以商用吗？

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

### @codacy/tooling 的下载量有多少？

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

### @codacy/tooling 还在维护吗？

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