Merge branch 'main' into py3

Author: tstromberg

.gitignore

@@ -10,7 +10,9 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
-out/
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+# added by lint-install
+out/

Makefile

@@ -21,12 +21,14 @@ LINT_LOWER_OS = $(shell echo $(LINT_OS) | tr '[:upper:]' '[:lower:]')
 GOLINT_CONFIG = $(LINT_ROOT)/.golangci.yml
 YAMLLINT_ROOT = out/linters/yamllint-$(YAMLLINT_VERSION)
 
+.PHONY: lint
 lint: out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH) $(YAMLLINT_ROOT)/bin/yamllint
 	out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH) run
 	out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) $(shell find . -name "*Dockerfile")
 	out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck $(shell find . -name "*.sh")
 	PYTHONPATH=$(YAMLLINT_ROOT)/dist $(YAMLLINT_ROOT)/dist/bin/yamllint .
 
+.PHONY: fix
 fix: out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH)
 	out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH) run --fix
 	out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck $(shell find . -name "*.sh") -f diff | git apply -p2 -

Makefile.tmpl

@@ -21,10 +21,12 @@ endif
 {{ if .Go }}GOLINT_CONFIG = $(LINT_ROOT)/.golangci.yml{{ end }}
 {{ if .YAML }}YAMLLINT_ROOT = out/linters/yamllint-$(YAMLLINT_VERSION){{ end }}
 
+.PHONY: lint
 lint: {{ if .Shell }}out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck {{ end }}{{ if .Dockerfile }}out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) {{ end }}{{ if .Go}}out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH) {{ end }}{{ if .YAML}}$(YAMLLINT_ROOT)/bin/yamllint{{ end }}
 	{{- range .LintCommands }}
 	{{ .}}{{ end}}
 
+.PHONY: fix
 fix: {{ if .Shell }}out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck {{ end }}{{ if .Go}}out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH){{ end }}
 	{{- range .FixCommands }}
 	{{ .}}{{ end}}

lint-install.go

@@ -171,6 +171,47 @@ func updateGoLint(root string, dryRun bool) (string, error) {
 	return fmt.Sprint(change), nil
 }
 
+// updateGitignore updates the .gitignore file within a project to exclude installed linters.
+func updateGitignore(root string, dryRun bool) (string, error) {
+	dest := filepath.Join(root, ".gitignore")
+	var existing []byte
+	var err error
+
+	if _, err = os.Stat(dest); err == nil {
+		klog.Infof("Found existing %s", dest)
+		existing, err = os.ReadFile(dest)
+		if err != nil {
+			return "", err
+		}
+	}
+	proposed := []byte{}
+	found := false
+	for _, line := range bytes.Split(existing, []byte("\n")) {
+		if bytes.Equal(line, []byte("out/")) || bytes.Equal(line, []byte("out")) {
+			found = true
+		}
+		proposed = append(proposed, line...)
+		proposed = append(proposed, []byte("\n")...)
+	}
+
+	if !found {
+		proposed = append(proposed, []byte("# added by lint-install\nout/\n")...)
+	}
+
+	// Trim extra newlines at the end
+	proposed = bytes.TrimRight(proposed, "\n")
+	proposed = append(proposed, byte('\n'))
+
+	edits := myers.ComputeEdits(".gitignore", string(existing), string(proposed))
+	change := gotextdiff.ToUnified(filepath.Base(dest), filepath.Base(dest), string(existing), edits)
+	if !dryRun {
+		if err := os.WriteFile(dest, proposed, 0o600); err != nil {
+			return "", err
+		}
+	}
+	return fmt.Sprint(change), nil
+}
+
 // goLintCmd returns the appropriate golangci-lint command to run for a project.
 func goLintCmd(root string, level string, fix bool) string {
 	klog.Infof("Searching for go modules within %s ...", root)
@@ -300,5 +341,15 @@ func main() {
 		} else {
 			klog.Infof("Makefile has no changes")
 		}
+
+		diff, err = updateGitignore(root, *dryRunFlag)
+		if err != nil {
+			klog.Exitf("update .gitignore failed: %v", err)
+		}
+		if diff != "" {
+			klog.Infof(".gitignore changes:\n%s", diff)
+		} else {
+			klog.Infof(".gitignore has no changes")
+		}
 	}
 }