| API 文档 | CodeNarc |
|---|
针对一些源文件运行 CodeNarc。
| 属性 | 描述 |
codenarcClasspath | 包含要使用的 CodeNarc 库的类路径。 |
compilationClasspath | CodeNarc 在分析期间编译类时要使用的类路径。 |
config | 要使用的 CodeNarc 配置。替换 |
configFile | 要使用的 CodeNarc 配置文件。 |
excludes | 排除模式集。 |
ignoreFailures | 孵化中 指定当此任务执行的验证失败时，构建是否应该中断。 |
includes | 包含模式集。 |
javaLauncher | 孵化中 用于启动 worker 进程的 Java 启动器 |
maxHeapSize | 孵化中 worker 进程的最大堆大小。如果未指定，Gradle 将提供最大堆大小。支持类似命令行选项 |
maxPriority1Violations | 在构建失败之前允许的最大优先级 1 违规数。 |
maxPriority2Violations | 在构建失败之前允许的最大优先级 2 违规数。 |
maxPriority3Violations | 在构建失败之前允许的最大优先级 3 违规数。 |
minHeapSize | 孵化中 worker 进程的最小堆大小。未指定时，不设置最小堆大小。支持类似命令行选项 |
reports | 由此任务生成的报告。 |
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 codenarcClasspath
包含要使用的 CodeNarc 库的类路径。
- 使用
codenarc插件的默认值 project.configurations.codenarc
注意：此属性处于孵化中，并且可能在 Gradle 的未来版本中更改。
worker 进程的最大堆大小。如果未指定，Gradle 将提供最大堆大小。支持类似命令行选项 -Xmx 的单位，例如 "1g"。
注意：此属性处于孵化中，并且可能在 Gradle 的未来版本中更改。
worker 进程的最小堆大小。未指定时，不设置最小堆大小。支持类似命令行选项 -Xms 的单位，例如 "1g"。
CodeNarcReports reports (只读)
由此任务生成的报告。
FileTree source (只读)
应用包含和排除模式后，此任务的源。忽略不存在的源文件。
源的 PathSensitivity 配置为 PathSensitivity.ABSOLUTE。如果您的源要求不那么严格，请在您的子类中覆盖此方法以进行相应更改。
- 使用
codenarc插件的默认值 sourceSet.allGroovy
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>
Iterable<String>添加 ANT 样式排除模式。可以多次调用此方法以追加新模式，并且可以在单个调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。
SourceTask exclude(String...
String...添加 ANT 样式排除模式。可以多次调用此方法以追加新模式，并且可以在单个调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。
SourceTask exclude(Spec<FileTreeElement>
Spec<FileTreeElement>添加排除规范。可以多次调用此方法以追加新规范。如果未提供排除项，则不会排除任何文件。如果提供了排除项，则文件必须不匹配任何排除模式才能被处理。
SourceTask include(Closure includeSpec)
添加包含规范。可以多次调用此方法以追加新规范。给定的闭包会传递一个 FileTreeElement 作为其参数。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式或规范才能被包含。
SourceTask include(Iterable<String>
Iterable<String>添加 ANT 样式包含模式。可以多次调用此方法以追加新模式，并且可以在单个调用中指定多个模式。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式才能被处理。
SourceTask include(String...
String...添加 ANT 样式包含模式。可以多次调用此方法以追加新模式，并且可以在单个调用中指定多个模式。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式才能被处理。
SourceTask include(Spec<FileTreeElement>
Spec<FileTreeElement>添加包含规范。可以多次调用此方法以追加新规范。如果未提供包含项，则将包含此容器中的所有文件。如果提供了包含项，则文件必须至少匹配一个包含模式或规范才能被包含。
CodeNarcReports reports(Action<? super CodeNarcReports>
Action<? super CodeNarcReports>配置由此任务生成的报告。
SourceTask source(Object...
Object...向此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[]) 进行评估。