Draft Test Lint

.github/workflows/golangci.lint.yml

@@ -0,0 +1,34 @@
+name: golangci-lint
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+      - name: Get go version from go.mod
+        run: |
+          echo "GO_VERSION=$(grep '^go ' go.mod | cut -d " " -f 2)" >> $GITHUB_ENV
+      - name: Setup-go
+        uses: actions/setup-go@v3
+        with:
+            go-version: 1.22
+      - name: Run Lint
+        run: |
+          make remove-lint
+          make golanci-lint
+          make go-lint
+
+

.golangci.yml

@@ -0,0 +1,67 @@
+
+linters-settings:
+  goconst:
+    min-len: 2
+    min-occurrences: 3
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+  govet:
+    enable:
+      - shadow  
+      - fieldalignment
+  nolintlint:
+    require-explanation: true
+    require-specific: true
+
+linters:
+  disable-all: true
+  enable:
+    - bodyclose
+#    - unused # intentionally commented to avoid unused func warning as this repo is library
+#    - depguard
+    - dogsled
+    - dupl
+    - errcheck
+    - copyloopvar
+    - exhaustive
+    - goconst
+    - gocritic
+    - gofmt
+    - goimports
+    - gocyclo
+    - gosec
+    - gosimple
+#   - govet # intentionally disabled because we choose readability over performance
+    - ineffassign
+    - misspell
+    - nolintlint
+    - nakedret
+    - prealloc # pre-allocate slices with define size if the slice size is known in advance
+    - predeclared
+    - revive
+    - staticcheck
+    - stylecheck
+    - thelper
+    - tparallel
+    - typecheck
+    - unconvert
+    - unparam
+    - whitespace
+    - lll
+    - wsl # While space linter
+
+run:
+  issues-exit-code: 1
+  go: '1.22'
+
+issues:
+  exclude-dirs:
+    - testdata
+    - .git
+    - schema/schemas
+

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/tekwizely/pre-commit-golang
+    rev: v1.0.0-rc.1 # change this to the latest version
+    hooks:
+      - id: go-mod-tidy
+      - id: golangci-lint
+        args:
+          - --config=.golangci.yml
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

Makefile

@@ -1,3 +1,10 @@
+# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
+ifeq (,$(shell go env GOBIN))
+GOBIN=$(shell go env GOPATH)/bin
+else
+GOBIN=$(shell go env GOBIN)
+endif
+
 # Variables required for this Makefile
 ROOT_DIR = $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
 VERSION = $(shell git describe --tags --always)
@@ -25,6 +32,22 @@ SOURCES := $(shell find . -name "*.go")
 $(ACONFIG_BIN): $(SOURCES)
 	$(GO_ENV_VARS) go build -ldflags="-X 'github.com/aerospike/asconfig/cmd.VERSION=$(VERSION)'" -o $(ACONFIG_BIN) .
 
+GOLANGCI_LINT ?= $(GOBIN)/golangci-lint
+GOLANGCI_LINT_VERSION ?= v1.61.0
+
+.PHONY: golanci-lint
+golanci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
+$(GOLANGCI_LINT): $(GOBIN)
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOBIN) $(GOLANGCI_LINT_VERSION)
+
+go-lint: golanci-lint ## Run golangci-lint against code.
+	$(GOLANGCI_LINT) run -c .golangci.yml -v
+
+
+.PHONY: remove-lint
+remove-lint:
+	$(RM) ${GOBIN}/golangci-lint
+
 # Clean up
 .PHONY: clean
 clean: