Merge pull request #401 from sapcc/golangci-lint

Run modernize as part of golangci-lint

Author: majewsky

.golangci.yaml

@@ -57,6 +57,7 @@ linters:
     - intrange
     - iotamixing
     - misspell
+    - modernize
     - nilerr
     - nolintlint
     - nosprintfhostport
@@ -144,6 +145,9 @@ linters:
       enable-all: true
     nolintlint:
       require-specific: true
+    perfsprint:
+      # modernize generates nicer fix code
+      concat-loop: false
     staticcheck:
       dot-import-whitelist:
         - github.com/majewsky/gg/option

Makefile

@@ -42,9 +42,6 @@ install-goimports: FORCE
 install-golangci-lint: FORCE
 	@if ! hash golangci-lint 2>/dev/null; then printf "\e[1;36m>> Installing golangci-lint (this may take a while)...\e[0m\n"; go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@latest; fi
 
-install-modernize: FORCE
-	@if ! hash modernize 2>/dev/null; then printf "\e[1;36m>> Installing modernize (this may take a while)...\e[0m\n"; go install golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest; fi
-
 install-shellcheck: FORCE
 	@if ! hash shellcheck 2>/dev/null; then printf "\e[1;36m>> Installing shellcheck...\e[0m\n"; SHELLCHECK_ARCH=$(shell uname -m); if [[ "$$SHELLCHECK_ARCH" == "arm64" ]]; then SHELLCHECK_ARCH=aarch64; fi; SHELLCHECK_OS=$(shell uname -s | tr '[:upper:]' '[:lower:]'); SHELLCHECK_VERSION="stable"; if command -v curl >/dev/null 2>&1; then GET="curl -sLo-"; elif command -v wget >/dev/null 2>&1; then GET="wget -O-"; else echo "Didn't find curl or wget to download shellcheck"; exit 2; fi; $$GET "https://github.com/koalaman/shellcheck/releases/download/$$SHELLCHECK_VERSION/shellcheck-$$SHELLCHECK_VERSION.$$SHELLCHECK_OS.$$SHELLCHECK_ARCH.tar.xz" | tar -Jxf -; BIN=$$(go env GOBIN); if [[ -z $$BIN ]]; then BIN=$$(go env GOPATH)/bin; fi; install -Dm755 shellcheck-$$SHELLCHECK_VERSION/shellcheck -t "$$BIN"; rm -rf shellcheck-$$SHELLCHECK_VERSION; fi
 
@@ -57,7 +54,7 @@ install-addlicense: FORCE
 install-reuse: FORCE
 	@if ! hash reuse 2>/dev/null; then if ! hash pipx 2>/dev/null; then printf "\e[1;31m>> You are required to manually intervene to install reuse as go-makefile-maker cannot automatically resolve installing reuse on all setups.\e[0m\n"; printf "\e[1;31m>> The preferred way for go-makefile-maker to install python tools after nix-shell is pipx which could not be found. Either install pipx using your package manager or install reuse using your package manager if at least version 6 is available.\e[0m\n"; printf "\e[1;31m>> As your Python was likely installed by your package manager, just doing pip install --user sadly does no longer work as pip issues a warning about breaking your system. Generally running --break-system-packages with --user is safe to do but you should only run this command if you can resolve issues with it yourself: pip3 install --user --break-system-packages reuse\e[0m\n"; else printf "\e[1;36m>> Installing reuse...\e[0m\n"; pipx install reuse; fi; fi
 
-prepare-static-check: FORCE install-golangci-lint install-modernize install-shellcheck install-go-licence-detector install-addlicense install-reuse
+prepare-static-check: FORCE install-goimports install-golangci-lint install-shellcheck install-go-licence-detector install-addlicense install-reuse
 
 # To add additional flags or values (before the default ones), specify the variable in the environment, e.g. `GO_BUILDFLAGS='-tags experimental' make`.
 # To override the default flags or values, specify the variable on the command line, e.g. `make GO_BUILDFLAGS='-tags experimental'`.
@@ -109,10 +106,6 @@ run-golangci-lint: FORCE install-golangci-lint
 	@golangci-lint config verify
 	@golangci-lint run
 
-run-modernize: FORCE install-modernize
-	@printf "\e[1;36m>> modernize\e[0m\n"
-	@modernize $(GO_TESTPKGS)
-
 run-shellcheck: FORCE install-shellcheck
 	@printf "\e[1;36m>> shellcheck\e[0m\n"
 	@find . \( -path './vendor/*' -prune \) -o -type f \( -name '*.bash' -o -name '*.ksh' -o -name '*.zsh' -o -name '*.sh' -o -name '*.shlib' \) -exec shellcheck  {} +
