Apply consistent import ordering with spotless #1811
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## release/3.x #1811 +/- ##
=================================================
+ Coverage 86.76% 86.76% +<.01%
- Complexity 2490 2494 +4
=================================================
Files 311 311
Lines 6542 6552 +10
Branches 821 821
=================================================
+ Hits 5676 5685 +9
Misses 670 670
- Partials 196 197 +1
Continue to review full report at Codecov.
|
bric3
reviewed
Oct 31, 2019
Comment on lines
+97
to
+103
| 1. `import static java.*` | ||
| 1. `import static javax.*` | ||
| 1. `import static all other imports` | ||
| 1. blank line | ||
| 1. `import java.*` | ||
| 2. `import javax.*` | ||
| 3. `import all other imports` | ||
| 4. blank line | ||
| 5. `import static java.*` | ||
| 6. `import static javax.*` | ||
| 7. `import static all other imports` | ||
| 1. `import javax.*` | ||
| 1. `import all other imports` |
There was a problem hiding this comment.
I think we should also leverage IntelliJ IDEA's .editorconfig extensions for that.
There was a problem hiding this comment.
Yes that should help as well 😄
Spotless allows us to enforce a consistent import order. Configure it such that static imports are first and non-static imports afterwards. Within imports, java imports first, then javax, then all others. This is consistent with the existing CONTRIBUTING.md guidelines, apart from the fact that static imports are first. (File has been updated). I would propose that makes more sense, but happy to discuss. In any case, spotless already found inconsistent ordering within imports themselves, so that is already providing value for consistency. I have also updated the CONTRIBUTING guidelines to explain how `./gradlew spotlessApply` will fix a lot of issues without the developer having to worry about it. That should hopefully help newcomers make changes more confidently. (The only 2 files that are interesting to you are the `build.gradle` and `.github/CONTRIBUTING.md`. All other file changes were automatically performed after running `./gradlew spotlessApply` locally.)
TimvdLippe
force-pushed
the
import-order
branch
from
50e401e
to
594160e
Compare
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.
Spotless allows us to enforce a consistent import order. Configure it
such that static imports are first and non-static imports afterwards.
Within imports, java imports first, then javax, then all others.
This is consistent with the existing CONTRIBUTING.md guidelines, apart
from the fact that static imports are first. (File has been updated). I
would propose that makes more sense, but happy to discuss.
In any case, spotless already found inconsistent ordering within imports
themselves, so that is already providing value for consistency.
I have also updated the CONTRIBUTING guidelines to explain how
./gradlew spotlessApplywill fix a lot of issues without thedeveloper having to worry about it. That should hopefully help newcomers
make changes more confidently.
(The only 2 files that are interesting to you are the
build.gradleand.github/CONTRIBUTING.md. All other file changes were automaticallyperformed after running
./gradlew spotlessApplylocally.)