Add max limit of 2 groups to import blocks #566
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 @@
## main #566 +/- ##
=======================================
Coverage 34.76% 34.76%
=======================================
Files 44 44
Lines 3348 3348
=======================================
Hits 1164 1164
Misses 2085 2085
Partials 99 99
Continue to review full report at Codecov.
|
mmlb
force-pushed
the
enforce-max-num-import-groups
branch
from
1bbd307 to
94073ce
Compare
Signed-off-by: Manuel Mendez <[email protected]>
There isn't a whole lot of direction from the go project or tools for this. A quick google search did turn up 2 projects that also document 2 groups, both [Uber] and [CockroachDB]. We do have both goimports and gofumpt splitting stdlib vs others out if they are mixed. But they don't do any futher kind of grouping. So in the absence of concrete handling lets just settle on 2 because its easy to enforce. The script below deletes newlines within `import ( ... )` blocks and then runs gofumpt which will split and sort 2 at most 2 groups. [Uber]: https://github.com/uber-go/guide/blob/22f61e283ac2f75ba34b62f565581cc70e35fb7a/style.md#import-group-ordering [CockroachDB]: https://web.archive.org/web/20210509102622/https://wiki.crdb.io/wiki/spaces/CRDB/pages/181371303/Go+Golang+coding+guidelines#Import-Group-Ordering Signed-off-by: Manuel Mendez <[email protected]>
mmlb
force-pushed
the
enforce-max-num-import-groups
branch
from
94073ce to
d05bf69
Compare
markjacksonfishing
approved these changes
Dec 9, 2021
nshalman
approved these changes
Dec 9, 2021
Good question @nshalman ! Just this PR or the whole file? (I think latter tbh). |
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.
Description
Updates CONTRIBUTING.md with a Go style item.
Also enforces the new style via code in ./ci-checks.sh
Why is this needed
Consistency within the code base.
How Has This Been Tested?
Ran locally.
How are existing users impacted? What migration steps/scripts do we need?
NA
Checklist:
I have: