API 文档 | Checkstyle |
---|
对某些源文件运行 Checkstyle。
属性 | 描述 |
checkstyleClasspath | 包含要使用的 Checkstyle 库的类路径。 |
classpath | 包含要分析的源文件的已编译类的类路径。 |
config | 要使用的 Checkstyle 配置。替换 |
configDirectory | 其他 Checkstyle 配置文件的路径。 |
configFile | 要使用的 Checkstyle 配置文件。 |
configProperties | 可在配置文件中使用的属性。这些属性会被替换到配置文件中。 |
enableExternalDtdLoad | 孵化中 启用在配置文件中使用外部 DTD 文件。 默认禁用,因为这可能不安全。 详见 Checkstyle 文档。 |
excludes | 排除模式集。 |
ignoreFailures | 当此任务执行的验证失败时,构建是否应该中断。 |
includes | 包含模式集。 |
javaLauncher | 孵化中 用于启动 Worker 进程的 Java Launcher |
maxErrors | 在中断构建或设置 failure 属性之前,允许的最大错误数。 |
maxHeapSize | 孵化中 Worker 进程的最大堆大小。如果未指定,Gradle 将提供最大堆大小。支持类似命令行选项 |
maxWarnings | 在中断构建或设置 failure 属性之前,允许的最大警告数。 |
minHeapSize | 孵化中 Worker 进程的最小堆大小。如果未指定,则不设置最小堆大小。支持类似命令行选项 |
reports | 此任务将生成的报告。 |
showViolations | 是否在控制台显示规则违规。 |
source | 应用包含和排除模式后,此任务的源。忽略不存在的源文件。 |
方法 | 描述 |
exclude(excludeSpec) | 添加一个排除规范 (exclude spec)。可以多次调用此方法以添加新的规范。给定的闭包 (closure) 会接收一个 |
exclude(excludes) | 添加 ANT 风格的排除模式。可以多次调用此方法以添加新模式,并且可以在一次调用中指定多个模式。如果未提供排除模式,则不会排除任何文件。如果提供了排除模式,则文件必须不匹配任何排除模式才能被处理。 |
exclude(excludes) | 添加 ANT 风格的排除模式。可以多次调用此方法以添加新模式,并且可以在一次调用中指定多个模式。如果未提供排除模式,则不会排除任何文件。如果提供了排除模式,则文件必须不匹配任何排除模式才能被处理。 |
exclude(excludeSpec) | 添加一个排除规范 (exclude spec)。可以多次调用此方法以添加新的规范。如果未提供排除规范,则不会排除任何文件。如果提供了排除规范,则文件必须不匹配任何排除模式才能被处理。 |
include(includeSpec) | 添加一个包含规范 (include spec)。可以多次调用此方法以添加新的规范。给定的闭包 (closure) 会接收一个 |
include(includes) | 添加 ANT 风格的包含模式。可以多次调用此方法以添加新模式,并且可以在一次调用中指定多个模式。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式才能被处理。 |
include(includes) | 添加 ANT 风格的包含模式。可以多次调用此方法以添加新模式,并且可以在一次调用中指定多个模式。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式才能被处理。 |
include(includeSpec) | 添加一个包含规范 (include spec)。可以多次调用此方法以添加新的规范。如果未提供包含规范,则此容器中的所有文件都将被包含。如果提供了包含规范,则文件必须匹配至少一个包含模式或规范才能被包含。 |
reports(configureAction) | 配置此任务将生成的报告。可以通过名称和闭包配置包含的报告。示例 |
source(sources) | 为此任务添加一些源。给定的源对象将按照 |
块 | 描述 |
reports | 配置此任务将生成的报告。可以通过名称和闭包配置包含的报告。示例 |
FileCollection
checkstyleClasspath
包含要使用的 Checkstyle 库的类路径。
- 使用
checkstyle
插件时的默认值 project.configurations.checkstyle
TextResource
config
要使用的 Checkstyle 配置。替换 configFile
属性。
- 使用
checkstyle
插件时的默认值 project.checkstyle.config
DirectoryProperty
configDirectory
其他 Checkstyle 配置文件的路径。
此路径将在 Checkstyle 的配置文件中作为变量 config_loc
公开。
- 使用
checkstyle
插件时的默认值 project.checkstyle.configDirectory
可在配置文件中使用的属性。这些属性会被替换到配置文件中。
- 使用
checkstyle
插件时的默认值 project.checkstyle.configProperties
注意:此属性处于孵化中,未来版本的 Gradle 中可能会发生变化。
启用在配置文件中使用外部 DTD 文件。 默认禁用,因为这可能不安全。 详见 Checkstyle 文档。
- 使用
checkstyle
插件时的默认值 - false
当此任务执行的验证失败时,构建是否应该中断。
- 默认值
- false
- 使用
checkstyle
插件时的默认值 project.checkstyle.ignoreFailures
注意:此属性处于孵化中,未来版本的 Gradle 中可能会发生变化。
Worker 进程的最大堆大小。如果未指定,Gradle 将提供最大堆大小。支持类似命令行选项 -Xmx
的单位,例如 "1g"
。
注意:此属性处于孵化中,未来版本的 Gradle 中可能会发生变化。
Worker 进程的最小堆大小。如果未指定,则不设置最小堆大小。支持类似命令行选项 -Xms
的单位,例如 "1g"
。
CheckstyleReports
reports
(只读)
此任务将生成的报告。
FileTree
source
(只读)
应用包含和排除模式后,此任务的源。忽略不存在的源文件。
源的 PathSensitivity
配置为 PathSensitivity.ABSOLUTE
。如果您的源不那么严格,请在子类中重写此方法以相应地更改它。
此任务的源是相对可重定位的,即使它产生的输出包含绝对路径。这是为了确保结果可以在不同构建之间重用而做出的折衷。缺点是,最新结果或从缓存加载的结果可能显示与任务执行时产生的绝对路径不同。
- 使用
checkstyle
插件时的默认值 sourceSet
.allJava
SourceTask
exclude
(Closure
excludeSpec)
添加一个排除规范 (exclude spec)。可以多次调用此方法以添加新的规范。给定的闭包 (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
>
excludes)
Iterable
<String
>添加 ANT 风格的排除模式。可以多次调用此方法以添加新模式,并且可以在一次调用中指定多个模式。如果未提供排除模式,则不会排除任何文件。如果提供了排除模式,则文件必须不匹配任何排除模式才能被处理。
SourceTask
exclude
(String
...
excludes)
String
...添加 ANT 风格的排除模式。可以多次调用此方法以添加新模式,并且可以在一次调用中指定多个模式。如果未提供排除模式,则不会排除任何文件。如果提供了排除模式,则文件必须不匹配任何排除模式才能被处理。
SourceTask
exclude
(Spec
<FileTreeElement
>
excludeSpec)
Spec
<FileTreeElement
>添加一个排除规范 (exclude spec)。可以多次调用此方法以添加新的规范。如果未提供排除规范,则不会排除任何文件。如果提供了排除规范,则文件必须不匹配任何排除模式才能被处理。
SourceTask
include
(Closure
includeSpec)
添加一个包含规范 (include spec)。可以多次调用此方法以添加新的规范。给定的闭包 (closure) 会接收一个 FileTreeElement
作为参数。如果未提供包含规范,则此容器中的所有文件都将被包含。如果提供了包含规范,则文件必须匹配至少一个包含模式或规范才能被包含。
SourceTask
include
(Iterable
<String
>
includes)
Iterable
<String
>添加 ANT 风格的包含模式。可以多次调用此方法以添加新模式,并且可以在一次调用中指定多个模式。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式才能被处理。
SourceTask
include
(String
...
includes)
String
...添加 ANT 风格的包含模式。可以多次调用此方法以添加新模式,并且可以在一次调用中指定多个模式。如果未提供包含模式,则此容器中的所有文件都将被包含。如果提供了包含模式,则文件必须匹配至少一个包含模式才能被处理。
SourceTask
include
(Spec
<FileTreeElement
>
includeSpec)
Spec
<FileTreeElement
>添加一个包含规范 (include spec)。可以多次调用此方法以添加新的规范。如果未提供包含规范,则此容器中的所有文件都将被包含。如果提供了包含规范,则文件必须匹配至少一个包含模式或规范才能被包含。
CheckstyleReports
reports
(Action
<? super CheckstyleReports
>
configureAction)
Action
<? super CheckstyleReports
>配置此任务将生成的报告。可以通过名称和闭包配置包含的报告。示例
checkstyleTask {
reports {
html {
destination "build/checkstyle.html"
}
}
}
SourceTask
source
(Object
...
sources)
Object
...为此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[])
进行评估。
配置此任务将生成的报告。可以通过名称和闭包配置包含的报告。示例
checkstyleTask {
reports {
html {
destination "build/checkstyle.html"
}
}
}
- 委托给
CheckstyleReports
fromreports