binkley / modern-java-practices

Modern Java/JVM Build Practices
The Unlicense
920 stars 69 forks source link

Document Spotless #535

Closed binkley closed 1 week ago

binkley commented 3 weeks ago

See #462 for the epic. The card is marked MVP as it is in progress. Remove the "mvp" label if that makes sense.

Context

Show Spotless in the Gradle and Maven build even though Checkstyle remains the example default. So both Gradle & Maven have flags/settings that do not run Spotless, but you can still run them specifically on the command line.

Tasks for this story

I removed the first task: it is unreasonable for a book to deal with slight formatting changes; developers using the writing can figure that out. 😄

Acceptance criteria

Scenario: Reading the book GIVEN the documentation in the book WHEN a reader reads about code style checks THEN there is an example in the book and example code for configuring Spotless to check style for both Gradle and Maven

binkley commented 3 weeks ago

Checkstyle current configuration file is less lenient that Spotless. An example is that {} is OK with Checkstyle but Spotless wants { } (note the space).