Make golangci-lint happy (#115)

Author: tangrufus

.golangci.yml

@@ -1,26 +1,123 @@
 version: "2"
 
 linters:
-  default: all
-  disable:
+  enable:
+    # Default
+    - errcheck
+    - govet
+    - ineffassign
+    - staticcheck
+    - unused
+    # Custom
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - containedctx
+    - contextcheck
+    - copyloopvar
+    - cyclop
+    - depguard
+    - dogsled
+    - dupl
+    - dupword
+    - durationcheck
+    - embeddedstructfieldcheck
+    - errchkjson
+    - errname
+    - errorlint
+    - exhaustive
+    - exptostd
+    - fatcontext
+    - forcetypeassert
+    - gocheckcompilerdirectives
+    - gochecknoglobals
+    - gochecknoinits
+    - gocritic
+    - godoclint
+    - godot
+    - gosec
+    - misspell
+    - nolintlint
+    - nonamedreturns
     - revive
-    - testpackage
-    - varnamelen
-    - wsl
+    - sloglint
+    - unparam
+    - usestdlibvars
+
+  settings:
+    govet:
+      enable-all: true
+      disable:
+        - fieldalignment
+
+    staticcheck:
+      checks:
+        - all
+
+    # Custom
+    depguard:
+      rules:
+        all:
+          list-mode: strict
+          files:
+            - $all
+            - "!$test"
+          allow:
+            - $gostd
+            - github.com/typisttech/comver
+        test:
+          files:
+            - $test
+          deny:
+            - pkg: github.com/stretchr/testify
+              desc: Use standard library or 'github.com/google/go-cmp/cmp'
+
+    exhaustive:
+      default-signifies-exhaustive: true
+
+    gocritic:
+      enabled-checks:
+        - emptyStringTest
+        - preferStringWriter
+
+    godoclint:
+      enable:
+        - max-len
+        - no-unused-link
+        - require-stdlib-doclink
+
+    godot:
+      scope: toplevel
+      capital: true
+
+    nolintlint:
+      require-specific: true
+
+    revive:
+      rules:
+        - name: exported
+          disabled: true
+
   exclusions:
+    generated: disable
+    warn-unused: true
     rules:
       - path: _test\.go
         linters:
-          - depguard
           - dupl
-          - funlen
-          - lll
-          - maintidx
+
+      - path: doc.go
+        linters:
+          - godoclint
 
 formatters:
   enable:
     - gci
     - gofmt
     - gofumpt
     - goimports
-    - swaggo
+
+  settings:
+    gofumpt:
+      extra-rules: true

and.go

@@ -8,9 +8,9 @@ const (
 	errImpossibleInterval stringError = "impossible interval"
 )
 
-// And returns a [CeilingFloorConstrainter] instance representing the logical AND of
-// the given [Endless] instances; or return an error if the given [Endless] instances
-// could never be satisfied at the same time.
+// And returns a [CeilingFloorConstrainter] instance representing the logical
+// AND of the given [Endless] instances; or return an error if the given
+// [Endless] instances could never be satisfied at the same time.
 func And(es ...Endless) (CeilingFloorConstrainter, error) { //nolint:cyclop,ireturn
 	var nilC CeilingFloorConstrainter
 

compact.go

@@ -4,7 +4,9 @@ import (
 	"slices"
 )
 
-// Compact returns a new [Constrainter] that is logically equivalent to the input [Or].
+// Compact returns a new [Constrainter] that is logically equivalent to the
+// input [Or].
+//
 // The returned [Constrainter] may or may be not be an [Or] instance.
 // When it is, Compact tries to return the shortest [Or] possible.
 func Compact(o Or) Constrainter { //nolint:cyclop,ireturn

endless.go

@@ -1,8 +1,9 @@
 package comver
 
-// Endless represents a constraint that is either floor bounded, ceiling bounded,
-// or [match all].
-// The zero value for Endless is a [match all] constraint which satisfied by any [Version].
+// Endless represents a constraint that is either floor bounded, ceiling
+// bounded, or [match all].
+// The zero value for Endless is a [match all] constraint which satisfied by any
+// [Version].
 //
 // [match all]: https://github.com/composer/semver/blob/main/src/Constraint/MatchAllConstraint.php
 type Endless struct {
@@ -103,9 +104,13 @@ func (b Endless) matchAll() bool {
 //
 // The comparison is done by comparing the version first, then the operator.
 //   - Versions are compared according to their semantic precedence
-//   - Operators are compared in the following order (lowest to highest): >=, >, <, <=
-//   - Match all [Endless] is considered to be higher than ceiling bounded [Endless] while
-//     lower than floor bounded [Endless]
+//   - Operators are compared in the following order (lowest to highest):
+//   - >=
+//   - >
+//   - <
+//   - <=
+//   - Match all [Endless] is considered to be higher than ceiling bounded
+//     [Endless] while lower than floor bounded [Endless]
 //
 // The result is 0 when b == d, -1 when b < d, or +1 when b > d.
 func (b Endless) compare(d Endless) int {

internal/wordfencetest/gen.go

@@ -13,9 +13,10 @@ const fileTemplateRaw = `// Code generated by {{ .GeneratedBy }}; DO NOT EDIT.
 {{- range .Sources }}
 //   - {{ . }}
 {{- end }}
+
 package main
 
-var {{ .VariableName }} = []string{
+var {{ .VariableName }} = []string{ //nolint:gochecknoglobals
 {{- range .Versions }}
 	{{ printf "%q" . }},
 {{- end }}

internal/wordfencetest/wordfence_test.go

@@ -1,7 +1,7 @@
 package comver
 
-// interval represents a constraint that is both floor bounded and ceiling bounded.
-// It must be initialized via [And].
+// interval represents a constraint that is both floor bounded and ceiling
+// bounded. It must be initialized via [And].
 type interval struct {
 	upper Endless
 	lower Endless

interval.go

@@ -3,10 +3,11 @@ package comver
 import "strings"
 
 //nolint:godox
-// TODO: Make Or to be []Constrainter so that we can nest Or
+// TODO: Make Or to be []Constrainter so that we can nest Or.
 
-// Or represents a logical OR operation between multiple [CeilingFloorConstrainter] instances.
-// The zero value for Or is a [match none] constraint which could never be satisfied.
+// Or represents a logical OR operation between multiple
+// [CeilingFloorConstrainter] instances. The zero value for Or is a [match none]
+// constraint which could never be satisfied.
 //
 // [match none]: https://github.com/composer/semver/blob/main/src/Constraint/MatchNoneConstraint.php
 type Or []CeilingFloorConstrainter

or.go

@@ -38,12 +38,13 @@ type Version struct {
 // Parse parses a given version string, attempts to coerce a version string into
 // a [Version] object or return an error if unable to parse the version string.
 //
-// If there is a leading v or a version listed without all parts (e.g. v1.2.p5+foo) it
-// attempt to coerce it into a valid composer version (e.g. 1.2.0.0-patch5). In both cases
-// a [Version] object is returned that can be sorted, compared, and used in constraints.
+// If there is a leading v or a version listed without all parts
+// (e.g. v1.2.p5+foo) it attempt to coerce it into a valid composer version
+// (e.g. 1.2.0.0-patch5). In both cases a [Version] object is returned that can
+// be sorted, compared, and used in constraints.
 //
-// Due to implementation complexity, it only supports a subset of [composer versioning].
-// Refer to the [version_test.go] for examples.
+// Due to implementation complexity, it only supports a subset of
+// [composer versioning]. Refer to the [version_test.go] for examples.
 //
 // [composer versioning]: https://github.com/composer/semver/
 // [version_test.go]: https://github.com/typisttech/comver/blob/main/version_test.go