Use .tool-versions to track golangci-lint version; Add .golangci.yml; Fix mise txtar task (#165)

Author: tangrufus

.github/workflows/lint.yml

@@ -29,10 +29,10 @@ jobs:
       box-version: '4'
 
   go:
-    uses: typisttech/.github/.github/workflows/lint-go.yml@3b989be3639ac84acd7770ad0795ffbfc6193b2b # v5.2.2
+    uses: typisttech/.github/.github/workflows/lint-go.yml@86c07906e5ad8ccd4bab27975f7f67e348498f82 # v5.4.0
     with:
       golangci-lint: true
-      golangci-lint-version: v2.11 # Must be kept in sync with @../../mise.toml
+      golangci-lint-version-file: .tool-versions
 
   wait-for-all-lint:
     if: cancelled() || contains(needs.*.result, 'cancelled') || contains(needs.*.result, 'failure')

.golangci.yml

@@ -0,0 +1,132 @@
+version: "2"
+
+linters:
+  enable:
+    # Default
+    - errcheck
+    - govet
+    - ineffassign
+    - staticcheck
+    - unused
+    # Custom
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - containedctx
+    - contextcheck
+    - copyloopvar
+    - cyclop
+    - depguard
+    - dogsled
+    - dupl
+    - dupword
+    - durationcheck
+    - embeddedstructfieldcheck
+    - errchkjson
+    - errname
+    - errorlint
+    - exhaustive
+    - exptostd
+    - fatcontext
+    - forcetypeassert
+    - gocheckcompilerdirectives
+    - gochecknoinits
+    - gocritic
+    - godoclint
+    - godot
+    - gosec
+    - misspell
+    - nolintlint
+    - nonamedreturns
+    - revive
+    - sloglint
+    - unparam
+    - usestdlibvars
+
+  settings:
+    govet:
+      enable-all: true
+      disable:
+        - fieldalignment
+
+    staticcheck:
+      checks:
+        - all
+        - -ST1000 # at least one file in a package should have a package comment
+
+    # Custom
+    depguard:
+      rules:
+        all:
+          list-mode: strict
+          files:
+            - $all
+            - "!$test"
+          allow:
+            - $gostd
+            - golang.org/x
+            - github.com/typisttech/php-matrix
+            - github.com/rogpeppe/go-internal/testscript
+        test:
+          files:
+            - $test
+          deny:
+            - pkg: github.com/stretchr/testify
+              desc: Use standard library or 'github.com/google/go-cmp/cmp'
+
+    errorlint:
+      errorf: false
+
+    exhaustive:
+      default-signifies-exhaustive: true
+
+    gocritic:
+      enabled-checks:
+        - emptyStringTest
+        - preferStringWriter
+
+    godoclint:
+      enable:
+        - max-len
+        - no-unused-link
+        - require-stdlib-doclink
+
+    godot:
+      scope: toplevel
+      capital: true
+
+    gosec:
+      excludes:
+        - G104 # Handled by errcheck
+
+    nolintlint:
+      require-specific: true
+
+    revive:
+      rules:
+        - name: exported
+          disabled: true
+
+  exclusions:
+    generated: disable
+    warn-unused: true
+    rules:
+      - source: "^\\s*defer\\s+"
+        linters:
+          - errcheck
+
+      - source: "^\\s*os\\.Stdout\\.WriteString\\("
+        linters:
+          - errcheck
+
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+
+  settings:
+    gofumpt:
+      extra-rules: true

.tool-versions

@@ -0,0 +1 @@
+golangci-lint 2.12

internal/composer/fail/main.go

@@ -68,8 +68,9 @@ type rawData struct {
 }
 
 type data struct {
-	Mode string
 	rawData
+
+	Mode string
 }
 
 func (d data) Name() string {

internal/composer/success/main.go

@@ -58,8 +58,10 @@ stdout .
 {"require":{"php":"{{ .Constraint }}"}}
 `
 
-var eolFileTemplate = template.Must(template.New("").Parse(eolTemplateRaw))
-var supportedFileTemplate = template.Must(template.New("").Parse(supportedTemplateRaw))
+var (
+	eolFileTemplate       = template.Must(template.New("").Parse(eolTemplateRaw))
+	supportedFileTemplate = template.Must(template.New("").Parse(supportedTemplateRaw))
+)
 
 type data struct {
 	Mode         string

internal/constraint/fail/main.go

@@ -56,8 +56,9 @@ type rawData struct {
 }
 
 type data struct {
-	Mode string
 	rawData
+
+	Mode string
 }
 
 func (d data) Name() string {

internal/constraint/success/main.go

@@ -53,8 +53,10 @@ stdout .
 ! stderr .
 `
 
-var eolFileTemplate = template.Must(template.New("").Parse(eolTemplateRaw))
-var supportedFileTemplate = template.Must(template.New("").Parse(supportedTemplateRaw))
+var (
+	eolFileTemplate       = template.Must(template.New("").Parse(eolTemplateRaw))
+	supportedFileTemplate = template.Must(template.New("").Parse(supportedTemplateRaw))
+)
 
 type data struct {
 	Mode         string

internal/file.go

@@ -25,7 +25,7 @@ func ensureDirEmpty(path string) error {
 		return err
 	}
 
-	if err := os.MkdirAll(path, 0755); err != nil {
+	if err := os.MkdirAll(path, 0o750); err != nil {
 		return err
 	}
 

internal/txtar_writer.go

@@ -11,28 +11,33 @@ type txtarWriter interface {
 }
 
 func Generate[T txtarWriter](name string, cases ...T) error {
-	_, _ = os.Stdout.Write([]byte("\n==> Generating " + name + " scripts\n\n"))
+	os.Stdout.WriteString("\n==> Generating " + name + " scripts\n\n")
 
 	dir, err := filepath.Abs("testdata")
 	if err != nil {
 		return err
 	}
-	_, _ = os.Stdout.Write([]byte(dir + "\n"))
+	os.Stdout.WriteString(dir + "\n")
 
 	if err := ensureDirEmpty(dir); err != nil {
 		return err
 	}
 
 	for _, w := range cases {
 		n := sanitizeFilename(w.Name()) + ".txtar"
-		_, _ = os.Stdout.Write([]byte("  - " + n + "\n"))
+		os.Stdout.WriteString("  - " + n + "\n")
 
-		p := filepath.Join(dir, n)
-		f, err := os.Create(p)
+		r, err := os.OpenRoot(dir)
 		if err != nil {
 			return err
 		}
-		defer func() { _ = f.Close() }()
+		defer r.Close()
+
+		f, err := r.Create(n)
+		if err != nil {
+			return err
+		}
+		defer f.Close()
 
 		err = w.Write(f)
 		if err != nil {

mise.toml

@@ -1,7 +1,3 @@
-[tools]
-# Must be kept in sync with GitHub Actions workflow @.github/workflows/lint.yml
-golangci-lint = '2.11'
-
 [env]
 GOFLAGS = '-mod=mod'
 
@@ -42,4 +38,4 @@ run = '{{ config_root }}/bin/generate-test-data'
 
 [tasks.'txtar']
 depends = ['gen']
-run = ['go generate ./...', 'UPDATE_SCRIPTS=0 mise run test:bin']
+run = ['go generate ./...', 'UPDATE_SCRIPTS=1 mise run test:bin']