| API Documentation: | CodeNarc |
|---|
Runs CodeNarc against some source files.
| Property | Description |
codenarcClasspath | The class path containing the CodeNarc library to be used. |
compilationClasspath | The class path to be used by CodeNarc when compiling classes during analysis. |
config | The CodeNarc configuration to use. Replaces the |
configFile | The CodeNarc configuration file to use. |
excludes | The set of exclude patterns. |
ignoreFailures | Incubating Specifies whether the build should break when the verifications performed by this task fail. |
includes | The set of include patterns. |
javaLauncher | Incubating Java launcher used to start the worker process |
maxHeapSize | Incubating The maximum heap size for the worker process. If unspecified, a maximum heap size will be provided by Gradle.
Supports units like the command-line option |
maxPriority1Violations | The maximum number of priority 1 violations allowed before failing the build. |
maxPriority2Violations | The maximum number of priority 2 violations allowed before failing the build. |
maxPriority3Violations | The maximum number of priority 3 violations allowed before failing the build. |
minHeapSize | Incubating The minimum heap size for the worker process. When unspecified, no minimum heap size is set.
Supports units like the command-line option |
reports | The reports to be generated by this task. |
source | The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist. |
| Method | Description |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a
|
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a
|
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed. |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included. |
reports(configureAction) | Configures the reports to be generated by this task. |
source(sources) | Adds some source to this task. The given source objects will be evaluated as per |
| Block | Description |
reports | Configures the reports to be generated by this task. |
FileCollection codenarcClasspath
The class path containing the CodeNarc library to be used.
- Default with
codenarcplugin: project.configurations.codenarc
FileCollection compilationClasspath
The class path to be used by CodeNarc when compiling classes during analysis.
- Default with
codenarcplugin: - empty file collection
TextResource config
The CodeNarc configuration to use. Replaces the configFile property.
- Default with
codenarcplugin: project.codenarc.config
File configFile
The CodeNarc configuration file to use.
- Default with
codenarcplugin: project.codenarc.configFile
Note: This property is incubating and may change in a future version of Gradle.
Specifies whether the build should break when the verifications performed by this task fail.
Property<JavaLauncher>javaLauncher
Property<JavaLauncher>Note: This property is incubating and may change in a future version of Gradle.
Java launcher used to start the worker process
Note: This property is incubating and may change in a future version of Gradle.
The maximum heap size for the worker process. If unspecified, a maximum heap size will be provided by Gradle.
Supports units like the command-line option -Xmx such as "1g".
The maximum number of priority 1 violations allowed before failing the build.
- Default with
codenarcplugin: 0
The maximum number of priority 2 violations allowed before failing the build.
- Default with
codenarcplugin: 0
The maximum number of priority 3 violations allowed before failing the build.
- Default with
codenarcplugin: 0
Note: This property is incubating and may change in a future version of Gradle.
The minimum heap size for the worker process. When unspecified, no minimum heap size is set.
Supports units like the command-line option -Xms such as "1g".
CodeNarcReports reports (read-only)
The reports to be generated by this task.
FileTree source (read-only)
The source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.
The PathSensitivity for the sources is configured to be PathSensitivity.ABSOLUTE.
If your sources are less strict, please change it accordingly by overriding this method in your subclass.
- Default with
codenarcplugin: sourceSet.allGroovy
SourceTask exclude(Closure excludeSpec)
Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a
FileTreeElement as its parameter. The closure should return true or false. Example:
copySpec {
from 'source'
into 'destination'
//an example of excluding files from certain configuration:
exclude { it.file in configurations.someConf.files }
}
If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask exclude(Iterable<String>
Iterable<String>Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask exclude(String...
String...Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask exclude(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an exclude spec. This method may be called multiple times to append new specs. If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match any exclude pattern to be processed.
SourceTask include(Closure includeSpec)
Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a
FileTreeElement as its parameter.
If includes are not provided, then all files in this container will be included. If includes are provided, then a
file must match at least one of the include patterns or specs to be included.
SourceTask include(Iterable<String>
Iterable<String>Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
SourceTask include(String...
String...Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns to be processed.
SourceTask include(Spec<FileTreeElement>
Spec<FileTreeElement>Adds an include spec. This method may be called multiple times to append new specs. If includes are not provided, then all files in this container will be included. If includes are provided, then a file must match at least one of the include patterns or specs to be included.
CodeNarcReports reports(Action<? super CodeNarcReports>
Action<? super CodeNarcReports>Configures the reports to be generated by this task.
SourceTask source(Object...
Object...Adds some source to this task. The given source objects will be evaluated as per Project.files(java.lang.Object[]).
Configures the reports to be generated by this task.
- Delegates to:
CodeNarcReportsfromreports