Add linting

Author: Maarten van der Heijden

.golangci.yaml

@@ -0,0 +1,86 @@
+linters-settings:
+  gocritic:
+    disabled-checks:
+      - "paramTypeCombine"
+    enabled-tags:
+      - "performance"
+      - "style"
+      - "diagnostic"
+linters:
+  enable:
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - containedctx
+    - contextcheck
+    - cyclop
+    - decorder
+    - dogsled
+    - dupword
+    - durationcheck
+    - errcheck
+    - errname
+    - errorlint
+    - execinquery
+    - exhaustive
+    - exportloopref
+    - forbidigo
+    - ginkgolinter
+    - gocheckcompilerdirectives
+    - gochecknoinits
+    - gocognit
+    - goconst
+    - gocritic
+    - gocyclo
+    - goerr113
+    - gofmt
+    - gofumpt
+    - goheader
+    - goimports
+    - gomoddirectives
+    - gomodguard
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - gosmopolitan
+    - govet
+    - grouper
+    - ifshort
+    - importas
+    - ineffassign
+    - interfacebloat
+    - interfacer
+    - ireturn
+    - loggercheck
+    - maintidx
+    - makezero
+    - mirror
+    - misspell
+    - musttag
+    - nakedret
+    - nestif
+    - nilerr
+    - nilnil
+    - nlreturn
+    - nonamedreturns
+    - nosprintfhostport
+    - paralleltest
+    - prealloc
+    - predeclared
+    - promlinter
+    - reassign
+    - rowserrcheck
+    - sqlclosecheck
+    - staticcheck
+    - tenv
+    - thelper
+    - tparallel
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - usestdlibvars
+    - wastedassign
+    - whitespace
+    - zerologlint

Makefile

@@ -12,4 +12,11 @@ test: fmt ## Run unit tests, alias: t
 
 fmt: ## Format go code
 	@go mod tidy
-	@go fmt ./...
+	@gofumpt -l -w .
+
+tools: ## Install extra tools for development
+	go install mvdan.cc/gofumpt@latest
+	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+
+lint: ## Lint the code locally
+	golangci-lint run --timeout 600s

plugin.go

@@ -35,6 +35,8 @@ func SettingOnly() Option {
 
 // New creates a new instance of the plugin that can be registered in gorm. Without any settings, all queries will be
 // LIKE-d.
+//
+//nolint:ireturn // Acceptable
 func New(opts ...Option) gorm.Plugin {
 	plugin := &gormLike{}
 

plugin_test.go

@@ -1,9 +1,10 @@
 package gormlike
 
 import (
+	"testing"
+
 	"github.com/ing-bank/gormtestutil"
 	"github.com/stretchr/testify/assert"
-	"testing"
 )
 
 func TestDeepGorm_Name_ReturnsExpectedName(t *testing.T) {

query.go

@@ -2,13 +2,15 @@ package gormlike
 
 import (
 	"fmt"
+	"strings"
+
 	"gorm.io/gorm"
 	"gorm.io/gorm/clause"
-	"strings"
 )
 
 const tagName = "gormlike"
 
+//nolint:gocognit,cyclop // Acceptable
 func (d *gormLike) queryCallback(db *gorm.DB) {
 	// If we only want to like queries that are explicitly set to true, we back out early if anything's amiss
 	settingValue, settingOk := db.Get(tagName)
@@ -110,6 +112,7 @@ func (d *gormLike) queryCallback(db *gorm.DB) {
 
 				if useOr {
 					query = query.Or(condition, value)
+
 					continue
 				}
 

query_test.go

@@ -1,13 +1,15 @@
 package gormlike
 
 import (
+	"testing"
+
 	"github.com/google/uuid"
 	"github.com/ing-bank/gormtestutil"
 	"github.com/stretchr/testify/assert"
 	"gorm.io/gorm"
-	"testing"
 )
 
+// nolint:maintidx // Acceptable
 func TestGormLike_Initialize_TriggersLikingCorrectly(t *testing.T) {
 	t.Parallel()