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

[Experiment] Replace checkstyle with spotless #837

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

Conversation

Rover656
Copy link
Member

Description

This is experimenting with the spotless Gradle plugin, instead of checkstyle. This will cause builds to fail if files are formatted incorrectly, but spotlessApply will automatically reformat the problematic files.

In this PR, it is fully enabled for EnderCore -but- only enabled for new changes for other subprojects, this is to keep the diff small in this PR and to not break outstanding PRs. Once the PR list is quieter I'll flip the switch and reformat the entire project.

TODO

  • Get core maintainer approval.
  • Update docs to make other contributors aware of spotlessCheck and spotlessApply.

Checklist

  • My code follows the style guidelines of this project (.editorconfig, most IDEs will use this for you).
  • I have made corresponding changes to the documentation.
  • My changes are ready for review from a contributor.

@Rover656
Copy link
Member Author

Going to request review from Ferri, chonky and Lilian - if you folks would like to take a look at this and see whether you'd be happy adopting this plugin & style, please let me know!

@Rover656 Rover656 changed the base branch from dev/1.21 to dev/1.21.1 September 30, 2024 16:39
@Rover656 Rover656 force-pushed the feat/spotless-experiments branch 4 times, most recently from 9f6cd60 to bbb25f0 Compare September 30, 2024 21:10
Formatting will only apply to new changes on all projects except EnderCore as a trial.
Copy link
Contributor

@dphaldes dphaldes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now!

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.

2 participants