gradle - 使用 Gradle 的 Checkstyle

Question

我正在尝试将 checkstyle 添加到我的 build.gradle .

Checkstyle 模板是 commons-math3 , 可从 here 访问.

但是这个文件使用 ${checkstyle.header.file}检查每个源文件顶部的许可证声明。

<!-- Verify that EVERY source file has the appropriate license -->
<module name="Header">
  <property name="headerFile" value="${checkstyle.header.file}"/>
</module>

所以我在我的 build.gradle 中添加了以下短语:

checkstyle {
    configFile = rootProject.file("commons-math-checkstyle.xml")
    headerFile = rootProject.file("license-header.txt")
    toolVersion = '7.8.1'
}

但它会出错。

删除 headerFile = rootProject.file("license-header.txt")来自 build.gradle和制作 Header checkstyle xml 文件中的模块由 <!-- 包装和 --> (即禁用)使 checkstyle 运行良好。

如何申报 checkstyle.header.file在我的 build.gradle文件？

Answer 1

您需要在 Gradle 文件中定义属性:

checkstyle {
    toolVersion '7.8.1';
    configFile file('commons-math-checkstyle.xml');
    configProperties 'checkstyle.header.file': file('license-header.txt');
}