CodeNarc

API 文档CodeNarc

对某些源文件运行 CodeNarc。

属性

属性描述
codenarcClasspath

包含要使用的 CodeNarc 库的类路径。

compilationClasspath

CodeNarc 在分析期间编译类时使用的类路径。

config

要使用的 CodeNarc 配置。替换 configFile 属性。

configFile

要使用的 CodeNarc 配置文件。

excludes

排除模式集。

ignoreFailures
孵化中

指定此任务执行的验证失败时是否应中断构建。

includes

包含模式集。

javaLauncher
孵化中

用于启动工作进程的Java启动器

maxHeapSize
孵化中

工作进程的最大堆大小。如果未指定,Gradle将提供最大堆大小。支持像命令行选项-Xmx一样的单位,例如"1g"

maxPriority1Violations

在构建失败之前允许的最大优先级 1 违规数。

maxPriority2Violations

在构建失败之前允许的最大优先级 2 违规数。

maxPriority3Violations

在构建失败之前允许的最大优先级 3 违规数。

minHeapSize
孵化中

工作进程的最小堆大小。如果未指定,则不设置最小堆大小。支持像命令行选项-Xms一样的单位,例如"1g"

reports

此任务要生成的报告。

source

应用包含和排除模式后,此任务的源。忽略不存在的源文件。

方法

方法描述
exclude(excludeSpec)

添加排除规范。此方法可以多次调用以附加新规范。给定的闭包将 FileTreeElement 作为其参数传递。闭包应返回 true 或 false。示例

exclude(excludes)

添加 ANT 样式排除模式。此方法可以多次调用以附加新模式,并且可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

exclude(excludes)

添加 ANT 样式排除模式。此方法可以多次调用以附加新模式,并且可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

exclude(excludeSpec)

添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件必须不匹配任何排除模式才能进行处理。

include(includeSpec)

添加包含规范。此方法可以多次调用以附加新规范。给定的闭包将 FileTreeElement 作为其参数传递。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含。

include(includes)

添加 ANT 样式包含模式。此方法可以多次调用以附加新模式,并且可以在一次调用中指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式才能处理。

include(includes)

添加 ANT 样式包含模式。此方法可以多次调用以附加新模式,并且可以在一次调用中指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式才能处理。

include(includeSpec)

添加包含规范。此方法可以多次调用以附加新规范。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含。

reports(configureAction)

配置此任务要生成的报告。

source(sources)

为此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[]) 进行评估。

脚本块

描述
reports

配置此任务要生成的报告。

属性详情

FileCollection codenarcClasspath

包含要使用的 CodeNarc 库的类路径。

使用 codenarc 插件的默认值
project.configurations.codenarc

FileCollection compilationClasspath

CodeNarc 在分析期间编译类时使用的类路径。

使用 codenarc 插件的默认值
空文件集合

要使用的 CodeNarc 配置。替换 configFile 属性。

使用 codenarc 插件的默认值
project.codenarc.config

File configFile

要使用的 CodeNarc 配置文件。

使用 codenarc 插件的默认值
project.codenarc.configFile

Set<String> excludes

排除模式集。

boolean ignoreFailures

注意:此属性处于孵化中,可能会在 Gradle 的未来版本中更改。

指定此任务执行的验证失败时是否应中断构建。

Set<String> includes

包含模式集。

Property<JavaLauncher> javaLauncher

注意:此属性处于孵化中,可能会在 Gradle 的未来版本中更改。

用于启动工作进程的Java启动器

Property<String> maxHeapSize

注意:此属性处于孵化中,可能会在 Gradle 的未来版本中更改。

工作进程的最大堆大小。如果未指定,Gradle将提供最大堆大小。支持像命令行选项-Xmx一样的单位,例如"1g"

int maxPriority1Violations

在构建失败之前允许的最大优先级 1 违规数。

使用 codenarc 插件的默认值
0

int maxPriority2Violations

在构建失败之前允许的最大优先级 2 违规数。

使用 codenarc 插件的默认值
0

int maxPriority3Violations

在构建失败之前允许的最大优先级 3 违规数。

使用 codenarc 插件的默认值
0

Property<String> minHeapSize

注意:此属性处于孵化中,可能会在 Gradle 的未来版本中更改。

工作进程的最小堆大小。如果未指定,则不设置最小堆大小。支持像命令行选项-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> excludes)

添加 ANT 样式排除模式。此方法可以多次调用以附加新模式,并且可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

SourceTask exclude(String... excludes)

添加 ANT 样式排除模式。此方法可以多次调用以附加新模式,并且可以在一次调用中指定多个模式。如果未提供排除项,则不会排除任何文件。如果提供了排除项,则文件必须不匹配任何排除模式才能被处理。

SourceTask exclude(Spec<FileTreeElement> excludeSpec)

添加排除规范。此方法可以多次调用以追加新的规范。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件必须不匹配任何排除模式才能进行处理。

SourceTask include(Closure includeSpec)

添加包含规范。此方法可以多次调用以附加新规范。给定的闭包将 FileTreeElement 作为其参数传递。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含。

SourceTask include(Iterable<String> includes)

添加 ANT 样式包含模式。此方法可以多次调用以附加新模式,并且可以在一次调用中指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式才能处理。

SourceTask include(String... includes)

添加 ANT 样式包含模式。此方法可以多次调用以附加新模式,并且可以在一次调用中指定多个模式。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式才能处理。

SourceTask include(Spec<FileTreeElement> includeSpec)

添加包含规范。此方法可以多次调用以附加新规范。如果未提供包含项,则此容器中的所有文件都将包含。如果提供了包含项,则文件必须至少匹配一个包含模式或规范才能包含。

CodeNarcReports reports(Action<? super CodeNarcReports> configureAction)

配置此任务要生成的报告。

SourceTask source(Object... sources)

为此任务添加一些源。给定的源对象将按照 Project.files(java.lang.Object[]) 进行评估。

脚本块详情

reports { }

配置此任务要生成的报告。

委托给
CodeNarcReports 来自 reports