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.AbstractCodeQualityTask
-
- org.gradle.api.plugins.quality.CodeNarc
-
- All Implemented Interfaces:
java.lang.Comparable<Task>,org.gradle.api.internal.DynamicObjectAware,org.gradle.api.internal.IConventionAware,org.gradle.api.internal.TaskInternal,Named,ExtensionAware,Reporting<CodeNarcReports>,Task,PatternFilterable,VerificationTask,Configurable<Task>
@CacheableTask public abstract class CodeNarc extends AbstractCodeQualityTask implements 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 interface org.gradle.api.Task
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, 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 FileCollectiongetCodenarcClasspath()The class path containing the CodeNarc library to be used.FileCollectiongetCompilationClasspath()The class path to be used by CodeNarc when compiling classes during analysis.TextResourcegetConfig()The CodeNarc configuration to use.java.io.FilegetConfigFile()The CodeNarc configuration file to use.intgetMaxPriority1Violations()The maximum number of priority 1 violations allowed before failing the build.intgetMaxPriority2Violations()The maximum number of priority 2 violations allowed before failing the build.intgetMaxPriority3Violations()The maximum number of priority 3 violations allowed before failing the build.CodeNarcReportsgetReports()The reports to be generated by this task.FileTreegetSource()Returns the source for this task, after the include and exclude patterns have been applied.CodeNarcReportsreports(Closure closure)Configures the reports to be generated by this task.CodeNarcReportsreports(Action<? super CodeNarcReports> configureAction)Configures the reports to be generated by this task.voidrun()voidsetCodenarcClasspath(FileCollection codenarcClasspath)The class path containing the CodeNarc library to be used.voidsetCompilationClasspath(FileCollection compilationClasspath)The class path to be used by CodeNarc when compiling classes during analysis.voidsetConfig(TextResource config)The CodeNarc configuration to use.voidsetConfigFile(java.io.File configFile)The CodeNarc configuration file to use.voidsetMaxPriority1Violations(int maxPriority1Violations)The maximum number of priority 1 violations allowed before failing the build.voidsetMaxPriority2Violations(int maxPriority2Violations)The maximum number of priority 2 violations allowed before failing the build.voidsetMaxPriority3Violations(int maxPriority3Violations)The maximum number of priority 3 violations allowed before failing the build.-
Methods inherited from class org.gradle.api.plugins.quality.AbstractCodeQualityTask
configureForkOptions, getIgnoreFailures, getIgnoreFailuresProperty, getJavaLauncher, getMaxHeapSize, getMinHeapSize, getObjectFactory, getToolchainService, getWorkerExecutor, setIgnoreFailures
-
Methods inherited from class org.gradle.api.tasks.SourceTask
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSet, 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
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
-
Methods inherited from class org.gradle.api.internal.AbstractTask
acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.gradle.api.Task
doNotTrackState, getConvention, notCompatibleWithConfigurationCache
-
-
-
-
Method Detail
-
getConfigFile
@Internal public java.io.File getConfigFile()
The CodeNarc configuration file to use.
-
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.The
PathSensitivityfor the sources is configured to bePathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.- Overrides:
getSourcein classSourceTask- Returns:
- The source.
-
setConfigFile
public void setConfigFile(java.io.File configFile)
The CodeNarc configuration file to use.
-
run
public void run()
-
reports
public CodeNarcReports reports(Closure closure)
Configures the reports to be generated by this task.- Specified by:
reportsin 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:
reportsin 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
@Classpath public FileCollection getCompilationClasspath()
The class path to be used by CodeNarc when compiling classes during analysis.- Since:
- 4.2
-
setCompilationClasspath
public void setCompilationClasspath(FileCollection compilationClasspath)
The class path to be used by CodeNarc when compiling classes during analysis.- Since:
- 4.2
-
getConfig
public TextResource getConfig()
The CodeNarc configuration to use. Replaces theconfigFileproperty.- Since:
- 2.2
-
setConfig
public void setConfig(TextResource config)
The CodeNarc configuration to use. Replaces theconfigFileproperty.- 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:
getReportsin interfaceReporting<CodeNarcReports>- Returns:
- The report container
-
-