gradle-quality-plugin

Additional

Language
Groovy
Version
4.0.0 (Nov 16, 2019)
Created
Nov 19, 2015
Updated
Nov 18, 2019
Owner
Vyacheslav Rusakov (xvik)
Contributor
Vyacheslav Rusakov (xvik)
1
Activity
Badge
Generate
Download
Source code

Promotion

Gradle quality plugin

DOCUMENTATION http://xvik.github.io/gradle-quality-plugin

About

Static code analysis for Java and Groovy projects using Checkstyle, PMD, CPD, SpotBugs and CodeNarc. Plugin implements unified console output for all quality plugins, which greatly simplifies developer workflow: only console required for working with violations and makes it feel the same as java compiler errors.

Features:

  • Zero configuration by default: provided opinionated configs applied to all quality plugins
    • Default configuration files may be customized
  • Adds extra javac lint options to see more warnings
  • Complete console output for all quality plugins
  • Html and xml reports for all plugins (custom xsl used for findbugs html report because it can't generate both xml and html reports)
  • Grouping tasks to run registered quality plugins for exact source set (e.g. checkQualityMain)
Summary
  • Configuration: quality
  • Tasks:
    • initQualityConfig - copy default configs for customization
    • checkQuality[Main] - run quality tasks for main (or any other) source set
  • Enable plugins: Checkstyle, PMD, SpotBugs, CodeNarc

Setup

NOTE: when updating plugin version in your project don't forget to call clean task to remove cached configs from previous plugin version

plugins {
    id 'ru.vyarus.quality' version '4.0.0'
}

OR

buildscript {
    repositories {
        jcenter()
        gradlePluginPortal()
    }
    dependencies {
        classpath 'ru.vyarus:gradle-quality-plugin:4.0.0'
    }
}
apply plugin: 'ru.vyarus.quality'

Minimal requirements: java 8, gradle 5.1

Usage

Read documentation

Might also like