README.md

Gradle Quality plugins

Plugins that configure the built-in plugins with saner defaults (to be documented).

• CheckStyle
• PMD
• Android Lint

Current goal is to make Android support better, because of build types and flavors.

---

For details on what was changed in different versions, see CHANGELOG.

Compatibility

Android Gradle Plugin 3.1.4 — 8.6.1 on Gradle 4.9 — 8.8 as listed in AGP's compatibility guide are covered by different plugin versions.

Currently supported version are Android Gradle Plugin 7.0.2 — 8.6.1 on Gradle 7.0 — 8.7 where compatible.

AGP → Gradle ↓	3.1.x	3.2.x	3.3.x	3.4.x	3.5.x	3.6.x	4.0.x	4.1.x	4.2.x ^3	7.0.x	7.1.x	7.2.x	7.3.x	7.4.x	8.0.x	8.1.x	8.2.x	8.3.x	8.4.x
4.4 - 4.8.1	0.5 - 0.7	^1	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
4.9 - 4.10	0.8 - 0.14	0.7 - 0.14	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
4.10.1 - 5.1	❓	0.8 - 0.14	0.8 - 0.14	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
5.1.1 - 5.4	❓	❓	0.9 - 0.14	0.9 - 0.15.1	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
5.4.1 - 5.6.3	❓	❓	0.9 - 0.15.1	0.9 - 0.15.1	sup.	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
5.6.4	❓	❓	❓	❓	0.10 - 0.15.1	0.10 - 0.15.1	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
6.0 - 6.1	❓	❓	❓	❓	0.11 - 0.15.1	0.11 - 0.15.1	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
6.1.1 - 6.4.1	❓	❓	❓	❓	0.11 - 0.15.1	0.11 - 0.15.1	0.11 - 0.15.1	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
6.5 - 6.7	❓	❓	❓	❓	0.11 - 0.15.1	0.11 - 0.15.1	0.11 - 0.15.1	0.11 - 0.15.1	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
6.7.1 - 6.9.4 ^3	❓	❓	❓	❓	❓	❓	❓	0.11 - 0.15.1	0.11 - 0.15.1	❌	❌	❌	❌	❌	❌	❌	❌	❌	❌
7.0 - 7.1.2	❓	❓	❓	❓	❓	❓	❓	❓	0.13 - 0.15.1	0.13 - ∞	❌	❌	❌	❌	❌	❌	❌	❌	❌
7.2	❓	❓	❓	❓	❓	❓	❓	❓	0.13 - 0.15.1	0.13 - ∞	0.14 - ∞	❌	❌	❌	❌	❌	❌	❌	❌
7.3 - 7.3.3	❓	❓	❓	❓	❓	❓	❓	❓	0.13 - 0.15.1	0.13 - ∞	0.14 - ∞	0.14 - ∞	❌	❌	❌	❌	❌	❌	❌
7.4 - 7.4.2	❓	❓	❓	❓	❓	❓	❓	❓	0.14 - 0.15.1	0.14 - ∞	0.14 - ∞	0.14 - ∞	0.15 - ∞	❌	❌	❌	❌	❌	❌
7.5 - 7.5.1	❓	❓	❓	❓	❓	❓	❓	❓	0.14 - 0.15.1	0.14 - ∞	0.14 - ∞	0.14 - ∞	0.15 - ∞	0.15 - ∞	❌	❌	❌	❌	❌
7.6 - 7.6.1	❓	❓	❓	❓	❓	❓	❓	❓	0.14 - 0.15.1	0.14 - ∞	0.14 - ∞	0.14 - ∞	0.15 - ∞	0.15 - ∞	❌	❌	❌	❌	❌
8.0 - 8.2	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	0.15 - ∞	0.16 - ∞	0.16 - ∞	❌	❌	❌
8.3	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	0.17 - ∞	0.17 - ∞	0.17 - ∞	0.17 - ∞	❌	❌
8.4 - 8.5	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	0.17 - ∞	0.17 - ∞	0.17 - ∞	0.17 - ∞	0.17 - ∞	❌
8.6 - 8.7	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	❓	0.17 - ∞	0.17 - ∞	0.17 - ∞	0.17 - ∞	0.17 - ∞	0.17 - ∞

• ❓ = not sure if it's supported by AGP, never tested.
• ❌ = incompatible based on AGP compatibility.
• sup. = supported based on AGP compatibility, but not tested.
• N/A = full support not available yet, only preliminary support based on alpha/beta builds of AGP.
• ∞ = latest version
• ^1 = Gradle 4.4 — 4.9 for AGP 3.2 was never supported, because it's hard to backport the lazy task configuration APIs.
• ^2 = Convention plugins only support AGP 4.0.0 — 4.2.2 on Gradle 6.1.1+, because it's really hard to backport all the features to 3.x with no need for this.
• ^3 = Version 0.16 dropped support for AGP 3.x — 4.x on Gradle 5.x — 7.x, to make this project easier to maintain.

Quick setup

There are different ways to use a Gradle plugin, choose your poison below.

modern build.gradle(.kts) (plugins)

plugins {
	id("net.twisterrob.gradle.plugin.quality") version "x.y"
}

normal build.gradle(.kts) (buildscript)

buildscript {
	repositories {
		mavenCentral()
	}
	dependencies {
		classpath("net.twisterrob.gradle:twister-quality:x.y")
	}
}
// Kotlin
apply(plugin = "net.twisterrob.gradle.plugin.quality")
// Groovy
apply plugin: "net.twisterrob.gradle.plugin.quality"

buildSrc classpath

buildSrc/build.gradle(.kts)

repositories {
	mavenCentral()
}
dependencies {
	implementation("net.twisterrob.gradle:twister-quality:x.y")
}

build.gradle(.kts)

// Kotlin
apply(plugin = "net.twisterrob.gradle.plugin.quality")
// Groovy
apply plugin: "net.twisterrob.gradle.plugin.quality"

For more, see the examples folder.

Features

HTML violation report

There's a built-in HTML report that gathers all the results from all the modules into a single HTML file.

gradlew :violationReportHtml

Console violation report

There's a built-in console report that gathers all the results from all the modules and outputs results to the console.

gradlew :violationReportConsole

Count violation report to file

It just saves the number of violations into a file. Good for automation.

gradlew :violationCountFile

Fail the build on violation

It just fails if there are violations.

gradlew :validateViolations

Root project test report

Gathers results from submodules and fails if there were errors.

gradlew :testReport

Note: this changes the :*:test test tasks to not fail so a whole project encompassing report can be generated.

Global finalizer :lint task

Depends on all the other lints and shows a summary of failures to reduce the need to scroll/scan the build logs. If invoked explicitly as gradlew :lint it'll fail, otherwise (e.g. gradlew lint) it just silently adds itself to the list of lint tasks along with the others and prints the summary at the end.

To disable:

afterEvaluate { tasks.named("lint").configure { it.enabled = false } }

Contributions, custom builds

See development.md on how to set this project up.