刑警代码

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)

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

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 excludeClosure不包括规格)

添加排除规范。可以多次调用此方法来附加新规范。给定的闭包将 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>

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

SourceTask excludeString...不包括)

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

SourceTask exclude(不包括规格)Spec<FileTreeElement>

添加排除规范。可以多次调用此方法来附加新规范。如果未提供排除,则不会排除任何文件。如果提供了排除,则文件不得与要处理的任何排除模式匹配。

SourceTask includeClosure包括规格)

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

SourceTask include(包括)Iterable<String>

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

SourceTask includeString...包括)

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

SourceTask include(包括规格)Spec<FileTreeElement>

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

CodeNarcReports reports(配置动作)Action<? super CodeNarcReports>

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

SourceTask sourceObject...来源)

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

脚本块详细信息

reports{ }

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

代表们:
CodeNarcReportsreports