Merge pull request tinkerbell#21 from tstromberg/prettier

Add support for YAML linting

Author: tstromberg

.github/workflows/ci.yml

@@ -2,33 +2,33 @@ name: Go
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
 
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v2
 
-    - name: Set up Go
-      uses: actions/setup-go@v2
-      with:
-        go-version: 1.17
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.17
 
-    - name: Build
-      run: go build -v ./...
+      - name: Build
+        run: go build -v ./...
 
-    - name: Test
-      run: go test -v ./...
+      - name: Test
+        run: go test -v ./...
 
-    - name: Run
-      run: cp Makefile Makefile.old && go run . .
+      - name: Run
+        run: cp Makefile Makefile.old && go run . .
 
-    - name: Lint
-      run: make lint
+      - name: Lint
+        run: make lint
 
-    - name: Makefile diff
-      run: diff -ubB Makefile.old Makefile
+      - name: Makefile diff
+        run: diff -ubB Makefile.old Makefile

.gitignore

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

.golangci.yml

@@ -108,7 +108,7 @@ linters:
     - durationcheck
     - errcheck
     # errname is only available in golangci-lint v1.42.0+ - wait until v1.43 is available to settle
-    #- errname
+    # - errname
     - errorlint
     - exhaustive
     - exportloopref
@@ -137,7 +137,7 @@ linters:
     - nolintlint
     - predeclared
     # disabling for the initial iteration of the linting tool
-    #- promlinter
+    # - promlinter
     - revive
     - rowserrcheck
     - sqlclosecheck

.yamllint

@@ -0,0 +1,16 @@
+---
+extends: default
+
+rules:
+  braces:
+    max-spaces-inside: 1
+  brackets:
+    max-spaces-inside: 1
+  comments: disable
+  comments-indentation: disable
+  document-start: disable
+  line-length:
+    level: warning
+    max: 160
+    allow-non-breakable-inline-mappings: true
+  truthy: disable

Makefile

@@ -1,9 +1,11 @@
+
 # BEGIN: lint-install .
 # http://github.com/tinkerbell/lint-install
 
 GOLINT_VERSION ?= v1.42.0
 HADOLINT_VERSION ?= v2.7.0
 SHELLCHECK_VERSION ?= v0.7.2
+YAMLLINT_VERSION ?= 1.26.3
 LINT_OS := $(shell uname)
 LINT_ARCH := $(shell uname -m)
 LINT_ROOT := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
@@ -15,13 +17,15 @@ ifeq ($(LINT_OS),Darwin)
 	endif
 endif
 
-LINT_LOWER_OS  = $(shell echo $(LINT_OS) | tr '[:upper:]' '[:lower:]')
-GOLINT_CONFIG:=$(LINT_ROOT)/.golangci.yml
+LINT_LOWER_OS = $(shell echo $(LINT_OS) | tr '[:upper:]' '[:lower:]')
+GOLINT_CONFIG = $(LINT_ROOT)/.golangci.yml
+YAMLLINT_ROOT = out/linters/yamllint-$(YAMLLINT_VERSION)
 
-lint: out/linters/shellcheck-$(SHELLCHECK_VERSION)-$(LINT_ARCH)/shellcheck out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH) out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH)
+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)/lib $(YAMLLINT_ROOT)/bin/yamllint .
 
 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
@@ -42,4 +46,8 @@ out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH):
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b out/linters $(GOLINT_VERSION)
 	mv out/linters/golangci-lint out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH)
 
+$(YAMLLINT_ROOT)/bin/yamllint:
+	mkdir -p $(YAMLLINT_ROOT)/lib
+	curl -sSfL https://github.com/adrienverge/yamllint/archive/refs/tags/v$(YAMLLINT_VERSION).tar.gz | tar -C out/linters -zxf -
+	cd $(YAMLLINT_ROOT) && PYTHONPATH=lib python setup.py -q install --prefix . --install-lib lib
 # END: lint-install .

Makefile.tmpl

