Migrate to Spotless from Checkstyle #579
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Advanced Peripherals currently uses the gradle checkstyle plugin to be able to maintain a uniform code style in the project.
But there are two main reasons why I want to switch from checkstyle to spotless.
Spotless has a wider range of features. One among them is the
spotlessApply
task to just fix the style issues automatically while maintaining license headers.If I need custom steps, I can create custom steps using
FormatterStep
andFormatterFunc
using spotless, which also works for thespotlessApply
task. Checkstyle "only" allows custom regex checks. Which isn't bad, but I just can do more with these java based custom steps.Currently, there aren't any custom steps. The eclipse formatter used provides a decent code style I really like. But I will consider adding custom steps for our annotation and one-liner if statement guidelines