Allow configuration of when to run spotless in gradle build

Currently spotless adds itself automatically to the gradle checkTask.

// Add our check task as a dependency on the global check task
// getTasks() returns a "live" collection, so this works even if the
// task doesn't exist at the time this call is made
project.getTasks()
    .matching(task -> task.getName().equals(JavaBasePlugin.CHECK_TASK_NAME))
    .all(task -> task.dependsOn(rootCheckTask));

We would like to be able to decide when to actually run the spotless task or even be able to only run it when directly invoked from the command line like gradlew spotless

e.g. for configuration

spotless {
    ...
}
// new
taskX.dependsOn spotless

[simschla]

as a matter of fact you are totally right both in “when the task is called” and in the statement that spotless is much faster 😉

[nedtwigg]

Here’s gradle’s task dependency graph:

If you’d like to just compile and package, run assemble. If you just want to run tests, run test (or integTest if you’ve made a separate unit test task).

The objective of the check task is (according to the gradle docs):

All verification tasks in the project, including test. Some plugins add additional verification tasks to the project.

You can use Gradle however you’d like, but it sounds like you’re swimming upstream 😃 If you want people to always be able to run gradle build and have it be fast, I’d recommend that you instead print out the task graph above and leave it on their desk, and then they’ll know which tasks to run for themselves, depending on how fast they’d like their result.

Also, spotless is much faster than a reasonable unit test suite 😃