Add tool specific lint/fix targets

This commit breaks out the lint/fix commands to their own targets that make
can run concurrently (in parallel or not too!). The benefit of this is that
we can run `make --keep-going` and all the targets will be run regardless
of exit status (while still getting an error exit if any of them errored).
This gives us the benefit of seeing *all* lint issues in one go instead of
stopping at the first errored linter.

This Makefile is also just plain nicer in my opinion. Everything to do with
per file linter is in just one chunk in the file instead of multiple. We can
easily see all the per-$file code. This also means we only have to mess within
the file-type's block to add/remove linters instead of in multiple locations
(block, _lint, and fix).

Signed-off-by: Manuel Mendez <[email protected]>

Author: mmlb

Makefile

@@ -17,6 +17,9 @@ ifeq ($(LINT_OS),Darwin)
 	endif
 endif
 
+LINTERS :=
+FIXERS :=
+
 SHELLCHECK_VERSION ?= v0.7.2
 SHELLCHECK_BIN := out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)
 $(SHELLCHECK_BIN):
@@ -25,13 +28,27 @@ $(SHELLCHECK_BIN):
 	curl -sSfL https://github.com/koalaman/shellcheck/releases/download/$(SHELLCHECK_VERSION)/shellcheck-$(SHELLCHECK_VERSION).$(LINT_OS_LOWER).$(LINT_ARCH).tar.xz | tar -C out/linters -xJf -
 	mv out/linters/shellcheck-$(SHELLCHECK_VERSION)/shellcheck $@
 	rm -rf out/linters/shellcheck-$(SHELLCHECK_VERSION)/shellcheck
+
+LINTERS += shellcheck-lint
+shellcheck-lint: $(SHELLCHECK_BIN)
+	$(SHELLCHECK_BIN) $(shell find . -name "*.sh")
+
+FIXERS += shellcheck-fix
+shellcheck-fix: $(SHELLCHECK_BIN)
+	$(SHELLCHECK_BIN) $(shell find . -name "*.sh") -f diff | { read -t 1 line || exit 0; { echo "$$line" && cat; } | git apply -p2; }
+
 HADOLINT_VERSION ?= v2.7.0
 HADOLINT_BIN := out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH)
 $(HADOLINT_BIN):
 	mkdir -p out/linters
 	rm -rf out/linters/hadolint-*
 	curl -sfL https://github.com/hadolint/hadolint/releases/download/v2.6.1/hadolint-$(LINT_OS)-$(LINT_ARCH) > $@
 	chmod u+x $@
+
+LINTERS += hadolint-lint
+hadolint-lint: $(HADOLINT_BIN)
+	$(HADOLINT_BIN) $(shell find . -name "*Dockerfile")
+
 GOLANGCI_LINT_CONFIG := $(LINT_ROOT)/.golangci.yml
 GOLANGCI_LINT_VERSION ?= v1.42.1
 GOLANGCI_LINT_BIN := out/linters/golangci-lint-$(GOLANGCI_LINT_VERSION)-$(LINT_ARCH)
@@ -40,6 +57,15 @@ $(GOLANGCI_LINT_BIN):
 	rm -rf out/linters/golangci-lint-*
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b out/linters $(GOLANGCI_LINT_VERSION)
 	mv out/linters/golangci-lint $@
+
+LINTERS += golangci-lint-lint
+golangci-lint-lint: $(GOLANGCI_LINT_BIN)
+	$(GOLANGCI_LINT_BIN) run
+
+FIXERS += golangci-lint-fix
+golangci-lint-fix: $(GOLANGCI_LINT_BIN)
+	$(GOLANGCI_LINT_BIN) run --fix
+
 YAMLLINT_VERSION ?= 1.26.3
 YAMLLINT_ROOT := out/linters/yamllint-$(YAMLLINT_VERSION)
 YAMLLINT_BIN := $(YAMLLINT_ROOT)/dist/bin/yamllint
@@ -48,16 +74,15 @@ $(YAMLLINT_BIN):
 	rm -rf out/linters/yamllint-*
 	curl -sSfL https://github.com/adrienverge/yamllint/archive/refs/tags/v$(YAMLLINT_VERSION).tar.gz | tar -C out/linters -zxf -
 	cd $(YAMLLINT_ROOT) && pip3 install --target dist .
-.PHONY: _lint
-_lint: $(SHELLCHECK_BIN) $(HADOLINT_BIN) $(GOLANGCI_LINT_BIN) $(YAMLLINT_BIN)
-	$(GOLANGCI_LINT_BIN) run
-	$(HADOLINT_BIN) $(shell find . -name "*Dockerfile")
-	$(SHELLCHECK_BIN) $(shell find . -name "*.sh")
+
+LINTERS += yamllint-lint
+yamllint-lint: $(YAMLLINT_BIN)
 	PYTHONPATH=$(YAMLLINT_ROOT)/dist $(YAMLLINT_ROOT)/dist/bin/yamllint .
 
