Run revive using golang-lint-ci

.github/CONTRIBUTING.md

@@ -26,8 +26,8 @@ pre-commit install
 # install goimports
 go install golang.org/x/tools/cmd/goimports@latest
 
-# install revive
-go install github.com/mgechev/revive@latest
+# install golang-ci-lint
+go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
 ```
 
 Now every time you commit, the hooks will run and format your code, linting can be called via `make lint-go`.

.github/workflows/scan-lint.yml

@@ -10,12 +10,7 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-
-      - name: Run Revive Action by pulling pre-built image
-        uses: docker://morphy/revive-action:v2.5.7@sha256:087d4e61077087755711ab7e9fae3cc899b7bb07ff8f6a30c3dfb240b1620ae8
+      - name: Run golangci-lint
+        uses: golangci/golangci-lint-action@v6
         with:
-          config: hack/revive.toml
-          # Exclude patterns, separated by semicolons (optional)
-          exclude: "src/cmd/viper.go"
-          # Path pattern (default: ./...)
-          path: "./src/..."
+          version: v1.58.1

.golangci.yaml

@@ -0,0 +1,53 @@
+run:
+  timeout: 5m
+linters:
+  disable-all: true
+  enable:
+    - gosimple
+    - govet
+    - staticcheck
+    - unused
+    - revive
+    - goheader
+    - goimports
+linters-settings:
+  goheader:
+    template: |-
+      SPDX-License-Identifier: Apache-2.0
+      SPDX-FileCopyrightText: 2021-Present The Zarf Authors
+  revive:
+    rules:
+      - name: blank-imports
+      - name: context-as-argument
+      - name: context-keys-type
+      - name: dot-imports
+      - name: error-return
+      - name: error-strings
+      - name: error-naming
+      - name: exported
+      - name: if-return
+      - name: increment-decrement
+      - name: var-naming
+      - name: var-declaration
+      - name: package-comments
+      - name: range
+      - name: receiver-naming
+      - name: time-naming
+      - name: unexported-return
+      - name: indent-error-flow
+      - name: errorf
+      - name: empty-block
+      - name: superfluous-else
+      - name: unused-parameter
+      - name: unreachable-code
+      - name: redefines-builtin-id
+issues:
+  # Revive rules that are disabled by default.
+  include:
+    - EXC0012
+    - EXC0013
+    - EXC0014
+    - EXC0015
+  # Exclude linting code copied from Helm.
+  exclude-dirs:
+    - "src/cmd/tools/helm"

.pre-commit-config.yaml

@@ -37,13 +37,10 @@ repos:
         language: system
         pass_filenames: true
       - id: lint
-        name: revive go lint
-        entry: revive
+        name: golang-ci-lint go lint
+        entry: golang-ci-lint
         args:
-          - "-config"
-          - "hack/revive.toml"
-          - "-exclude"
-          - "src/cmd/viper.go"
+          - "run"
         files: .go$
         language: system
         pass_filenames: true

Makefile

@@ -225,6 +225,5 @@ cve-report: ## Create a CVE report for the current project (must `brew install g
 	@test -d ./build || mkdir ./build
 	go run main.go tools sbom scan . -o json --exclude './site' --exclude './examples' | grype -o template -t hack/grype.tmpl > build/zarf-known-cves.csv
 
-lint-go: ## Run revive to lint the go code (must `brew install revive` first)
-	revive -config hack/revive.toml -exclude src/cmd/viper.go -formatter stylish ./src/...
-	@hack/check-spdx-go.sh src >/dev/null || (echo "SPDX check for go failed, please run 'hack/check-spdx-go.sh src' to see the errors" && exit 1)
+lint-go: ## Run golang-ci-lint to lint the go code (must `brew install golang-ci-lint` first)
+	golangci-lint run

src/pkg/utils/bytes.go

@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2021-Present The Zarf Authors
+
 // forked from https://www.socketloop.com/tutorials/golang-byte-format-example
 
 // Package utils provides generic utility functions.