Add javafmtFixImports tasks for import-only mode#268
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 dedicated import-only tasks backed by google-java-format's
--fix-imports-onlyCLI mode.New tasks:
javafmtFixImportsjavafmtFixImportsCheckjavafmtFixImportsAlljavafmtFixImportsCheckAllWhy tasks instead of a setting?
--fix-imports-onlyis not just another formatting preference. It changes the meaning of the run from "format this file" to "only touch imports and leave the rest of the file alone". Because of that, modeling it as a persistent setting would be surprising:enabling it would silently change what
javafmtandjavafmtCheckdo.Dedicated tasks make that behavior explicit:
javafmtandjavafmtCheckremain full formatting tasksjavafmtFixImportsandjavafmtFixImportsCheckare clearly import-only operationsThis also fits better with how people use it in practice. Import-only cleanup is usually something you invoke intentionally for a specific workflow, not a mode you want to keep enabled all the time.
Behavior details:
javafmtFixImports...does not format the rest of the Java filejavafmtRemoveUnusedImportsandjavafmtSortImportsinfluence these tasksThis PR also adds scripted coverage for the new import-only tasks and documents them in the README.