-.PHONY: fix
-fix: $(SHELLCHECK_BIN) $(GOLANGCI_LINT_BIN)
-	$(GOLANGCI_LINT_BIN) run --fix
-	$(SHELLCHECK_BIN) $(shell find . -name "*.sh") -f diff | { read -t 1 line || exit 0; { echo "$$line" && cat; } | git apply -p2; }
+.PHONY: _lint $(LINTERS)
+_lint: $(LINTERS)
+
+.PHONY: fix $(FIXERS)
+fix: $(FIXERS)
 
 # END: lint-install .

Makefile.tmpl

@@ -17,6 +17,9 @@ ifeq ($(LINT_OS),Darwin)
 	endif
 endif
 
+LINTERS :=
+FIXERS :=
+
 {{ if .Shell -}}
 SHELLCHECK_VERSION ?= v0.7.2
 SHELLCHECK_BIN := out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)
@@ -26,6 +29,15 @@ $(SHELLCHECK_BIN):
 	curl -sSfL https://github.com/koalaman/shellcheck/releases/download/$(SHELLCHECK_VERSION)/shellcheck-$(SHELLCHECK_VERSION).$(LINT_OS_LOWER).$(LINT_ARCH).tar.xz | tar -C out/linters -xJf -
 	mv out/linters/shellcheck-$(SHELLCHECK_VERSION)/shellcheck $@
 	rm -rf out/linters/shellcheck-$(SHELLCHECK_VERSION)/shellcheck
+
+LINTERS += shellcheck-lint
+shellcheck-lint: $(SHELLCHECK_BIN)
+	{{ .LintCommands.shellcheck }}
+
+FIXERS += shellcheck-fix
+shellcheck-fix: $(SHELLCHECK_BIN)
+	{{ .FixCommands.shellcheck }}
+
 {{ end -}}
 
 {{ if .Dockerfile -}}
@@ -36,6 +48,11 @@ $(HADOLINT_BIN):
 	rm -rf out/linters/hadolint-*
 	curl -sfL https://github.com/hadolint/hadolint/releases/download/v2.6.1/hadolint-$(LINT_OS)-$(LINT_ARCH) > $@
 	chmod u+x $@
+
+LINTERS += hadolint-lint
+hadolint-lint: $(HADOLINT_BIN)
+	{{ .LintCommands.hadolint }}
+
 {{ end -}}
 
 {{ if .Go -}}
@@ -47,6 +64,15 @@ $(GOLANGCI_LINT_BIN):
 	rm -rf out/linters/golangci-lint-*
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b out/linters $(GOLANGCI_LINT_VERSION)
 	mv out/linters/golangci-lint $@
+
+LINTERS += golangci-lint-lint
+golangci-lint-lint: $(GOLANGCI_LINT_BIN)
+	{{ index .LintCommands "golangci-lint" }}
+
+FIXERS += golangci-lint-fix
+golangci-lint-fix: $(GOLANGCI_LINT_BIN)
+	{{ index .FixCommands "golangci-lint" }}
+
 {{ end -}}
 
 {{ if .YAML -}}
@@ -58,16 +84,17 @@ $(YAMLLINT_BIN):
 	rm -rf out/linters/yamllint-*
 	curl -sSfL https://github.com/adrienverge/yamllint/archive/refs/tags/v$(YAMLLINT_VERSION).tar.gz | tar -C out/linters -zxf -
 	cd $(YAMLLINT_ROOT) && pip3 install --target dist .
+
+LINTERS += yamllint-lint
+yamllint-lint: $(YAMLLINT_BIN)
+	{{ .LintCommands.yamllint }}
+
 {{ end -}}
 
-.PHONY: _lint
-_lint: {{ if .Shell }}$(SHELLCHECK_BIN) {{ end }}{{ if .Dockerfile }}$(HADOLINT_BIN) {{ end }}{{ if .Go}}$(GOLANGCI_LINT_BIN) {{ end }}{{ if .YAML}}$(YAMLLINT_BIN){{ end }}
-	{{- range $k, $v := .LintCommands }}
-	{{ $v }}{{ end}}
+.PHONY: _lint $(LINTERS)
+_lint: $(LINTERS)
 
-.PHONY: fix
-fix: {{ if .Shell }}$(SHELLCHECK_BIN) {{ end }}{{ if .Go}}$(GOLANGCI_LINT_BIN){{ end }}
-	{{- range $k, $v := .FixCommands }}
-	{{ $v }}{{ end}}
+.PHONY: fix $(FIXERS)
+fix: $(FIXERS)
 
 # END: lint-install {{.Args}}