| API 文档 | CheckstyleExtension |
|---|
Checkstyle 插件的配置选项。
| 属性 | 描述 |
config | 要使用的 Checkstyle 配置。替换了 |
configDirectory | 其他 Checkstyle 配置文件的路径。默认情况下，此路径为 |
configFile | 要使用的 Checkstyle 配置文件。 |
configProperties | 配置文件中可用的属性。这些属性会替换到配置文件中。 |
enableExternalDtdLoad | 孵化中 启用在此项目的所有 Checkstyle 任务中，在配置中使用自定义 DTD 文件并从某个位置加载它们的能力。出于安全考虑，默认禁用。 更多详细信息请参见 Checkstyle 文档。 |
ignoreFailures | 是否允许在有警告时继续构建。示例：ignoreFailures = true |
maxErrors | 在中断构建或设置失败属性之前可容忍的最大错误数。默认为 |
maxWarnings | 在中断构建或设置失败属性之前可容忍的最大警告数。默认为 |
reportsDir | 生成报告的目录。 |
showViolations | 是否在控制台上显示规则违规。默认为 |
sourceSets | 作为 |
toolVersion | 要使用的代码质量工具的版本。 |
TextResource config
要使用的 Checkstyle 配置。替换了 configFile 属性。
checkstyle插件的默认值${configDirectory}/checkstyle.xml
DirectoryProperty configDirectory
其他 Checkstyle 配置文件的路径。默认情况下，此路径为 $rootProject.projectDir/config/checkstyle
此路径将在 Checkstyle 的配置文件中作为变量 config_loc 暴露。
checkstyle插件的默认值${rootProject.projectDir}/config/checkstyle
注意：此属性处于 孵化阶段，可能会在 Gradle 的未来版本中更改。
启用在此项目的所有 Checkstyle 任务中，在配置中使用自定义 DTD 文件并从某个位置加载它们的能力。出于安全考虑，默认禁用。 更多详细信息请参见 Checkstyle 文档。
checkstyle插件的默认值false
在中断构建或设置失败属性之前可容忍的最大警告数。默认为 Integer.MAX_VALUE。
示例：maxWarnings = 1000
checkstyle插件的默认值Integer.MAX_VALUE
File reportsDir
生成报告的目录。
String toolVersion
要使用的代码质量工具的版本。