go linter

Author: lantoli

.github/workflows/code-health.yml

@@ -8,7 +8,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  code-health:
+  code-health: # required PR check
     needs: [build, lint, shellcheck]
     runs-on: ubuntu-latest
     permissions: {}
@@ -38,7 +38,7 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8
         with:
-          version: v1.62.2 # Also update GOLANGCI_VERSION variable in GNUmakefile when updating this version
+          version: v1.63.4 # Also update GOLANGCI_VERSION variable in GNUmakefile when updating this version
       - name: actionlint
         run: |
           make tools

.golangci.yml

@@ -0,0 +1,107 @@
+linters-settings:
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+  govet:
+    enable-all: true
+
+  revive:
+    # see https://github.com/mgechev/revive#available-rules for details.
+    ignore-generated-header: true
+    severity: warning
+    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: errorf
+      - name: exported
+      - name: indent-error-flow
+      - 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: struct-tag
+      # Too many unusued parameters, skipping this check for now
+      #- name: unused-parameter
+      - name: unreachable-code
+      - name: redefines-builtin-id
+  misspell:
+    locale: US
+    ignore-words:
+      - cancelled
+  lll:
+    # Default is 120. '\t' is counted as 1 character.
+    # set our project to 500, as we are adding open api field description in the schema.
+    # also, for anyone using vscode, use the following configs:
+    # "rewrap.wrappingColumn": 500 ... requires the rewrap plugin
+    # "editor.rulers": [500]
+    line-length: 500
+  nestif:
+    # minimal complexity of if statements to report, 5 by default
+    min-complexity: 7
+  mnd:
+    checks:
+      - case
+      - operation
+      - return
+  funlen:
+    lines: 360
+    statements: 120
+linters:
+  disable-all: true
+  enable:
+    - dogsled
+    - errcheck
+    - funlen
+    - gocritic
+    - gofmt
+    - goimports
+    - revive
+    - mnd
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - lll
+    - misspell
+    - nakedret
+    - nolintlint
+    - rowserrcheck
+    - copyloopvar
+    - staticcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unused
+    - whitespace
+    - thelper
+    - testifylint
+    - exhaustive
+    - makezero
+    - noctx
+    - tenv
+    - testpackage
+run:
+  timeout: 10m
+  tests: true
+  build-tags:
+    - integration
+  modules-download-mode: readonly

GNUmakefile

@@ -0,0 +1,18 @@
+CLI_SOURCE_FILES?=./cmd/plugin
+CLI_BINARY_NAME?=binary
+CLI_DESTINATION=./bin/$(CLI_BINARY_NAME)
+
+GOLANGCI_VERSION=v1.63.4 # Also update golangci-lint GH action in code-health.yml when updating this version
+
+.PHONY: build
+build:
+	@echo "==> Building plugin binary: $(CLI_BINARY_NAME)"
+	go build -o $(CLI_DESTINATION) $(CLI_SOURCE_FILES)
+
+.PHONY: tools
+tools:  ## Install dev tools
+	@echo "==> Installing dependencies..."
+	go telemetry off # disable sending telemetry data, more info: https://go.dev/doc/telemetry
+	go install github.com/rhysd/actionlint/cmd/actionlint@latest
+	go install golang.org/x/tools/go/analysis/passes/fieldalignment/cmd/fieldalignment@latest
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin $(GOLANGCI_VERSION)