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

目录

• 概览
• 更新图案
• 更新 detekt 版本
• 发展
• 维护者的注释

概览

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

更新图案

# 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/(中文(简体) )

发展

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

要在本地安装 detekt 测试 :

# 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运行时带有所有默认规则,然后输出被被被启用的模式集过滤.