chore: Add goimports linter for consistent imports ordering #816
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
orpheuslummis
added
ci/build
shahzadlone
requested changes
Sep 18, 2022
There was a problem hiding this comment.
Thanks for this @orpheuslummis. I made one quick request btw. Also I know this linter rule thankfully has autofix ability, so basically just doing make lint:fix will apply these changes right?
tools/configs/golangci.yaml
Outdated
| goimports: | ||
| # Put imports beginning with prefix after 3rd-party packages. | ||
| # It's a comma-separated list of prefixes. | ||
| # Default: "" |
There was a problem hiding this comment.
This comment line can go, as there is one argument you can provide goimports anyway
Suggested change
| # Default: "" | |
| # Default: "" |
There was a problem hiding this comment.
removed the comment thanks
make lint:fix works, but goimports is not perfect - when the imports list is sorted strangely or in a bad shape it seems to fail at reaching the desired state.
orpheuslummis
force-pushed
the
orpheus/chore/import-ordering-linting
branch
from
ae6a3e9
to
9b4e236
Compare
shahzadlone
pushed a commit
to shahzadlone/defradb
that referenced
this pull request
Feb 23, 2024
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.
Relevant issue(s)
Resolves #815
Description
Enablers
goimportslinter.Sorts imports using
goimports -local "github.com/sourcenetwork/defradb" -w .https://pkg.go.dev/golang.org/x/tools/cmd/goimports is part of official go/x
Tasks
How has this been tested?
automatic lint,
make test, eye ballingSpecify the platform(s) on which this was tested: