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:
- 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 SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionThe class path containing the CodeNarc library to be used.The class path to be used by CodeNarc when compiling classes during analysis.The CodeNarc configuration to use.The CodeNarc configuration file to use.intThe maximum number of priority 1 violations allowed before failing the build.intThe maximum number of priority 2 violations allowed before failing the build.intThe maximum number of priority 3 violations allowed before failing the build.The reports to be generated by this task.Returns the source for this task, after the include and exclude patterns have been applied.Configures the reports to be generated by this task.reports(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(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.AbstractCodeQualityTaskconfigureForkOptions, getIgnoreFailures, getIgnoreFailuresProperty, getJavaLauncher, getMaxHeapSize, getMinHeapSize, getObjectFactory, getToolchainService, getWorkerExecutor, setIgnoreFailuresMethods inherited from class org.gradle.api.tasks.SourceTaskexclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSet, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, sourceMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, 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, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
CodeNarcpublic CodeNarc()
 
- 
- 
Method Details- 
getConfigFileThe CodeNarc configuration file to use.
- 
getSourceReturns 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 class- SourceTask
- Returns:
- The source.
 
- 
setConfigFileThe CodeNarc configuration file to use.
- 
runpublic void run()
- 
reportsConfigures the reports to be generated by this task.- Specified by:
- reportsin interface- Reporting<CodeNarcReports>
- Parameters:
- closure- The configuration
- Returns:
- The report container
 
- 
reportsConfigures the reports to be generated by this task.- Specified by:
- reportsin interface- Reporting<CodeNarcReports>
- Parameters:
- configureAction- The configuration
- Returns:
- The report container
 
- 
getCodenarcClasspathThe class path containing the CodeNarc library to be used.
- 
setCodenarcClasspathThe class path containing the CodeNarc library to be used.
- 
getCompilationClasspathThe class path to be used by CodeNarc when compiling classes during analysis.- Since:
- 4.2
 
- 
setCompilationClasspathThe class path to be used by CodeNarc when compiling classes during analysis.- Since:
- 4.2
 
- 
getConfigThe CodeNarc configuration to use. Replaces theconfigFileproperty.- Since:
- 2.2
 
- 
setConfigThe CodeNarc configuration to use. Replaces theconfigFileproperty.- Since:
- 2.2
 
- 
getMaxPriority1ViolationsThe maximum number of priority 1 violations allowed before failing the build.
- 
setMaxPriority1Violationspublic void setMaxPriority1Violations(int maxPriority1Violations) The maximum number of priority 1 violations allowed before failing the build.
- 
getMaxPriority2ViolationsThe maximum number of priority 2 violations allowed before failing the build.
- 
setMaxPriority2Violationspublic void setMaxPriority2Violations(int maxPriority2Violations) The maximum number of priority 2 violations allowed before failing the build.
- 
getMaxPriority3ViolationsThe maximum number of priority 3 violations allowed before failing the build.
- 
setMaxPriority3Violationspublic void setMaxPriority3Violations(int maxPriority3Violations) The maximum number of priority 3 violations allowed before failing the build.
- 
getReportsThe reports to be generated by this task.- Specified by:
- getReportsin interface- Reporting<CodeNarcReports>
- Returns:
- The report container
 
 
-