java - 为 checkstyle 实现自定义模块

Question

我创建了一个插件，它为项目中的所有子项目调用 Checkstyle 插件。对任何项目执行简单的 checkstyle 规则都可以正常工作，但是当我引入自定义模块时，构建过程会出现问题
原因:com.puppycrawl.tools.checkstyle.api.CheckstyleException:无法实例化“com.test.gradle.plugin.perf.MethodLimitCheck”类

此类具有自定义规则，我希望运行 checkstyle。我的插件在项目构建期间被触发，并尝试在失败时运行此自定义模块。尝试浏览大量在线资源但找不到任何内容。我正在使用 Checkstyle 版本 8.17。

为什么其他项目无法实例化该类？即使该类是附加到其他项目的插件 jar 的一部分？附加自定义模块的正确方法是什么？

Answer 1

对于 Gradle，必须通过将自定义检查添加到 checkstyle 配置来将自定义检查放置在分析运行的类路径上。示例来自Checkstyle Addons库(基本上是自定义检查的集合):

plugins {
    id 'checkstyle'  // regular Checkstyle plugin
}
dependencies {
    checkstyle group: 'com.thomasjensen.checkstyle.addons', name: 'checkstyle-addons', version: '5.2.2'
}
checkstyle {
    configFile file('your-checkstyle.xml')
    toolVersion '8.0'   // set Checkstyle version here
}