@@ -5,6 +5,7 @@
 {{ if .Go }}GOLINT_VERSION ?= v1.42.0{{ end }}
 {{ if .Dockerfile}}HADOLINT_VERSION ?= v2.7.0{{ end }}
 {{ if .Shell}}SHELLCHECK_VERSION ?= v0.7.2{{ end }}
+{{ if .YAML}}YAMLLINT_VERSION ?= 1.26.3{{ end }}
 LINT_OS := $(shell uname)
 LINT_ARCH := $(shell uname -m)
 LINT_ROOT := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
@@ -16,10 +17,11 @@ ifeq ($(LINT_OS),Darwin)
 	endif
 endif
 
-{{ if .Shell }}LINT_LOWER_OS  = $(shell echo $(LINT_OS) | tr '[:upper:]' '[:lower:]'){{ end }}
-{{ if .Go }}GOLINT_CONFIG:=$(LINT_ROOT)/.golangci.yml{{ end }}
+{{ if .Shell }}LINT_LOWER_OS = $(shell echo $(LINT_OS) | tr '[:upper:]' '[:lower:]'){{ end }}
+{{ if .Go }}GOLINT_CONFIG = $(LINT_ROOT)/.golangci.yml{{ end }}
+{{ if .YAML }}YAMLLINT_ROOT = out/linters/yamllint-$(YAMLLINT_VERSION){{ end }}
 
-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 }}
+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}}
 
@@ -48,4 +50,12 @@ out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH):
 	mv out/linters/golangci-lint out/linters/golangci-lint-$(GOLINT_VERSION)-$(LINT_ARCH)
 
 {{ end -}}
+
+{{ if .YAML -}}
+$(YAMLLINT_ROOT)/bin/yamllint:
+	mkdir -p $(YAMLLINT_ROOT)/lib
+	curl -sSfL https://github.com/adrienverge/yamllint/archive/refs/tags/v$(YAMLLINT_VERSION).tar.gz | tar -C out/linters -zxf -
+	cd $(YAMLLINT_ROOT) && PYTHONPATH=lib python setup.py -q install --prefix . --install-lib lib
+{{ end -}}
+
 # END: lint-install {{.Args}}

README.md

@@ -1,32 +1,60 @@
 # lint-install
 
 [![GoReport Widget]][GoReport Status]
