Merged
Conversation
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 a first-class sbt setting for controlling google-java-format's Javadoc formatting behavior:
javafmtFormatJavadocThis follows the same direction as the recent CLI-backed settings such as:
javafmtSortImportsjavafmtRemoveUnusedImportsjavafmtReflowLongStringsInstead of requiring users to go through
javafmtOptions, the common sbt-facing configuration is now exposed directly as a dedicated setting:Why this change?
Since the plugin now runs google-java-format in a forked JVM via its CLI, the natural public API is the set of CLI-backed formatter toggles exposed as normal sbt settings. That makes configuration more explicit and easier to discover in the
README, andreduces reliance on the upstream
JavaFormatterOptionsobject as the primary user-facing API.This PR also updates the README to clarify the current state of
javafmtOptions:javafmt...settingsJavaFormatterOptions.reorderModifiers()currently has no effect in this plugin, because the released google-java-format CLI used here does not yet support a corresponding--skip-reordering-modifiersflag. See:reorderModifiers = falsevia google-java-format CLI #266Finally, this adds a scripted test that verifies
javafmtFormatJavadoc := falsepreserves Javadoc content formatting while still applying normal code formatting around it.