chore(deps): fix lint and update deps and comments (#45)

Author: plastikfan

.github/workflows/ci-workflow.yml

@@ -8,20 +8,20 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-go@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: 1.23
-      - uses: actions/checkout@v3
+          go-version: 1.26
+      - uses: actions/checkout@v4
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v7
         with:
-          version: v1.60.3
+          version: v2.10.1
           args: --verbose
 
   test:
     strategy:
       matrix:
-        go-version: [1.23]
+        go-version: [1.26]
         platform: [ubuntu-latest, macos-latest]
 
     runs-on: ${{ matrix.platform }}

.golangci.yml

@@ -1,72 +1,79 @@
-linters-settings:
-  errcheck:
-    check-type-assertions: true
-  goconst:
-    min-len: 2
-    min-occurrences: 3
-  gocritic:
-    enabled-tags:
-      - diagnostic
-      - experimental
-      - opinionated
-      - performance
-      - style
-  govet:
-    shadow: true
-    disable:
-      - fieldalignment # too strict
+version: "2"
+
+run:
+  timeout: 5m
+  issues-exit-code: 1
 
-  nolintlint:
-    require-explanation: false
-    require-specific: true
 linters:
-  disable-all: true
   enable:
-    - bodyclose
-    # - deadcode
-    # depguard needs to be reviewed properly and then configured, before
-    # it can be re-enabled.
-    # https://github.com/OpenPeeDeeP/depguard#example-configs
-    # - depguard
-    - copyloopvar
-    - dogsled
-    # - dupl
+    # correctness
     - errcheck
-    - exhaustive
-    - goconst
-    - gocritic
-    - gofmt
-    - goimports
-    - gocyclo
-    - gosec
-    - gosimple
     - govet
+    - staticcheck
     - ineffassign
-    - misspell
-    - mnd
-    - nolintlint
-    - nakedret
+
+    # bug prevention
+    - copyloopvar
+    - bodyclose
+    - exhaustive
+    - unparam
+    - unconvert
+
+    # code quality
+    # - gocyclo   # TODO: enable later, need to fix complexity issues
+    - goconst
+    - revive
     - prealloc
     - predeclared
-    - revive
-    - staticcheck
-    # - structcheck
-    - stylecheck
+
+    # security
+    - gosec
+
+    # testing
     - thelper
     - tparallel
-    - unconvert
-    - unparam
-    # - varcheck
+
+    # misc
+    - misspell
     - whitespace
-    - wsl
+    - nolintlint
+    - dogsled
+
+  settings:
+    errcheck:
+      check-type-assertions: true
+
+    goconst:
+      min-len: 2
+      min-occurrences: 3
+
+    gocyclo:
+      min-complexity: 15
+
+    govet:
+      enable:
+        - shadow
 
+    revive:
+      severity: warning
+
+    nolintlint:
+      require-explanation: false
+      require-specific: true
+
+  exclusions:
+    rules:
+      # Ginkgo/Gomega test suites use dot-imports by convention; suppress the
+      # revive dot-imports warning for all test files.
+      - path: '_test\.go'
+        linters:
+          - revive
+        text: 'dot-imports'
+      - path: '-auto\.go'
+        linters:
+          - errcheck
+        text: 'Error return value is not checked'
 issues:
   max-issues-per-linter: 0
   max-same-issues: 0
-  fix: true
-  exclude:
-    - "cuddle"
-
-run:
-  issues-exit-code: 1
-  timeout: "5m"
+  fix: false

README.md

@@ -31,7 +31,7 @@
 
 ## 🔰 Introduction
 
-_[Cobra](https://cobra.dev/) is an excellent framework for the development of command line applications, but is missing a few features that would make it a bit easier to work with. This package aims to fulfil this purpose, especially in regards to creation of commands, encapsulating commands into a container and providing an export mechanism to re-create cli data in a form that is free from cobra (and indeed sundae) abstractions. The aim of this last aspect to to be able to inject data into the core of an application in a way that removes tight coupling to the `Cobra` framework, which is achieved by representing data only in terms of client defined (native) abstractions.
+[Cobra](https://cobra.dev/) is an excellent framework for the development of command line applications, but is missing a few features that would make it a bit easier to work with. This package aims to fulfil this purpose, especially in regards to creation of commands, encapsulating commands into a container and providing an export mechanism to re-create cli data in a form that is free from cobra (and indeed sundae) abstractions. The aim of this last aspect to to be able to inject data into the core of an application in a way that removes tight coupling to the `Cobra` framework, which is achieved by representing data only in terms of client defined (native) abstractions.
 
 ## 📚 Usage
 

assist/assist-suite_test.go

@@ -3,8 +3,8 @@ package assist_test
 import (
 	"testing"
 
-	. "github.com/onsi/ginkgo/v2" //nolint:revive // ginkgo ok
-	. "github.com/onsi/gomega"    //nolint:revive // gomega ok
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"   
 )
 
 func TestAssist(t *testing.T) {

assist/cfg/cfg-suite_test.go

@@ -3,8 +3,8 @@ package cfg_test
 import (
 	"testing"
 
-	. "github.com/onsi/ginkgo/v2" //nolint:revive // ginkgo ok
-	. "github.com/onsi/gomega"    //nolint:revive // gomega ok
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"   
 )
 
 func TestCfg(t *testing.T) {

assist/cfg/global-config_test.go

@@ -6,8 +6,8 @@ import (
 	"path/filepath"
 	"time"
 
-	. "github.com/onsi/ginkgo/v2" //nolint:revive // ginkgo ok
-	. "github.com/onsi/gomega"    //nolint:revive // gomega ok
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"   
 	"github.com/spf13/viper"
 	"go.uber.org/mock/gomock"
 

assist/clif/clif-suite_test.go

@@ -3,8 +3,8 @@ package clif_test
 import (
 	"testing"
 
-	. "github.com/onsi/ginkgo/v2" //nolint:revive // ginkgo ok
-	. "github.com/onsi/gomega"    //nolint:revive // gomega ok
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"   
 )
 
 func TestClif(t *testing.T) {

assist/clif/evaluate_test.go

@@ -3,8 +3,8 @@ package clif_test
 import (
 	"fmt"
 
-	. "github.com/onsi/ginkgo/v2" //nolint:revive // ginkgo ok
-	. "github.com/onsi/gomega"    //nolint:revive // gomega ok
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"   
 
 	"github.com/snivilised/sundae/assist/clif"
 )

assist/clif/expand_test.go

@@ -3,8 +3,8 @@ package clif_test
 import (
 	"fmt"
 
-	. "github.com/onsi/ginkgo/v2" //nolint:revive // ginkgo ok
-	. "github.com/onsi/gomega"    //nolint:revive // gomega ok
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"   
 
 	"github.com/snivilised/sundae/assist/clif"
 )

assist/param-set-data_test.go

@@ -1,7 +1,6 @@
 package assist_test
 
 import (
-	"fmt"
 	"net"
 	"time"
 
@@ -65,42 +64,3 @@ type WidgetParameterSet struct {
 }
 
 type InvalidParameterSet string
-
-func duration(d string) time.Duration {
-	result, _ := time.ParseDuration(d)
-	return result
-}
-
-func ipmask(v string) net.IPMask {
-	var result net.IPMask
-
-	switch v {
-	case "default":
-		result = net.IPMask([]byte{0, 0, 0, 0})
-
-	case "orion.net":
-		result = net.IPMask([]byte{255, 255, 255, 0})
-
-	default:
-		panic(fmt.Errorf("no ipmask defined for: '%v'", v))
-	}
-
-	return result
-}
-
-func ipnet(v string) net.IPNet {
-	var result net.IPNet
-
-	switch v {
-	case "default":
-		result = net.IPNet{IP: net.IPv4(0, 0, 0, 0), Mask: ipmask(v)}
-
-	case "orion.net":
-		result = net.IPNet{IP: net.IPv4(172, 16, 0, 0), Mask: ipmask(v)}
-
-	default:
-		panic(fmt.Errorf("no ipnet defined for: '%v'", v))
-	}
-
-	return result
-}