docs: add information about spotless for code formatting#2622
Merged
jamesarich merged 4 commits intomeshtastic:mainfrom Aug 2, 2025
Merged
docs: add information about spotless for code formatting#2622jamesarich merged 4 commits intomeshtastic:mainfrom
jamesarich merged 4 commits intomeshtastic:mainfrom
Conversation
Clarify that spotless is used for automated code formatting and provide commands for applying formatting and installing a pre-push Git hook. Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
Collaborator
Author
I've been meaning to, you're a good reminder ;) |
Contributor
|
Huh I'm actually getting a failure from within Spotless' install task: |
Collaborator
Author
mm i do remember having to run it with |
The command to install the Spotless Git pre-push hook was updated to include `--no-configuration-cache` to ensure it runs correctly. Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
Contributor
|
Ah I can probably fix that on Spotless' end, they just need to grab the root dir before executing the task |
Contributor
|
Re: spotless - diffplug/spotless#2586 Once that gets merged in and we update spotless I'll update our docs so that we don't need the config cache disable flag. I tested with maven-local install and it worked fine 👍 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds spotless doco to
CONTRIBUTORS.mdClarify that spotless is used for automated code formatting and provide commands for applying formatting and installing a pre-push Git hook.