Package org.gradle.api.plugins.quality

Class CodeNarcExtension

java.lang.Object
org.gradle.api.plugins.quality.CodeQualityExtension
org.gradle.api.plugins.quality.CodeNarcExtension
public abstract class CodeNarcExtension extends CodeQualityExtension
Configuration options for the CodeNarc plugin.
See Also:

  • Constructor Details

    • CodeNarcExtension

      public CodeNarcExtension(Project project)

  • Method Details

    • getConfig

      public TextResource getConfig()
      The CodeNarc configuration to use. Replaces the configFile property.
      Since:
      2.2

    • setConfig

      public void setConfig(TextResource config)
      The CodeNarc configuration to use. Replaces the configFile property.
      Since:
      2.2

    • getConfigFile

      public File getConfigFile()
      The CodeNarc configuration file to use.

    • setConfigFile

      public void setConfigFile(File file)
      The CodeNarc configuration file to use.

    • getMaxPriority1Violations

      public abstract Property<Integer> getMaxPriority1Violations()
      The maximum number of priority 1 violations allowed before failing the build.

    • getMaxPriority2Violations

      public abstract Property<Integer> getMaxPriority2Violations()
      The maximum number of priority 2 violations allowed before failing the build.

    • getMaxPriority3Violations

      public abstract Property<Integer> getMaxPriority3Violations()
      The maximum number of priority 3 violations allowed before failing the build.

    • getReportFormat

      public abstract Property<String> getReportFormat()
      The format type of the CodeNarc report. One of html, xml, text, console.