-![](https://img.shields.io/badge/Stability-Experimental-red.svg)
+[![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)](https://github.com/emersion/stability-badges#stable)
 
 [GoReport Status]: https://goreportcard.com/report/github.com/tinkerbell/lint-install
 [GoReport Widget]: https://goreportcard.com/badge/github.com/tinkerbell/lint-install
 
-Install well-configured linters to your project in a consistent and repeatable way. This tool specifically supports creating and updating `Makefile`
-targets, and lints the following:
+Idiomatic linters for opinionated projects.
+
+This tool installs well-configured linters to any project, open-source or
+otherwise. The linters can be used in a repeatable and consistent way across CI,
+local tests, and IDE's.
+
+lint-install adds linter configuration to the root of your project, and Makefile
+rules to install a consistently versioned set of linters to be used in any
+environment. These Makefile rules can also be upgrading by lint-install, updating
+all environments simultaneously.
+
+Currently supported languages:
 
 - Go
 - Shell
 - Dockerfile
+- YAML
 
 ## Philosophy
 
-Catch as many errors as possible, but be idiomatic to the language. 
+- Catch all the bugs!
+- Improve readability as much as possible.
+- Be idiomatic: only raise issues that the language authors would flag
 
 ## Usage
 
-```
-go get github.com/tinkerbell/lint-install
-$HOME/go/bin/lint-install <repo>
-```
+Installation:
+
+`go get github.com/tinkerbell/lint-install`
+
+Add Makefile rules for a git repository:
+
+`$HOME/go/bin/lint-install <repo>`
+
+Users can then lint the project using:
+
+`make lint`
 
-## Options
+Other options:
 
-* `--dry-run`: Log what changes would be made if any
-* `--shell=warn`: Make shell warnings non-fatal
-* `--dockerfile=warn`:  Make Dockerfile warnings non-fatal
-* `--go=warn`:  Make Dockerfile warnings non-fatal
+  -dockerfile string
+     Level to lint Dockerfile with: [ignore, warn, error] (default "error")
+  -dry-run
+     Display changes to make
+  -go string
+     Level to lint Go with: [ignore, warn, error] (default "error")
+  -makefile string
+     name of Makefile to update (default "Makefile")
+  -shell string
+     Level to lint Shell with: [ignore, warn, error] (default "error")
+  -yaml string
+     Level to lint YAML with: [ignore, warn, error] (default "error")

lint-install.go

@@ -21,6 +21,7 @@ var (
 	goFlag         = flag.String("go", "error", "Level to lint Go with: [ignore, warn, error]")
 	shellFlag      = flag.String("shell", "error", "Level to lint Shell with: [ignore, warn, error]")
 	dockerfileFlag = flag.String("dockerfile", "error", "Level to lint Dockerfile with: [ignore, warn, error]")
+	yamlFlag       = flag.String("yaml", "error", "Level to lint YAML with: [ignore, warn, error]")
 	makeFileName   = flag.String("makefile", "Makefile", "name of Makefile to update")
 
 	//go:embed .golangci.yml
@@ -36,6 +37,7 @@ const (
 	Go Language = iota
 	Shell
 	Dockerfile
+	YAML
 )
 
 type Config struct {
@@ -44,6 +46,7 @@ type Config struct {
 	Go           string
 	Dockerfile   string
 	Shell        string
+	YAML         string
 	LintCommands []string
 	FixCommands  []string
 }
@@ -55,15 +58,17 @@ func applicableLinters(root string) (map[Language]bool, error) {
 
 	err := godirwalk.Walk(root, &godirwalk.Options{
 		Callback: func(path string, de *godirwalk.Dirent) error {
-			if strings.HasSuffix(path, ".go") {
+			switch {
+			case strings.HasSuffix(path, ".go"):
 				found[Go] = true
-			}
-			if strings.HasSuffix(path, "Dockerfile") {
+			case strings.HasSuffix(path, "Dockerfile"):
 				found[Dockerfile] = true
-			}
-			if strings.HasSuffix(path, ".sh") {
+			case strings.HasSuffix(path, ".sh"):
 				found[Shell] = true
+			case strings.HasSuffix(path, ".yml"), strings.HasSuffix(path, ".yaml"):
+				found[YAML] = true
 			}
+
 			return nil
 		},
 		Unsorted: true,
@@ -223,6 +228,15 @@ func dockerLintCmd(_ string, level string) string {
 	return fmt.Sprintf(`out/linters/hadolint-$(HADOLINT_VERSION)-$(LINT_ARCH)%s $(shell find . -name "*Dockerfile")`, f)
 }
 
+// yamlLintCmd returns the appropriate yamllint command for a project.
+func yamlLintCmd(_ string, level string) string {
+	suffix := ""
+	if level == "warn" {
+		suffix = " || true"
+	}
+	return fmt.Sprintf(`PYTHONPATH=$(YAMLLINT_ROOT)/lib $(YAMLLINT_ROOT)/bin/yamllint .%s`, suffix)
+}
+
 // main creates peanut butter & jelly sandwiches with utmost precision.
 func main() {
 	klog.InitFlags(nil)
@@ -272,6 +286,10 @@ func main() {
 			cfg.LintCommands = append(cfg.LintCommands, shellLintCmd(root, cfg.Shell, false))
 			cfg.FixCommands = append(cfg.FixCommands, shellLintCmd(root, cfg.Shell, true))
 		}
+		if needs[YAML] {
+			cfg.YAML = *yamlFlag
+			cfg.LintCommands = append(cfg.LintCommands, yamlLintCmd(root, cfg.Shell))
+		}
 
 		diff, err := updateMakefile(root, cfg, *dryRunFlag)
 		if err != nil {