API 文档 | Checkstyle |
---|
对一些源文件运行 Checkstyle。
属性 | 描述 |
checkstyleClasspath | 包含要使用的 Checkstyle 库的类路径。 |
classpath | 包含要分析的源文件的已编译类的类路径。 |
config | 要使用的 Checkstyle 配置。替换 |
configDirectory | 其他 Checkstyle 配置文件的路径。 |
configFile | 要使用的 Checkstyle 配置文件。 |
configProperties | 可在配置文件中使用的属性。这些属性会被替换到配置文件中。 |
enableExternalDtdLoad | 孵化中 在配置文件中启用外部 DTD 文件的使用。 默认禁用,因为这可能不安全。 有关更多详细信息,请参阅 Checkstyle 文档。 |
excludes | 排除模式的集合。 |
ignoreFailures | 当此任务执行的验证失败时,构建是否应该中断。 |
includes | 包含模式的集合。 |
javaLauncher | 孵化中 用于启动工作进程的 Java 启动器 |
maxErrors | 在中断构建或设置 failure 属性之前允许的最大错误数。 |
maxHeapSize | 孵化中 工作进程的最大堆大小。如果未指定,Gradle 将提供最大堆大小。支持类似命令行选项 |
maxWarnings | 在中断构建或设置 failure 属性之前允许的最大警告数。 |
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
TextResource
config
要使用的 Checkstyle 配置。替换 configFile
属性。
- 使用
checkstyle
插件时的默认值 project.checkstyle.config
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