Package org.gradle.api.plugins.quality

Class CodeNarcExtension

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

  • Constructor Details

    • CodeNarcExtension

      public CodeNarcExtension(Project project)

  • Method Details

    • getConfig

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

    • setConfig

      @Incubating 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 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

      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

      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.

    • getReportFormat

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

    • setReportFormat

      public void setReportFormat(String reportFormat)
      The format type of the CodeNarc report. One of html, xml, text, console.