chore(Makefile): ensure that make fmt/go only formats go source files #15971
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
mafredri
approved these changes
Dec 30, 2024
| @@ -417,12 +417,14 @@ RESET := $(shell tput sgr0 2>/dev/null) | |||
| fmt: fmt/ts fmt/go fmt/terraform fmt/shfmt fmt/prettier | |||
| .PHONY: fmt | |||
|
|
|||
| GO_FMT_FILES := $(shell find . $(FIND_EXCLUSIONS) -type f -name '*.go' -exec sh -c 'grep -L "DO NOT EDIT" "{}" 2>/dev/null || true' \;) | |||
There was a problem hiding this comment.
Suggested change
| GO_FMT_FILES := $(shell find . $(FIND_EXCLUSIONS) -type f -name '*.go' -exec sh -c 'grep -L "DO NOT EDIT" "{}" 2>/dev/null || true' \;) | |
| GO_FMT_FILES := $(shell find . $(FIND_EXCLUSIONS) -type f -name '*.go' -exec sh -c 'grep -L "DO NOT EDIT" {} 2>/dev/null || true' \;) |
{} is a shell-safe replacement, not supposed to be quoted:
❯ touch 'foo"bar"'
❯ find . -type f -exec sh -c 'grep foo "{}"' \;
grep: ./foobar: No such file or directory
There was a problem hiding this comment.
Actually, calling sh here is the main problem, but quoting {} should also be avoided 😄.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
An unfortunate branch name resulted in failures when running
make fmt/goand consequentlymake fmt. fmt should not be run on the .git directory. This PR excludes.gitand anything else that's not a go source file in the currently checked out branch from the consideration ofmake fmt/go.