在项目中运行自定义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部分引用它：

dependencies {
    checkstyle project(':myChecks')
}

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