Use gofumpt if available, and enable gofumpt linter #3798
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
thaJeztah
force-pushed
the
gofumpt_linting
branch
2 times, most recently
from
380d7fc to
a92c219
Compare
|
@crazy-max @vvoland ptal 😄 |
thaJeztah
commented
Sep 30, 2022
Makefile
Outdated
| go list -f {{.Dir}} ./... | xargs gofmt -w -s -d | ||
| fmt: ## run gofumpt (if present) or gofmt | ||
| @if command -v gofumpt > /dev/null; then \ | ||
| gofumpt -w -d . ; \ |
There was a problem hiding this comment.
gofumpt automatically excludes vendor/ so no need to use go list
|
Hm... interesting; somehow my |
Looks like the linter uses an explicit -lang, which (for go1.19) results in some additional formatting for octal values. Signed-off-by: Sebastiaan van Stijn <[email protected]>
gofumpt provides a supserset of gofmt / go fmt, but not every developer may have it installed, so for situations where it's not available, fall back to gofmt. As our code has been formatted with gofumpt already, in most cases contributions will follow those formatting rules, but in some cases there may be a difference, which would already be flagged by manual code review, but let's also enable the gofumpt linter. With this change, `make fmt` will use gofumpt is available; gofumpt has been added to the dev-container, so `make -f docker.Makefile fmt` will always use it. Signed-off-by: Sebastiaan van Stijn <[email protected]>
thaJeztah
force-pushed
the
gofumpt_linting
branch
from
a92c219 to
c2f1671
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #3798 +/- ##
=======================================
Coverage 59.21% 59.21%
=======================================
Files 288 288
Lines 24605 24605
=======================================
Hits 14571 14571
Misses 9159 9159
Partials 875 875 |
thaJeztah
commented
Sep 30, 2022
| go list -f {{.Dir}} ./... | xargs gofmt -w -s -d | ||
| fmt: ## run gofumpt (if present) or gofmt | ||
| @if command -v gofumpt > /dev/null; then \ | ||
| gofumpt -w -d -lang=1.19 . ; \ |
There was a problem hiding this comment.
Looks like I need to add an explicit -lang=1.19, otherwise it doesn't pick up the go version for which to format. Probably because we don't have a go.mod
|
@crazy-max ptal 🤗 |
crazy-max
approved these changes
Oct 12, 2022
|
Let me bring this one in 👍 |
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.
gofumpt (https://github.com/mvdan/gofumpt) provides a supserset of gofmt / go fmt, but not every developer may have
it installed, so for situations where it's not available, fall back to gofmt.
As our code has been formatted with gofumpt already, in most cases contributions
will follow those formatting rules, but in some cases there may be a difference,
which would already be flagged by manual code review, but let's also enable the
gofumpt linter.
With this change,
make fmtwill use gofumpt is available; gofumpt has beenadded to the dev-container, so
make -f docker.Makefile fmtwill always use it.