Gradle Quality Check Plugin

Supported tools

• Checkstyle
• PMD
• SpotBugs
• JaCoCo
• Pitest

Add the plugin to your project

Using the plugins DSL:

plugins {
  id "com.github.neherim.quality.check" version "0.1.8"
}

Using legacy plugin application:

buildscript {
  repositories {
    maven {
      url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    classpath "gradle.plugin.com.github.neherim:gradle-quality-check-plugin:0.1.8"
  }
}

apply plugin: "com.github.neherim.quality.check"

Configuration

qualityCheck {
  checkstyle {
    enabled = true
    toolVersion = "8.30"
    configFile = "config/checkstyle/checkstyle.xml"
    ignoreFailures = false
    showViolations = true
    include = ["**/*.java"]
    exclude = []
    maxWarnings = 0
    maxErrors = 0
    htmlReport = true
    xmlReport = true
    reportsDestination = ""
  }
  pmd {
    enabled = true
    toolVersion = "6.22.0"
    ruleSetFile = "config/pmd/pmd.xml"
    ignoreFailures = false
    source = "src"
    include = ["**/*.java"]
    exclude = []
    consoleOutput = false
    xmlReport = true
    htmlReport = true
  }
  spotbugs {
    enabled = true
    toolVersion = "4.0.1"
    excludeFilter = "config/spotbugs/spotbugs.xml"
    ignoreFailures = false
    effort = "max"
    reportLevel = "medium"
    include = ["**/*.java"]
    exclude = []
    reportFormat = "xml" // html | xml | text | emacs
    plugins = ["findsecbugs"]
  }
  jacoco {
    enabled = true
    exclude = []
    toolVersion = "0.8.5"
    xmlReportEnabled = true
    csvReportEnabled = false
    htmlReportEnabled = true
    xmlReportsDestination = file(null)
    csvReportsDestination = file(null)
    htmlReportsDestination = file(null)
  }
  pitest {
    enabled = true
    toolVersion = "1.5.0"
    testPlugin = "junit" // junit | junit5 
    threads = 4
    outputFormats = ["XML", "HTML"]
    targetClasses = []
    excludedClasses = []
    timestampedReports = false
  }
}