# @codacy/tools-checkstyle-14 中文文档

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

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

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

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

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

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

## 中文简介

检查样式适配器 — CLI- mode Java 样式检查器

## 安装

```sh
npm install @codacy/tools-checkstyle-14
```

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

## README

# @codacy/tools-checkstyle-14 (英语)

## 目录

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

* * *

## 概览

Java 样式检查器和静态分析工具 [检查样式](https://checkstyle.org/) 肥猪JAR。 使用CLI执行战略 -- -- 产卵 `java -jar checkstyle-all.jar` 通过 `spawnTool()` 并解析其 XML 输出.

| 财产 | 数值 |
| --- | --- |
| 工具标识 | `Checkstyle` |
| 编码 UUID | `f4a54ce0-1fe1-4bc7-a9ed-9f91f675c409` |
| 战略 | 国 际 |
| 语文 | 爪哇语 |
| 二进制 | `java -jar checkstyle-14.1.0-all.jar` |
| 文件图案 | `**/*.java` |

## 更新图案

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

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

模式 ID 遵循格式 `Checkstyle_AvoidStarImport`, (中文(简体) ), `Checkstyle_WhitespaceAround`等 (中文(简体) ). 检查名称取自FQCN源属性(如. `com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck` 变成 `AvoidStarImport`) (中文(简体) ).

## 更新检查样式版本

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

## 发展

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

要在本地安装 Checktyle JAR 测试 :

```bash
mkdir -p /tmp/codacy-checkstyle-test-tools
curl -L -o /tmp/codacy-checkstyle-test-tools/checkstyle-14.1.0-all.jar \
  https://github.com/checkstyle/checkstyle/releases/download/checkstyle-14.1.0/checkstyle-14.1.0-all.jar
```

## 维护者的注释

-   检查样式需要Java 11+作为运行时间. 适配器使用 `ensureJre()` 如果没有找到系统Java,则下载Adoplium Temurin JDK 21.
-   肥胖的JAR从GitHub的发布中下载通过 `downloadJar()` 改为 `~/.codacy/tools/checkstyle-14/`。 。 。 .
-   出站代码0=无违反, >0=发现违反(parse XML),负=出错.
-   XML 输出在 stdout( 不同于使用 stderr 的 cppcheck) 上 .
-   `error/@source` 是一个FQCN像 `com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck`。适配器将软件包的前缀和 `Check` 后缀以获取检查名.
-   `error/@column` 可能缺席; 缺漏时默认为 1.
-   Checkstyle XML中的行/列编号已经基于 1;不需要转换.
-   一些模块(标题、FileLength、LineLength等)是全球性的,必须放在下面 `<module name="Checker">` 而不是内部 `<module name="TreeWalker">`。适配器从图案生成配置时处理此分割.
-   配置文件检测 `checkstyle.xml` 在寄存器根中.
-   当没有指定本地配置和模式时,适配器使用 Checkstyle 的内置 `sun_checks.xml`。 。 。 .
-   检查样式打印 `Starting audit...` 财务报告和审定财务报表 `Audit done.` 到 stderr; 这些从出错输出中过滤出.

## 常见问题

### @codacy/tools-checkstyle-14 是什么？

检查样式适配器 — CLI- mode Java 样式检查器

### 如何安装 @codacy/tools-checkstyle-14？

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

### @codacy/tools-checkstyle-14 支持 TypeScript 吗？

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

### @codacy/tools-checkstyle-14 支持 ESM 还是 CommonJS？

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

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

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

### @codacy/tools-checkstyle-14 可以商用吗？

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

### @codacy/tools-checkstyle-14 的下载量有多少？

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

### @codacy/tools-checkstyle-14 还在维护吗？

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