Merge pull request #1085 from oasisprotocol/ptrus/feature/update-golangcilint

Update golangci-lint to v2.2.1

Author: ptrus

.changelog/1085.trivial.md

@@ -91,9 +91,9 @@ jobs:
         # Always run this step so that all linting errors can be seen at once.
         if: always()
       - name: Lint Go
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v8
         with:
           # Update README.md instructions when bumping this.
-          version: v1.64.8
+          version: v2.2.1
         # Always run this step so that all linting errors can be seen at once.
         if: always()

.github/workflows/ci-lint.yaml

@@ -1,84 +1,126 @@
-# golangci-lint configuration.
-
-# For more information, see:
-# https://golangci-lint.run/usage/configuration/.
-
-run:
-  timeout: 5m
-
-issues:
-  exclude-dirs:
-    # Contains a cloned subset of oasis-core. Some types are unused, some
-    # formatting is haphazard. We don't care much; this code is meant to be
-    # frozen in time.
-    - coreapi
-
-  exclude-rules:
-    - path: '(.+)_test\.go'
-      linters:
-        - govet
-    - linters: [revive]
-      text: var-naming  # do not demand that `Id` always be spelled `ID`; messes with autogenerated code
-    - linters: [structcheck]
-      text: is unused  # linter has false positives; claims that fields are unused even though they're not
-    - linters: [revive]
-      text: stutters
-    - linters: [revive]
-      text: unused-parameter  # it's fine to have unused func parameters that are not named `_`; they're usually there because the function is part of an interface
-    - linters: [stylecheck]
-      text: ST1003  # do not demand that `Id` always be spelled `ID`; messes with autogenerated code
-
+version: "2"
 linters:
-  # Disable all linters except the ones explicitly listed below.
-  disable-all: true
+  default: none
   enable:
-    - asciicheck
     - bodyclose
-    - dogsled
-    - errcheck
-    - exhaustive
+    - copyloopvar
+    - depguard
     - goconst
-    - gocritic
     - gocyclo
-    - godot
-    - gofumpt
-    - goheader
-    - goimports
-    - gomodguard
     - goprintffuncname
     - gosec
-    - gosimple
     - govet
     - ineffassign
     - misspell
-    - nakedret
-    - nestif
-    - noctx
-    - nolintlint
-    - prealloc
     - revive
     - rowserrcheck
     - staticcheck
-    - stylecheck
-    - sqlclosecheck
-    - typecheck
     - unconvert
-    - unparam
     - unused
-    - whitespace
 
