Skip to content

chore(Makefile): ensure that make fmt/go only formats go source files #15971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 30, 2024
Merged

chore(Makefile): ensure that make fmt/go only formats go source files #15971

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
03e5a9e
chore(Makefile) ignore non go source files when running make fmt/go
SasSwart Dec 29, 2024
4fb0d41
make fmt
SasSwart Dec 29, 2024
037c7a9
oops
SasSwart Dec 29, 2024
ad7820d
ensure that generated files are formatted.
SasSwart Dec 29, 2024
c25f9d9
make fmt
SasSwart Dec 29, 2024
cbde1b5
don't format .pb.go files as they are generated
SasSwart Dec 30, 2024
80e39a0
don't format generated go files
SasSwart Dec 30, 2024
d25cf8a
revert change to gen/mark-fresh
SasSwart Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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' \;)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, calling sh here is the main problem, but quoting {} should also be avoided 😄.


fmt/go:
go mod tidy
echo "$(GREEN)==>$(RESET) $(BOLD)fmt/go$(RESET)"
# VS Code users should check out
# https://github.com/mvdan/gofumpt#visual-studio-code
go run mvdan.cc/gofumpt@v0.4.0 -w -l .
go run mvdan.cc/gofumpt@v0.4.0 -w -l $(GO_FMT_FILES)
.PHONY: fmt/go

fmt/ts:
Expand Down Expand Up @@ -511,9 +513,7 @@ TAILNETTEST_MOCKS := \
tailnet/tailnettest/workspaceupdatesprovidermock.go \
tailnet/tailnettest/subscriptionmock.go


# all gen targets should be added here and to gen/mark-fresh
gen: \
GEN_FILES := \
tailnet/proto/tailnet.pb.go \
agent/proto/agent.pb.go \
provisionersdk/proto/provisioner.pb.go \
Expand All @@ -538,6 +538,9 @@ gen: \
examples/examples.gen.json \
$(TAILNETTEST_MOCKS) \
coderd/database/pubsub/psmock/psmock.go

# all gen targets should be added here and to gen/mark-fresh
gen: $(GEN_FILES)
.PHONY: gen

# Mark all generated files as fresh so make thinks they're up-to-date. This is
Expand Down
Loading