Welcome to gradle quality plugin¶
Plugin configures quality tools for java and groovy projects.
- Auto enabled plugins: Checkstyle, PMD, CodeNarc.
- External plugins (configured when manually applied): SpotBugs, CPD, AnimalSniffer,
Plugin unifies 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.
Also, plugin provides default (opinionated) configurations for quality tools, so you can use them with zero configuration.
Release Notes - History - License
Main 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)
Note
The plugin is compatible with the gradle configuration cache
How to use docs¶
- Getting started covers installation and main usage info. Ideal for introduction.
- User guide section contain detailed behavior description. Good to read, but if no time, read as you need it.
- Configuration - configuration reference
- Tools section describes exact quality tool configuration and usage aspects. Use it as a hand book.
- Tasks section describes custom tasks.