# @codacy/tools-detekt-1 中文文档

规范地址：https://npmcn.com/package/%40codacy/tools-detekt-1/

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

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

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

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

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

## 中文简介

detekt适配器——CLI-mode克特林静态分析器

## 安装

```sh
npm install @codacy/tools-detekt-1
```

也可以使用：`pnpm add @codacy/tools-detekt-1`、`yarn add @codacy/tools-detekt-1`、`bun add @codacy/tools-detekt-1`

## README

# @codacy/tools-detekt-1 (英语)

## 目录

-   [概览](https://npmcn.com/package/%40codacy/tools-detekt-1/#readme-overview)
-   [更新图案](https://npmcn.com/package/%40codacy/tools-detekt-1/#readme-updating-patterns)
-   [更新 detekt 版本](https://npmcn.com/package/%40codacy/tools-detekt-1/#readme-updating-the-detekt-version)
-   [发展](https://npmcn.com/package/%40codacy/tools-detekt-1/#readme-development)
-   [维护者的注释](https://npmcn.com/package/%40codacy/tools-detekt-1/#readme-notes-for-maintainers)

* * *

## 概览

Kotlin 静态分析器,使用 [调试](https://detekt.dev/) (原始内容存档于2018-10-12). CLI JAR. 使用CLI执行战略 -- -- 产卵 `java -jar detekt-cli-all.jar` 通过 `spawnTool()` 并解析其“检查风格”的 XML 输出.

| 财产 | 数值 |
| --- | --- |
| 工具标识 | `detekt` |
| 编码 UUID | `cb36c32d-fc0d-4b4c-8f21-66e536ef4513` |
| 战略 | 国 际 |
| 语文 | 科特林语Name |
| 二进制 | `detekt-cli-1.23.8-all.jar` (从 GitHub 下载) |
| 文件图案 | `**/*.kt`, (中文(简体) ), `**/*.kts` |

## 更新图案

```bash
# Re-fetch pattern metadata from the Codacy API
pnpm prefetch

# Commit the result
git add src/patterns.json
```

模式 ID 是赤裸的规则名( 没有前缀 ): `LongMethod`, (中文(简体) ), `MagicNumber`, (中文(简体) ), `ComplexCondition`等 (中文(简体) ).

## 更新 detekt 版本

1.  更新 `DETEKT_VERSION` 财务报告和审定财务报表 `JAR_NAME` 内 `src/adapter.ts`
2.  更新 `JAR_URL` 以指向新发布
3.  运行 `pnpm prefetch` 以检查新的/撤消的规则
4.  运行 `pnpm test` 以验证兼容性
5.  如果主要版本更改,请创建新的适配软件包(`detekt-2/`(中文(简体) )

## 发展

```bash
pnpm build    # Build with tsup
pnpm test     # Run tests (requires java in PATH + detekt JAR)
```

要在本地安装 detekt 测试 :

```bash
# Download the all-in-one JAR
curl -L -o /tmp/codacy-detekt-test-tools/detekt-cli-1.23.8-all.jar \
  https://github.com/detekt/detekt/releases/download/v1.23.8/detekt-cli-1.23.8-all.jar
```

## 维护者的注释

-   **预设绘图`src/pattern-mappings.json`(中文(简体) )**: 7个胸围规则被打开 `kotlinx-coroutines`,从任何 `kotlinx-coroutines-*` 马文文物. 七个人都是 默认关闭的上游,所以在此之前,它们永远无法通过 `init --auto` - 甚至没有 在一个皮管项目。 5个德泰克特自己的 `coroutines` 标记; `GlobalCoroutineUsage` 财务报告和审定财务报表 `InjectDispatcher` 不带标签, 并用其赤裸的规则名( detekt typed ID) 匹配 没有工具前缀).
    
-   detekt需要Java 8+作为运行时间. 适配器使用 `ensureJre()` 如果没有找到系统Java,则下载Adoplium Temurin JDK 21.
    
-   Detekt CLI JAR是一款从GitHub版下载到的全能脂肪JAR `ctx.toolInstallDir`。 。 。 .
    
-   输出格式为 Checkstyle 4.3 XML 写入临时文件 `--report xml:<path>`。 。 。 .
    
-   `--base-path <repoRoot>` 确保XML中的文件路径相对寄存器根.
    
-   `--parallel` 能够对性能进行多行分析.
    
-   这个 `source` xML 中的属性有格式 `detekt.RuleName` 或者说 `detekt.ruleset.RuleName`。适配器将 `detekt.` 前缀和任何规则片前缀,只获取规则名.
    
-   图案 ID 在 `patterns.json` 没有前缀——它们是赤裸的规则名(例如. `LongMethod`没有 `detekt_LongMethod`) (中文(简体) ).
    
-   出站代码:0=无出站发现,1=出站发现(建设故障门槛),2=出站发现,3=无效配置.
    
-   配置文件检测支持 `detekt.yml` 财务报告和审定财务报表 `default-detekt-config.yml`。当找到本地配置时,通过 `--config <path>`。 。 。 .
    
-   模式过滤是后hoc:detekt运行时带有所有默认规则,然后输出被被被启用的模式集过滤.

## 常见问题

### @codacy/tools-detekt-1 是什么？

detekt适配器——CLI-mode克特林静态分析器

### 如何安装 @codacy/tools-detekt-1？

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

### @codacy/tools-detekt-1 支持 TypeScript 吗？

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

### @codacy/tools-detekt-1 支持 ESM 还是 CommonJS？

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

### @codacy/tools-detekt-1 需要什么版本的 Node\.js？

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

### @codacy/tools-detekt-1 可以商用吗？

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

### @codacy/tools-detekt-1 的下载量有多少？

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

### @codacy/tools-detekt-1 还在维护吗？

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