@codacy/tools- checkstyle-13 (英语)
目录
概览
Java 样式检查器和静态分析工具 检查样式 肥猪JAR。 使用CLI执行战略 -- -- 产卵 java -jar checkstyle-all.jar 通过 spawnTool() 并解析其 XML 输出.
| 财产 | 数值 |
|---|---|
| 工具标识 | Checkstyle |
| 编码 UUID | f4a54ce0-1fe1-4bc7-a9ed-9f91f675c409 |
| 战略 | 国 际 |
| 语文 | 爪哇语 |
| 二进制 | java -jar checkstyle-13.9.0-all.jar |
| 文件图案 | **/*.java |
更新图案
# 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) (中文(简体) ).
更新检查样式版本
- 更新
CHECKSTYLE_VERSION内src/adapter.ts - 更新
JAR_NAME财务报告和审定财务报表JAR_URL常数相应 - 运行
pnpm prefetch以检查新的/撤消的规则 - 运行
pnpm test以验证兼容性 - 如果主要版本更改,请创建新的适配软件包(
checkstyle-11/(中文(简体) )
发展
pnpm build # Build with tsup
pnpm test # Run tests (requires java in PATH + JAR in tools dir)
要在本地安装 Checktyle JAR 测试 :
mkdir -p /tmp/codacy-checkstyle-test-tools
curl -L -o /tmp/codacy-checkstyle-test-tools/checkstyle-13.9.0-all.jar \
https://github.com/checkstyle/checkstyle/releases/download/checkstyle-13.9.0/checkstyle-13.9.0-all.jar
维护者的注释
- 检查样式需要Java 11+作为运行时间. 适配器使用
ensureJre()如果没有找到系统Java,则下载Adoplium Temurin JDK 21. - 肥胖的JAR从GitHub的发布中下载通过
downloadJar()改为~/.codacy/tools/checkstyle-13/。 。 。 . - 出站代码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; 这些从出错输出中过滤出.