Make the runToFix message customizable in SpotlessCheck

There’s been some broad discussion in the Lucene project about the sense of having per-project messages in SpotlessCheck:

				throw new GradleException(DiffMessageFormatter.builder()
						.runToFix("Run '" + calculateGradleCommand() + " " + getTaskPathPrefix() + "spotlessApply' to fix these violations.") 

Many people expressed the opinion that this is just confusing for new users (you fix one violation in one module, then you get an exception elsewhere) and the message should just be “global”. I wonder if it’d be possible to add a hook that could customize the returned message (perhaps a hook accepting DiffMessageFormatter.Builder)? Then you could set runToFix to a project-specific message (or task).

This is a suggestion but it is really difficult to work around in any other way. If you think it’d be acceptable, I can provide a patch. Thank you.

[nedtwigg]

Published in plugin-gradle 6.5.0.

[dweiss]

I think I know what caused this - I used my own fork to create a PR. When you clone your own fork, origin/main may be out of sync (before the feature branch you’re contributing). This causes ratchetFrom to go haywire. A clean checkout indeed passes tests but this won’t:

git clone [e-mail]:dweiss/spotless.git -b customRunToFix
cd spotless
./gradlew spotlessCheck

That configuration cache test still fails for me (on beefy windows machine) - can’t say whether it’s a race condition somewhere or if it’s the environment itself. On Linux it seems to work fine.