Package org.gradle.api.plugins.quality
Class CodeNarc
- java.lang.Object
-
- org.gradle.api.internal.AbstractTask
-
- org.gradle.api.DefaultTask
-
- org.gradle.api.internal.ConventionTask
-
- org.gradle.api.tasks.SourceTask
-
- org.gradle.api.plugins.quality.CodeNarc
-
- All Implemented Interfaces:
Comparable<Task>
,org.gradle.api.internal.DynamicObjectAware
,org.gradle.api.internal.IConventionAware
,org.gradle.api.internal.TaskInternal
,ExtensionAware
,Reporting<CodeNarcReports>
,Task
,PatternFilterable
,VerificationTask
,org.gradle.util.Configurable<Task>
@CacheableTask public class CodeNarc extends SourceTask implements VerificationTask, Reporting<CodeNarcReports>
Runs CodeNarc against some source files.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer
-
-
Field Summary
-
Fields inherited from class org.gradle.api.tasks.SourceTask
source
-
Fields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
-
-
Constructor Summary
Constructors Constructor Description CodeNarc()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.gradle.api.internal.project.IsolatedAntBuilder
getAntBuilder()
FileCollection
getCodenarcClasspath()
The class path containing the CodeNarc library to be used.FileCollection
getCompilationClasspath()
The class path to be used by CodeNarc when compiling classes during analysis.TextResource
getConfig()
The CodeNarc configuration to use.File
getConfigFile()
The CodeNarc configuration file to use.boolean
getIgnoreFailures()
Whether the build should break when the verifications performed by this task fail.int
getMaxPriority1Violations()
The maximum number of priority 1 violations allowed before failing the build.int
getMaxPriority2Violations()
The maximum number of priority 2 violations allowed before failing the build.int
getMaxPriority3Violations()
The maximum number of priority 3 violations allowed before failing the build.ObjectFactory
getObjectFactory()
Injects and returns an instance ofObjectFactory
.CodeNarcReports
getReports()
The reports to be generated by this task.FileTree
getSource()
Returns the source for this task, after the include and exclude patterns have been applied.CodeNarcReports
reports(Closure closure)
Configures the reports to be generated by this task.CodeNarcReports
reports(Action<? super CodeNarcReports> configureAction)
Configures the reports to be generated by this task.void
run()
void
setCodenarcClasspath(FileCollection codenarcClasspath)
The class path containing the CodeNarc library to be used.void
setCompilationClasspath(FileCollection compilationClasspath)
The class path to be used by CodeNarc when compiling classes during analysis.void
setConfig(TextResource config)
The CodeNarc configuration to use.void
setConfigFile(File configFile)
The CodeNarc configuration file to use.void
setIgnoreFailures(boolean ignoreFailures)
Whether the build should break when the verifications performed by this task fail.void
setMaxPriority1Violations(int maxPriority1Violations)
The maximum number of priority 1 violations allowed before failing the build.void
setMaxPriority2Violations(int maxPriority2Violations)
The maximum number of priority 2 violations allowed before failing the build.void
setMaxPriority3Violations(int maxPriority3Violations)
The maximum number of priority 3 violations allowed before failing the build.-
Methods inherited from class org.gradle.api.tasks.SourceTask
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source
-
Methods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMapping
-
Methods inherited from class org.gradle.api.DefaultTask
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile
-
Methods inherited from class org.gradle.api.internal.AbstractTask
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
-
-
-
-
Method Detail
-
getSource
@PathSensitive(RELATIVE) public FileTree getSource()
Returns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.- Overrides:
getSource
in classSourceTask
- Returns:
- The source.
-
setConfigFile
public void setConfigFile(File configFile)
The CodeNarc configuration file to use.
-
getObjectFactory
@Incubating @Inject public ObjectFactory getObjectFactory()
Injects and returns an instance ofObjectFactory
.- Since:
- 4.2
-
getAntBuilder
@Inject public org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
-
run
public void run()
-
reports
public CodeNarcReports reports(Closure closure)
Configures the reports to be generated by this task.- Specified by:
reports
in interfaceReporting<CodeNarcReports>
- Parameters:
closure
- The configuration- Returns:
- The report container
-
reports
public CodeNarcReports reports(Action<? super CodeNarcReports> configureAction)
Configures the reports to be generated by this task.- Specified by:
reports
in interfaceReporting<CodeNarcReports>
- Parameters:
configureAction
- The configuration- Returns:
- The report container
-
getCodenarcClasspath
@Classpath public FileCollection getCodenarcClasspath()
The class path containing the CodeNarc library to be used.
-
setCodenarcClasspath
public void setCodenarcClasspath(FileCollection codenarcClasspath)
The class path containing the CodeNarc library to be used.
-
getCompilationClasspath
@Incubating @Classpath public FileCollection getCompilationClasspath()
The class path to be used by CodeNarc when compiling classes during analysis.- Since:
- 4.2
-
setCompilationClasspath
@Incubating public void setCompilationClasspath(FileCollection compilationClasspath)
The class path to be used by CodeNarc when compiling classes during analysis.- Since:
- 4.2
-
getConfig
@Incubating public TextResource getConfig()
The CodeNarc configuration to use. Replaces theconfigFile
property.- Since:
- 2.2
-
setConfig
@Incubating public void setConfig(TextResource config)
The CodeNarc configuration to use. Replaces theconfigFile
property.- Since:
- 2.2
-
getMaxPriority1Violations
@Input public int getMaxPriority1Violations()
The maximum number of priority 1 violations allowed before failing the build.
-
setMaxPriority1Violations
public void setMaxPriority1Violations(int maxPriority1Violations)
The maximum number of priority 1 violations allowed before failing the build.
-
getMaxPriority2Violations
@Input public int getMaxPriority2Violations()
The maximum number of priority 2 violations allowed before failing the build.
-
setMaxPriority2Violations
public void setMaxPriority2Violations(int maxPriority2Violations)
The maximum number of priority 2 violations allowed before failing the build.
-
getMaxPriority3Violations
@Input public int getMaxPriority3Violations()
The maximum number of priority 3 violations allowed before failing the build.
-
setMaxPriority3Violations
public void setMaxPriority3Violations(int maxPriority3Violations)
The maximum number of priority 3 violations allowed before failing the build.
-
getReports
public CodeNarcReports getReports()
The reports to be generated by this task.- Specified by:
getReports
in interfaceReporting<CodeNarcReports>
- Returns:
- The report container
-
getIgnoreFailures
public boolean getIgnoreFailures()
Whether the build should break when the verifications performed by this task fail.- Specified by:
getIgnoreFailures
in interfaceVerificationTask
- Returns:
- false, when the build should break on failure, true when the failures should be ignored.
-
setIgnoreFailures
public void setIgnoreFailures(boolean ignoreFailures)
Whether the build should break when the verifications performed by this task fail.- Specified by:
setIgnoreFailures
in interfaceVerificationTask
- Parameters:
ignoreFailures
- false to break the build on failure, true to ignore the failures. The default is false.
-
-