| API文档： | Checkstyle |
|---|
针对某些源文件运行 Checkstyle。
| 财产 | 描述 |
checkstyleClasspath | 包含要使用的 Checkstyle 库的类路径。 |
classpath | 包含要分析的源文件的已编译类的类路径。 |
config | 要使用的 Checkstyle 配置。替换 |
configDirectory | 其他 Checkstyle 配置文件的路径。 |
configFile | 要使用的 Checkstyle 配置文件。 |
configProperties | 可在配置文件中使用的属性。这些被替换到配置文件中。 |
enableExternalDtdLoad | 孵化 允许在配置文件中使用外部 DTD 文件。 默认情况下禁用，因为这可能不安全。有关更多详细信息， 请参阅Checkstyle 文档。 |
excludes | 排除模式集。 |
ignoreFailures | 当此任务执行的验证失败时，构建是否应该中断。 |
includes | 包含模式集。 |
javaLauncher | 孵化 Java启动器用于启动工作进程 |
maxErrors | 在破坏构建或设置失败属性之前可容忍的最大错误数。 |
maxHeapSize | 孵化 工作进程的最大堆大小。如果未指定，Gradle 将提供最大堆大小。支持命令行选项等单位， |
maxWarnings | 在破坏构建或设置失败属性之前可容忍的最大警告数。 |
minHeapSize | 孵化 工作进程的最小堆大小。如果未指定，则不会设置最小堆大小。支持命令行选项等单位， |
reports | 此任务要生成的报告。 |
showViolations | 是否在控制台上显示违反规则的情况。 |
source | 应用包含和排除模式后此任务的源。忽略不存在的源文件。 |
| 方法 | 描述 |
exclude(excludeSpec) | 添加排除规范。可以多次调用此方法来附加新规范。给定的闭包将
|
exclude(excludes) | 添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。 |
exclude(excludes) | 添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。 |
exclude(excludeSpec) | 添加排除规范。可以多次调用此方法来附加新规范。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。 |
include(includeSpec) | 添加包含规范。可以多次调用此方法来附加新规范。给定的闭包将 a |
include(includes) | 添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。 |
include(includes) | 添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。 |
include(includeSpec) | 添加包含规范。可以多次调用此方法来附加新规范。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要包含的包含模式或规范之一。 |
reports(configureAction) | 配置此任务要生成的报告。所包含的报告可以按名称和关闭进行配置。例子： |
source(sources) | 向此任务添加一些源。给定的源对象将根据 进行评估 |
| 堵塞 | 描述 |
reports | 配置此任务要生成的报告。所包含的报告可以按名称和关闭进行配置。例子： |
FileCollection checkstyleClasspath
包含要使用的 Checkstyle 库的类路径。
- 默认使用
checkstyle插件： project.configurations.checkstyle
DirectoryProperty configDirectory
其他 Checkstyle 配置文件的路径。
config_loc该路径将作为Checkstyle 配置文件中的
变量公开。
- 默认使用
checkstyle插件： project.checkstyle.configDirectory
可在配置文件中使用的属性。这些被替换到配置文件中。
- 默认使用
checkstyle插件： project.checkstyle.configProperties
注意：此属性正在酝酿中，可能会在 Gradle 的未来版本中发生更改。
允许在配置文件中使用外部 DTD 文件。 默认情况下禁用，因为这可能不安全。有关更多详细信息， 请参阅Checkstyle 文档。
- 默认使用
checkstyle插件： - 错误的
当此任务执行的验证失败时，构建是否应该中断。
- 默认值：
- 错误的
- 默认使用
checkstyle插件： project.checkstyle.ignoreFailures
注意：此属性正在酝酿中，可能会在 Gradle 的未来版本中发生更改。
工作进程的最大堆大小。如果未指定，Gradle 将提供最大堆大小。支持命令行选项等单位，-Xmx例如"1g".
注意：此属性正在酝酿中，可能会在 Gradle 的未来版本中发生更改。
工作进程的最小堆大小。如果未指定，则不会设置最小堆大小。支持命令行选项等单位，-Xms例如"1g".
CheckstyleReports reports（只读）
此任务要生成的报告。
FileTree source（只读）
应用包含和排除模式后此任务的源。忽略不存在的源文件。
源的PathSensitivity被配置为PathSensitivity.ABSOLUTE。如果您的来源不太严格，请通过在您的子类中重写此方法来相应地更改它。
尽管此任务生成包含绝对路径的输出，但其源相对可重定位。这是为了确保结果可以在不同构建之间重用而做出的妥协。缺点是最新结果或从缓存加载的结果可能显示与执行任务时生成的绝对路径不同的绝对路径。
- 默认使用
checkstyle插件： sourceSet.allJava
SourceTask exclude（Closure不包括规格）
添加排除规范。可以多次调用此方法来附加新规范。给定的闭包将
FileTreeElement作为其参数传递。闭包应该返回 true 或 false。例子：
copySpec {
from 'source'
into 'destination'
//an example of excluding files from certain configuration:
exclude { it.file in configurations.someConf.files }
}
如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。
SourceTask exclude（不包括）Iterable<String>
Iterable<String>添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。
SourceTask exclude（String...
String...添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。
SourceTask exclude（不包括规格）Spec<FileTreeElement>
Spec<FileTreeElement>添加排除规范。可以多次调用此方法来附加新规范。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。
SourceTask include（Closure包括规格）
添加包含规范。可以多次调用此方法来附加新规范。给定的闭包将 aFileTreeElement作为其参数传递
。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要包含的包含模式或规范之一。
SourceTask include（包括）Iterable<String>
Iterable<String>添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。
SourceTask include（String...
String...添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。
SourceTask include（包括规格）Spec<FileTreeElement>
Spec<FileTreeElement>添加包含规范。可以多次调用此方法来附加新规范。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要包含的包含模式或规范之一。
CheckstyleReports reports（配置动作）Action<? super CheckstyleReports>
Action<? super CheckstyleReports>配置此任务要生成的报告。所包含的报告可以按名称和关闭进行配置。例子：
checkstyleTask {
reports {
html {
destination "build/checkstyle.html"
}
}
}
SourceTask source（Object...
Object...向此任务添加一些源。给定的源对象将根据 进行评估Project.files(java.lang.Object[])。
配置此任务要生成的报告。所包含的报告可以按名称和关闭进行配置。例子：
checkstyleTask {
reports {
html {
destination "build/checkstyle.html"
}
}
}