'make fmt' handles imports too (#12837)

Signed-off-by: David L. Chandler <[email protected]>

Author: chandler-solo

.golangci.yaml

@@ -172,7 +172,18 @@ issues:
   uniq-by-line: true
 formatters:
   enable:
-    - goimports
+    - gofmt
+    - gci
+  settings:
+    gci:
+      sections:
+      - standard
+      - default
+      - prefix(github.com/kgateway-dev)
+      - blank
+      - dot
+      - localmodule
+      custom-order: true
   exclusions:
     generated: lax
     paths:

Makefile

@@ -79,6 +79,16 @@ $(BUG_REPORT_DIR):
 # Base Alpine image used for all containers. Exported for use in goreleaser.yaml.
 export ALPINE_BASE_IMAGE ?= alpine:3.17.6
 
+GO_VERSION := $(shell cat go.mod | grep -E '^go' | awk '{print $$2}')
+GOTOOLCHAIN ?= go$(GO_VERSION)
+
+DEPSGOBIN ?= $(OUTPUT_DIR)
+GOLANGCI_LINT ?= go tool golangci-lint
+ANALYZE_ARGS ?= --fix --verbose
+CUSTOM_GOLANGCI_LINT_BIN ?= $(DEPSGOBIN)/golangci-lint-custom
+CUSTOM_GOLANGCI_LINT_RUN ?= $(CUSTOM_GOLANGCI_LINT_BIN) run --build-tags e2e
+CUSTOM_GOLANGCI_LINT_FMT ?= $(CUSTOM_GOLANGCI_LINT_BIN) fmt
+
 #----------------------------------------------------------------------------------
 # Macros
 #----------------------------------------------------------------------------------
@@ -91,19 +101,17 @@ get_sources = $(shell find $(1) -name "*.go" | grep -v test | grep -v generated.
 # Repo setup
 #----------------------------------------------------------------------------------
 
-GOIMPORTS ?= go tool goimports
-
 .PHONY: init-git-hooks
 init-git-hooks:  ## Use the tracked version of Git hooks from this repo
 	git config core.hooksPath .githooks
 
 .PHONY: fmt
-fmt:  ## Format the code with goimports
-	$(GOIMPORTS) -local "github.com/kgateway-dev/kgateway/v2/"  -w $(shell ls -d */ | grep -v vendor)
+fmt: $(CUSTOM_GOLANGCI_LINT_BIN)  ## Format the code with golangci-lint
+	$(CUSTOM_GOLANGCI_LINT_FMT) ./...
 
 .PHONY: fmt-changed
-fmt-changed:  ## Format the code with goimports
-	git diff --name-only | grep '.*.go$$' | xargs -- $(GOIMPORTS) -w
+fmt-changed: $(CUSTOM_GOLANGCI_LINT_BIN)  ## Format only the changed code with golangci-lint
+	git status -s -uno | awk '{print $2}' | grep '.*.go$$' | xargs -r $(CUSTOM_GOLANGCI_LINT_FMT)
 
 # must be a separate target so that make waits for it to complete before moving on
 .PHONY: mod-download
@@ -123,20 +131,11 @@ mod-tidy: mod-download mod-tidy-nested ## Tidy the go mod file
 # Analyze
 #----------------------------------------------------------------------------
 
-GO_VERSION := $(shell cat go.mod | grep -E '^go' | awk '{print $$2}')
-GOTOOLCHAIN ?= go$(GO_VERSION)
-
-DEPSGOBIN ?= $(OUTPUT_DIR)
-GOLANGCI_LINT ?= go tool golangci-lint
-ANALYZE_ARGS ?= --fix --verbose
-
-CUSTOM_GOLANGCI_LINT_BIN ?= $(DEPSGOBIN)/golangci-lint-custom
 .PHONY: analyze
 analyze: $(CUSTOM_GOLANGCI_LINT_BIN)  ## Run golangci-lint. Override options with ANALYZE_ARGS.
-	$(CUSTOM_GOLANGCI_LINT_BIN) run $(ANALYZE_ARGS) --build-tags e2e ./...
+	$(CUSTOM_GOLANGCI_LINT_RUN) $(ANALYZE_ARGS) ./...
 
-.PHONY: $(CUSTOM_GOLANGCI_LINT_BIN)
-$(CUSTOM_GOLANGCI_LINT_BIN):
+$(CUSTOM_GOLANGCI_LINT_BIN): go.mod go.sum .custom-gcl.yml
 	GOTOOLCHAIN=$(GOTOOLCHAIN) $(GOLANGCI_LINT) custom
 
 ACTION_LINT ?= go tool github.com/rhysd/actionlint/cmd/actionlint
@@ -340,12 +339,14 @@ clean-stamps:
 $(STAMP_DIR)/go-generate-apis: $(API_SOURCE_FILES) | $(STAMP_DIR)
 	@echo "Running API code generation..."
 	GO111MODULE=on go generate ./hack/...
+	$(MAKE) fmt-changed
 	@touch $@
 
 # Mock generation with dependency tracking
 $(STAMP_DIR)/go-generate-mocks: $(MOCK_SOURCE_FILES) | $(STAMP_DIR)
 	@echo "Running mock generation..."
 	GO111MODULE=on go generate -run="mockgen" ./...
+	$(MAKE) fmt-changed
 	@touch $@
 
 # Combine both generation steps
@@ -369,9 +370,9 @@ $(STAMP_DIR)/generate-licenses: $(MOD_FILES) | $(STAMP_DIR)
 	@touch $@
 
 # Formatting - only runs if generation steps changed
-$(STAMP_DIR)/fmt: $(STAMP_DIR)/go-generate-all
+$(STAMP_DIR)/fmt: $(STAMP_DIR)/go-generate-all $(CUSTOM_GOLANGCI_LINT_BIN)
 	@echo "Formatting code..."
-	$(GOIMPORTS) -local "github.com/kgateway-dev/kgateway/v2/"  -w $(shell ls -d */ | grep -v vendor)
+	$(CUSTOM_GOLANGCI_LINT_FMT) ./...
 	@touch $@
 
 # Fast generation using stamp files (for local development)

api/v1alpha1/zz_generated.deepcopy.go

@@ -13,6 +13,6 @@ Here is a description of each sub-target and its purpose:
 | `go-generate-mocks` | Invokes all mockgen generate directives in the repo | There is an interface API change | 2:30-3m |
 | `mod-download` | Calls `go mod download all` | Dependencies are not all present locally | 1s (if deps are already downloaded) |
 | `mod-tidy` | Calls `go mod tidy` | Dependencies have been added, updated, or removed | 1-2s |
-| `fmt` | Runs [`goimports`](https://pkg.go.dev/golang.org/x/tools/cmd/goimports) which updates imports and formats code | Code has been modified (any change, in case it's not properly formatted) | 9-13s |
+| `fmt` | Runs golangci-lint with the `gci` formatter which organizes imports and formats code | Code has been modified (any change, in case it's not properly formatted) | 9-13s |
 | `clean-gen` | Removes files generated by codegen | An existing generated file may no longer be generated by codegen (rare) | 3s |
 | `generate-licenses` | Generates docs files containing attribution for all dependencies which require it | There is a new dependency or a depency bump | 7-12s |

devel/contributing/code-generation.md

@@ -130,7 +130,6 @@ require (
 	go.yaml.in/yaml/v2 v2.4.3 // indirect
 	go.yaml.in/yaml/v3 v3.0.4 // indirect
 	go.yaml.in/yaml/v4 v4.0.0-rc.2 // indirect
-	golang.org/x/telemetry v0.0.0-20251008203120-078029d740a8 // indirect
 	gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
 	gotest.tools/gotestsum v1.13.0 // indirect
 	oras.land/oras-go/v2 v2.6.0 // indirect
@@ -647,7 +646,6 @@ tool (
 	github.com/goreleaser/goreleaser/v2
 	github.com/onsi/ginkgo/v2/ginkgo
 	github.com/rhysd/actionlint/cmd/actionlint
-	golang.org/x/tools/cmd/goimports
 	gotest.tools/gotestsum
 	helm.sh/helm/v3/cmd/helm
 	k8s.io/code-generator/cmd/applyconfiguration-gen

go.mod

@@ -2018,8 +2018,6 @@ golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/sys v0.37.0 h1:fdNQudmxPjkdUTPnLn5mdQv7Zwvbvpaxqs831goi9kQ=
 golang.org/x/sys v0.37.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
-golang.org/x/telemetry v0.0.0-20251008203120-078029d740a8 h1:LvzTn0GQhWuvKH/kVRS3R3bVAsdQWI7hvfLHGgh9+lU=
-golang.org/x/telemetry v0.0.0-20251008203120-078029d740a8/go.mod h1:Pi4ztBfryZoJEkyFTI5/Ocsu2jXyDr6iSdgJiYE/uwE=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=

go.sum

@@ -68,7 +68,3 @@ go tool client-gen \
 
 go generate ${ROOT_DIR}/internal/...
 go generate ${ROOT_DIR}/pkg/...
-
-# fix imports of gen code
-go tool goimports -local "github.com/kgateway-dev/kgateway/v2/" -w ${ROOT_DIR}/${CLIENT_GEN_DIR}
-go tool goimports -local "github.com/kgateway-dev/kgateway/v2/" -w ${ROOT_DIR}/api

hack/generate.sh

@@ -2,6 +2,7 @@ package main
 
 import (
 	"github.com/kgateway-dev/kgateway/hack/utils/applier/cmd"
+
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 )
 

hack/utils/applier/main.go

@@ -5,9 +5,10 @@ import (
 	envoyclusterv3 "github.com/envoyproxy/go-control-plane/envoy/config/cluster/v3"
 	envoycorev3 "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"
 	envoyendpointv3 "github.com/envoyproxy/go-control-plane/envoy/config/endpoint/v3"
+	"google.golang.org/protobuf/types/known/structpb"
+
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-	"google.golang.org/protobuf/types/known/structpb"
 
 	. "github.com/kgateway-dev/kgateway/v2/internal/envoyinit/pkg/downward"
 )

internal/envoyinit/pkg/downward/transform_test.go

@@ -3,11 +3,12 @@ package admin_test
 import (
 	"errors"
 
-	. "github.com/onsi/ginkgo/v2"
-	. "github.com/onsi/gomega"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
 	"github.com/kgateway-dev/kgateway/v2/internal/kgateway/admin"
 )