-linters-settings:
-  exhaustive:
-    # Switch statements are to be considered exhaustive if a 'default' case is
-    # present, even if all enum members aren't listed in the switch.
-    default-signifies-exhaustive: true
-  govet:
-    # Enabled checking for shadowed variables.
-    shadow: true
-  gosec:
-    excludes:
-      # https://github.com/securego/gosec#available-rules
-      - G115
-  goimports:
-    # Put local imports after 3rd-party packages.
-    local-prefixes: github.com/oasisprotocol/nexus
+  settings:
+    depguard:
+      rules:
+        main:
+          files:
+            - $all
+          allow:
+            - $gostd
+            - github.com/oasisprotocol/nexus
+            - github.com/oasisprotocol/oasis-core
+            - github.com/oasisprotocol/oasis-sdk
+            - github.com/oasisprotocol/metadata-registry-tools
+            - github.com/akrylysov/pogreb
+            - github.com/dgraph-io/ristretto
+            - github.com/ethereum/go-ethereum
+            - github.com/go-chi/chi/v5
+            - github.com/go-kit/log
+            - github.com/golang-migrate/migrate/v4
+            - github.com/google/uuid
+            - github.com/jackc/pgx/v5
+            - github.com/knadh/koanf
+            - github.com/prometheus/client_golang/prometheus
+            - github.com/rs/cors
+            - github.com/spf13/cobra
+            - github.com/stretchr/testify/assert
+            - github.com/stretchr/testify/require
+            - golang.org/x/crypto/sha3
+            - google.golang.org/grpc
+            - golang.org/x/sync/errgroup
+          deny:
+            - pkg: github.com/pkg/errors
+              desc: Should be replaced by standard lib errors package
+            - pkg: github.com/fxamacker/cbor/v2
+              desc: Use oasis-core/go/common/cbor instead
+
+  exclusions:
+    generated: lax
+    rules:
+      # Exclude some linters on test files.
+      - linters:
+          - govet
+          - revive
+          - gosec
+        path: (.+)_test\.go
+      - linters:
+          - govet
+          - revive
+          - gosec
+        path: tests/*
+      # Exclude var-naming.
+      - linters:
+          - revive
+        text: var-naming
+      # Exclude sttutering.
+      - linters:
+          - revive
+        text: and that stutters
+      # Exclude unused parameters.
+      - linters:
+          - revive
+        text: unused-parameter
+      # Exclude required comments on exported structs/fields.
+      - linters:
+          - revive
+        text: "exported:"
+      # Exclude could apply De Morgan's law.
+      - linters:
+          - staticcheck
+        text: QF1001
+      # Exclude could remove embedded fields.
+      - linters:
+          - staticcheck
+        text: QF1008
+      # Exclude intiger overflow conversion.
+      - linters:
+          - gosec
+        text: G115
+      # Exclude audited unsafe calls.
+      - linters:
+          - gosec
+        text: G103
+
+    paths:
+      - coreapi
+      - third_party$
+      - builtin$
+      - examples$
+      - cmd/bisect
+
+formatters:
+  enable:
+    - gofumpt
+    - goimports
+
+  settings:
+    goimports:
+      local-prefixes:
+        - github.com/oasisprotocol/nexus
+
+  exclusions:
+    generated: lax
+    paths:
+      - coreapi
+      - third_party$
+      - builtin$
+      - examples$

.golangci.yaml

@@ -122,7 +122,7 @@ create a PR, but without them, you're at the mercy of CI.
 
   ```sh
   curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh \
-  | sh -s -- -b $(go env GOPATH)/bin v1.62.2
+  | sh -s -- -b $(go env GOPATH)/bin v2.2.1
   ```
 
   - **gofumpt**: `go install mvdan.cc/gofumpt@latest`

README.md

@@ -1,3 +1,4 @@
+// Package aggregate_stats implements the aggregate stats analyzer.
 package aggregate_stats
 
 import (
@@ -133,7 +134,6 @@ func (a *aggregateStatsAnalyzer) aggregateStatsWorker(ctx context.Context) {
 	// Compute daily tx volume stats every 5 minutes for all layers.
 	// Uses the stats.min5_tx_volume results so that it is efficient.
 	for _, layer := range statsLayers {
-		layer := layer
 		sc := &statsComputation{
 			target:       a.target,
 			name:         "daily_tx_volume_" + layer,

analyzer/aggregate_stats/aggregate_stats.go

@@ -1,3 +1,4 @@
+// Package analyzer defines the analyzer API.
 package analyzer
 
 import (

analyzer/api.go

@@ -6,9 +6,10 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/fxamacker/cbor/v2"
 	"github.com/stretchr/testify/require"
 
+	"github.com/oasisprotocol/oasis-core/go/common/cbor"
+
 	roothashCobalt "github.com/oasisprotocol/nexus/coreapi/v21.1.1/roothash/api"
 	"github.com/oasisprotocol/nexus/coreapi/v22.2.11/consensus/api/transaction"
 	roothashDamask "github.com/oasisprotocol/nexus/coreapi/v22.2.11/roothash/api"

analyzer/consensus/consensus_test.go

@@ -1,3 +1,4 @@
+// Package static contains static data for the consensus analyzer.
 package static
 
 import (

analyzer/consensus/static/accounts.go

@@ -1,3 +1,4 @@
+// Package consensus_accounts_list implements the consensus accounts list analyzer.
 package consensus_accounts_list
 
 import (

analyzer/consensus_accounts_list/accounts_list.go

@@ -1,3 +1,4 @@
+// Package evmabi implements the common EVM ABI specs.
 package evmabi
 
 import (