@CacheableTask open class CodeNarc : SourceTask, VerificationTask, Reporting<CodeNarcReports>
Runs CodeNarc against some source files.
CodeNarc() |
open fun getAntBuilder(): IsolatedAntBuilder |
|
open fun getCodenarcClasspath(): FileCollection
The class path containing the CodeNarc library to be used. |
|
open fun getCompilationClasspath(): FileCollection
The class path to be used by CodeNarc when compiling classes during analysis. |
|
open fun getConfig(): TextResource
The CodeNarc configuration to use. Replaces the |
|
open fun getConfigFile(): File
The CodeNarc configuration file to use. |
|
open fun getIgnoreFailures(): Boolean
Whether the build should break when the verifications performed by this task fail. |
|
open fun getMaxPriority1Violations(): Int
The maximum number of priority 1 violations allowed before failing the build. |
|
open fun getMaxPriority2Violations(): Int
The maximum number of priority 2 violations allowed before failing the build. |
|
open fun getMaxPriority3Violations(): Int
The maximum number of priority 3 violations allowed before failing the build. |
|
open fun getObjectFactory(): ObjectFactory
Injects and returns an instance of org.gradle.api.model.ObjectFactory. |
|
open fun getReports(): CodeNarcReports
The reports to be generated by this task. |
|
open fun getSource(): FileTree
{@inheritDoc} |
|
open fun reports(closure: Closure<Any>): CodeNarcReportsopen fun reports(configureAction: Action<in CodeNarcReports>): CodeNarcReports
Configures the reports to be generated by this task. |
|
open fun run(): Unit |
|
open fun setCodenarcClasspath(codenarcClasspath: FileCollection): Unit
The class path containing the CodeNarc library to be used. |
|
open fun setCompilationClasspath(compilationClasspath: FileCollection): Unit
The class path to be used by CodeNarc when compiling classes during analysis. |
|
open fun setConfig(config: TextResource): Unit
The CodeNarc configuration to use. Replaces the |
|
open fun setConfigFile(configFile: File): Unit
The CodeNarc configuration file to use. |
|
open fun setIgnoreFailures(ignoreFailures: Boolean): Unit
Whether the build should break when the verifications performed by this task fail. |
|
open fun setMaxPriority1Violations(maxPriority1Violations: Int): Unit
The maximum number of priority 1 violations allowed before failing the build. |
|
open fun setMaxPriority2Violations(maxPriority2Violations: Int): Unit
The maximum number of priority 2 violations allowed before failing the build. |
|
open fun setMaxPriority3Violations(maxPriority3Violations: Int): Unit
The maximum number of priority 3 violations allowed before failing the build. |
open fun exclude(vararg excludes: String): SourceTaskopen fun exclude(excludes: MutableIterable<String>): SourceTaskopen fun exclude(excludeSpec: Spec<FileTreeElement>): SourceTaskopen fun exclude(excludeSpec: Closure<Any>): SourceTask
{@inheritDoc} |
|
open fun getExcludes(): MutableSet<String>
{@inheritDoc} |
|
open fun getIncludes(): MutableSet<String>
{@inheritDoc} |
|
open fun include(vararg includes: String): SourceTaskopen fun include(includes: MutableIterable<String>): SourceTaskopen fun include(includeSpec: Spec<FileTreeElement>): SourceTaskopen fun include(includeSpec: Closure<Any>): SourceTask
{@inheritDoc} |
|
open fun setExcludes(excludes: MutableIterable<String>): SourceTask
{@inheritDoc} |
|
open fun setIncludes(includes: MutableIterable<String>): SourceTask
{@inheritDoc} |
|
open fun setSource(source: FileTree): Unit
Sets the source for this task. open fun setSource(source: Any): Unit
Sets the source for this task. The given source object is evaluated as per |
|
open fun source(vararg sources: Any): SourceTask
Adds some source to this task. The given source objects will be evaluated as per |