Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate to Spotless from Checkstyle #579

Draft
wants to merge 3 commits into
base: dev/0.8
Choose a base branch
from
Draft

Migrate to Spotless from Checkstyle #579

wants to merge 3 commits into from

Conversation

SirEndii
Copy link
Member

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 way more features
    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.
  • Advanced custom steps
    If I need custom steps, I can create custom steps using FormatterStep and FormatterFunc using spotless, which also works for the spotlessApply 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

@SirEndii
Copy link
Member Author

SirEndii commented May 1, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant