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