API 文档 | Checkstyle |
---|
对某些源文件运行Checkstyle。
属性 | 描述 |
checkstyleClasspath | 包含要使用的Checkstyle库的类路径。 |
类路径 | 包含要分析的源文件的编译类的类路径。 |
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) | 添加一个包含规范。此方法可以多次调用以追加新的规范。给定闭包的参数是 |
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
插件 - false
当此任务执行的验证失败时,是否中断构建。
- 默认值
- false
- 默认使用
checkstyle
插件 project.checkstyle.ignoreFailures
注意:此属性处于孵化中,可能会在 Gradle 的未来版本中更改。
工作进程的最大堆大小。如果未指定,Gradle将提供最大堆大小。支持像命令行选项-Xmx
一样的单位,例如"1g"
。
注意:此属性处于孵化中,可能会在 Gradle 的未来版本中更改。
工作进程的最小堆大小。如果未指定,则不设置最小堆大小。支持像命令行选项-Xms
一样的单位,例如"1g"
。
CheckstyleReports
reports
(只读)
此任务要生成的报告。
FileTree
source
(只读)
应用包含和排除模式后,此任务的源。忽略不存在的源文件。
源文件的PathSensitivity
配置为PathSensitivity.ABSOLUTE
。如果您的源文件限制不那么严格,请在子类中覆盖此方法进行相应更改。
此任务的源文件是相对可重定位的,即使它生成包含绝对路径的输出。这是为了确保结果可以在不同构建之间重用而做出的折衷。缺点是最新结果或从缓存加载的结果可能显示与任务执行时产生的绝对路径不同的路径。
- 默认使用
checkstyle
插件 sourceSet
.allJava
SourceTask
exclude
(Closure
excludeSpec)
添加一个排除规范。此方法可以多次调用以追加新的规范。给定闭包的参数是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
>添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件必须不匹配任何排除模式才能进行处理。
SourceTask
include
(Closure
includeSpec)
添加一个包含规范。此方法可以多次调用以追加新的规范。给定闭包的参数是FileTreeElement
。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含。
SourceTask
include
(Iterable
<String
>
includes)
Iterable
<String
>添加一个ANT样式包含模式。此方法可以多次调用以追加新模式,并且可以在一次调用中指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式才能进行处理。
SourceTask
include
(String
...
includes)
String
...添加一个ANT样式包含模式。此方法可以多次调用以追加新模式,并且可以在一次调用中指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式才能进行处理。
SourceTask
include
(Spec
<FileTreeElement
>
includeSpec)
Spec
<FileTreeElement
>添加一个包含规范。此方法可以多次调用以追加新的规范。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含。
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
来自reports