运行项目中的自定义 checkstyle 检查

Question

我有一个基于 gradle 的项目，我想对其应用一些在同一项目中的自定义检查，例如有一个包 com.my.package.checkstyle 和许多其他包 com.my.package.* 具有逻辑。

我该怎么做？

目前我的 checkstyle 配置导入检查如下：

<module name="com.my.package.checkstyle.BracketsStructureCheck"/>

build.gradle 有以下几行：

apply plugin: 'checkstyle'
compile('com.puppycrawl.tools:checkstyle:6.17')
checkstyleMain.source = "src/main/java"
checkstyleMain.excludes = ["**/checkstyle/**"]

Answer 1

您可以将自定义 Checkstyle 检查放入它们自己的 Gradle 模块中（例如，myChecks），然后通过项目依赖项从主代码模块的依赖项部分引用它：

dependencies {
    checkstyle project(':myChecks')
}

通过这种方式，您的自定义检查将添加到 Checkstyle 分析的类路径中，并且可以从您的 checkstyle.xml.

中引用

运行 项目中的自定义 checkstyle 检查

Running custom checkstyle checks within a project

checkstyle

gradle

运行项目中的自定义 checkstyle 检查