@@ -136,7 +129,7 @@ check-reuse: FORCE install-reuse
 
 check-license-headers: FORCE check-addlicense check-reuse
 
-__static-check: FORCE run-shellcheck run-golangci-lint run-modernize check-dependency-licenses check-license-headers
+__static-check: FORCE run-shellcheck run-golangci-lint check-dependency-licenses check-license-headers
 
 static-check: FORCE
 	@$(MAKE) --keep-going --no-print-directory __static-check
@@ -171,10 +164,6 @@ goimports: FORCE install-goimports
 	@printf "\e[1;36m>> goimports -w -local https://github.com/sapcc/go-makefile-maker\e[0m\n"
 	@goimports -w -local github.com/sapcc/go-makefile-maker $(patsubst $(shell awk '$$1 == "module" {print $$2}' go.mod)%,.%/*.go,$(shell go list ./...))
 
-modernize: FORCE install-modernize
-	@printf "\e[1;36m>> modernize -fix ./...\e[0m\n"
-	@modernize -fix ./...
-
 clean: FORCE
 	git clean -dxf build
 
@@ -208,7 +197,6 @@ help: FORCE
 	@printf "\e[1mPrepare\e[0m\n"
 	@printf "  \e[36minstall-goimports\e[0m            Install goimports required by goimports/static-check\n"
 	@printf "  \e[36minstall-golangci-lint\e[0m        Install golangci-lint required by run-golangci-lint/static-check\n"
-	@printf "  \e[36minstall-modernize\e[0m            Install modernize required by run-modernize/static-check\n"
 	@printf "  \e[36minstall-shellcheck\e[0m           Install shellcheck required by run-shellcheck/static-check\n"
 	@printf "  \e[36minstall-go-licence-detector\e[0m  Install-go-licence-detector required by check-dependency-licenses/static-check\n"
 	@printf "  \e[36minstall-addlicense\e[0m           Install addlicense required by check-license-headers/license-headers/static-check\n"
@@ -223,7 +211,6 @@ help: FORCE
 	@printf "\e[1mTest\e[0m\n"
 	@printf "  \e[36mcheck\e[0m                        Run the test suite (unit tests and golangci-lint).\n"
 	@printf "  \e[36mrun-golangci-lint\e[0m            Install and run golangci-lint. Installing is used in CI, but you should probably install golangci-lint using your package manager.\n"
-	@printf "  \e[36mrun-modernize\e[0m                Install and run modernize. Installing is used in CI, but you should probably install modernize using your package manager.\n"
 	@printf "  \e[36mrun-shellcheck\e[0m               Install and run shellcheck. Installing is used in CI, but you should probably install shellcheck using your package manager.\n"
 	@printf "  \e[36mbuild/cover.out\e[0m              Run tests and generate coverage report.\n"
 	@printf "  \e[36mbuild/cover.html\e[0m             Generate an HTML file with source code annotations from the coverage report.\n"
@@ -238,7 +225,6 @@ help: FORCE
 	@printf "  \e[36mlicense-headers\e[0m              Add (or overwrite) license headers on all non-vendored source code files.\n"
 	@printf "  \e[36mcheck-dependency-licenses\e[0m    Check all dependency licenses using go-licence-detector.\n"
 	@printf "  \e[36mgoimports\e[0m                    Run goimports on all non-vendored .go files\n"
-	@printf "  \e[36mmodernize\e[0m                    Run modernize on all non-vendored .go files\n"
 	@printf "  \e[36mclean\e[0m                        Run git clean.\n"
 
 .PHONY: FORCE

internal/golangcilint/golangci.yaml.tmpl

@@ -57,6 +57,7 @@ linters:
     - intrange
     - iotamixing
     - misspell
+    - modernize
     - nilerr
     - nolintlint
     - nosprintfhostport
@@ -157,6 +158,9 @@ linters:
         - {{ . }}
         {{- end }}
     {{- end }}
+    perfsprint:
+      # modernize generates nicer fix code
+      concat-loop: false
     staticcheck:
       dot-import-whitelist:
         - github.com/majewsky/gg/option

internal/makefile/makefile.go

@@ -109,13 +109,7 @@ endif
 			target:      "install-golangci-lint",
 			recipe:      installTool("golangci-lint", "github.com/golangci/golangci-lint/v2/cmd/golangci-lint@latest"),
 		})
-		prepare.addRule(rule{
-			description: "Install modernize required by run-modernize/static-check",
-			phony:       true,
-			target:      "install-modernize",
-			recipe:      installTool("modernize", "golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@latest"),
-		})
-		prepareStaticRecipe = append(prepareStaticRecipe, "install-golangci-lint", "install-modernize")
+		prepareStaticRecipe = append(prepareStaticRecipe, "install-goimports", "install-golangci-lint")
 	}
 
 	if cfg.ShellCheck.Enabled.UnwrapOr(true) {
@@ -351,31 +345,19 @@ endif
 			},
 		})
 
-		// add target to run modernize
-		test.addRule(rule{
-			description:   "Install and run modernize. Installing is used in CI, but you should probably install modernize using your package manager.",
-			phony:         true,
-			target:        "run-modernize",
-			prerequisites: []string{"install-modernize"},
-			recipe: []string{
-				`@printf "\e[1;36m>> modernize\e[0m\n"`,
-				`@modernize $(GO_TESTPKGS)`,
-			},
-		})
-
 		if cfg.ShellCheck.Enabled.UnwrapOr(true) {
 			// add target to run shellcheck
-			ignorePathArgs := ""
+			var ignorePathArgs strings.Builder
 			for _, path := range cfg.ShellCheck.AllIgnorePaths(cfg.Golang) {
 				if strings.HasPrefix(path, "/") {
 					logg.Fatal("ShellCheck ignore paths must not start with a slash, got: %s", path)
 				}
 
 				// https://github.com/ludeeus/action-shellcheck/blob/master/action.yaml#L120-L124
 				if !strings.HasPrefix(path, "./") {
-					ignorePathArgs += fmt.Sprintf(" \\( -path '*/%s/*' -prune \\) -o", path)
+					fmt.Fprintf(&ignorePathArgs, " \\( -path '*/%s/*' -prune \\) -o", path)
 				}
-				ignorePathArgs += fmt.Sprintf(" \\( -path '%s' -prune \\) -o", path)
+				fmt.Fprintf(&ignorePathArgs, " \\( -path '%s' -prune \\) -o", path)
 			}
 			// partly taken from https://github.com/ludeeus/action-shellcheck/blob/master/action.yaml#L164-L196
 			test.addRule(rule{
@@ -385,7 +367,7 @@ endif
 				prerequisites: []string{"install-shellcheck"},
 				recipe: []string{
 					`@printf "\e[1;36m>> shellcheck\e[0m\n"`,
-					fmt.Sprintf(`@find . %s -type f \( -name '*.bash' -o -name '*.ksh' -o -name '*.zsh' -o -name '*.sh' -o -name '*.shlib' \) -exec shellcheck %s {} +`, strings.TrimSpace(ignorePathArgs), cfg.ShellCheck.Opts),
+					fmt.Sprintf(`@find . %s -type f \( -name '*.bash' -o -name '*.ksh' -o -name '*.zsh' -o -name '*.sh' -o -name '*.shlib' \) -exec shellcheck %s {} +`, strings.TrimSpace(ignorePathArgs.String()), cfg.ShellCheck.Opts),
 				},
 			})
 		}
@@ -601,7 +583,7 @@ endif
 	staticCheckPrerequisites := []string{"run-shellcheck"}
 	if isGolang {
 		// add target for static code checks
-		staticCheckPrerequisites = append(staticCheckPrerequisites, "run-golangci-lint", "run-modernize")
+		staticCheckPrerequisites = append(staticCheckPrerequisites, "run-golangci-lint")
 		if cfg.License.CheckDependencies.UnwrapOr(isSAPCC) {
 			staticCheckPrerequisites = append(staticCheckPrerequisites, "check-dependency-licenses")
 		}
@@ -616,17 +598,6 @@ endif
 				fmt.Sprintf(`@goimports -w -local %s %s`, sr.ModulePath, allSourceFilesExpr),
 			},
 		})
-
-		dev.addRule(rule{
-			description:   "Run modernize on all non-vendored .go files",
-			phony:         true,
-			target:        "modernize",
-			prerequisites: []string{"install-modernize"},
-			recipe: []string{
-				`@printf "\e[1;36m>> modernize -fix ./...\e[0m\n"`,
-				`@modernize -fix ./...`,
-			},
-		})
 	}
 
 	if cfg.License.AddHeaders.UnwrapOr(isSAPCC) {