chore: update golangci-lint; enable revive & address lints

Signed-off-by: Tyler Gillson <tyler.gillson@gmail.com>

Author: TylerGillson

.golangci.yaml

@@ -1,53 +1,34 @@
-## golangci-lint v1.55.2
-
-# References:
-# - https://golangci-lint.run/usage/linters/
-# - https://gist.github.com/maratori/47a4d00457a92aa426dbd48a18776322
-
 run:
-  timeout: 10m # default 1m
-
-linters-settings:
-  gosimple:
-    go: "1.21" # default 1.13
-  govet:
-    enable-all: true
-    disable:
-      - fieldalignment # too strict
-      - shadow # too strict
-  staticcheck:
-    go: "1.21" # default 1.13
+  timeout: 5m
+  allow-parallel-runners: true
 
-  # Non-default
-  cyclop:
-    max-complexity: 15 # maximal code complexity to report; default 10
-    package-average: 0.0 # maximal average package complexity to report; default 0.0
-  gocognit:
-    min-complexity: 30 # minimal code complexity to report; default: 30
+issues:
+  # don't skip warning about doc comments
+  # don't exclude the default set of lint
+  exclude-use-default: false
+  exclude-files:
+    - ".*test\\.go$"
 
 linters:
   disable-all: true
   enable:
-    ## enabled by default
-    - errcheck # Errcheck is a program for checking for unchecked errors in go programs. These unchecked errors can be critical bugs in some cases
-    - ineffassign # Detects when assignments to existing variables are not used
-    - typecheck # Like the front-end of a Go compiler, parses and type-checks Go code
-    - gosimple # Linter for Go source code that specializes in simplifying a code
-    - govet # Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
-    - unused # Checks Go code for unused constants, variables, functions and types
-    - staticcheck # Staticcheck is a go vet on steroids, applying a ton of static analysis checks
-    ## disabled by default
-    - cyclop # checks function and package cyclomatic complexity
-    - gocognit # Computes and checks the cognitive complexity of functions
-
-issues:
-  max-issues-per-linter: 0
-  max-same-issues: 0
-  exclude-rules:
-    - path: _test\.go
-      linters:
-        - errcheck
-        - gosimple
-        - ineffassign
-        - staticcheck
-        - unused
+    - dupl
+    - errcheck
+    - exportloopref
+    - ginkgolinter
+    - goconst
+    - gocyclo
+    - gofmt
+    - goimports
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - nakedret
+    - prealloc
+    - revive
+    - staticcheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused

Makefile

@@ -5,7 +5,7 @@
 
 # binary versions
 BIN_DIR ?= ./bin
-GOLANGCI_VERSION ?= 1.55.2
+GOLANGCI_VERSION ?= 1.59.1
 
 GOOS ?= $(shell go env GOOS)
 GOARCH ?= $(shell go env GOARCH)

prompts/file.go

@@ -13,8 +13,10 @@ import (
 )
 
 var (
-	editorBinary   = "vi"
-	editorPath     = ""
+	editorBinary = "vi"
+	editorPath   = ""
+
+	// GetCmdExecutor allows monkey-patching the command executor for testing purposes.
 	GetCmdExecutor = getEditorExecutor
 )
 

prompts/mocks/file_editor.go

@@ -0,0 +1,38 @@
+// Package mocks contains mock implementations of the interfaces in the prompts package for testing purposes.
+package mocks
+
+import (
+	"os"
+)
+
+// CommandExecutor is an interface for executing commands.
+type CommandExecutor interface {
+	Start() error
+	Wait() error
+}
+
+// MockFileEditor is a mock implementation of the FileEditor interface for testing purposes.
+type MockFileEditor struct {
+	FileContents []string
+	filename     string
+}
+
+// Start writes the next value in the FileContents slice to the file.
+func (m *MockFileEditor) Start() error {
+	if err := os.WriteFile(m.filename, []byte(m.FileContents[0]), 0600); err != nil {
+		return err
+	}
+	m.FileContents = m.FileContents[1:]
+	return nil
+}
+
+// Wait is a no-op to satisfy the CommandExecutor interface.
+func (m *MockFileEditor) Wait() error {
+	return nil
+}
+
+// GetCmdExecutor returns a CommandExecutor that writes to the given filename.
+func (m *MockFileEditor) GetCmdExecutor(_ string, filename string) CommandExecutor {
+	m.filename = filename
+	return m
+}

prompts/mocks/file_editor_mocks.go

@@ -7,6 +7,7 @@ import (
 	"golang.org/x/exp/slices"
 )
 
+// MockTUI is a mock implementation of the TUI interface for testing purposes.
 type MockTUI struct {
 	Values        []string
 	SliceValues   [][]string
@@ -15,7 +16,8 @@ type MockTUI struct {
 	validateSlice func([]string) error
 }
 
-func (m *MockTUI) GetBool(prompt string, defaultVal bool) (bool, error) {
+// GetBool returns the next value in the Values slice as a bool.
+func (m *MockTUI) GetBool(_ string, defaultVal bool) (bool, error) {
 	val, err := m.run()
 	if err != nil {
 		return false, err
@@ -30,21 +32,24 @@ func (m *MockTUI) GetBool(prompt string, defaultVal bool) (bool, error) {
 	return val == "y", err
 }
 
-func (m *MockTUI) GetText(prompt, defaultVal, mask string, optional bool, validate func(string) error) (string, error) {
+// GetText returns the next value in the Values slice as a string.
+func (m *MockTUI) GetText(_, _, _ string, _ bool, validate func(string) error) (string, error) {
 	if validate != nil {
 		m.validate = validate
 	}
 	return m.run()
 }
 
-func (m *MockTUI) GetTextSlice(prompt, defaultVal string, optional bool, validate func([]string) error) ([]string, error) {
+// GetTextSlice returns the next value in the SliceValues slice as a []string.
+func (m *MockTUI) GetTextSlice(_, _ string, _ bool, validate func([]string) error) ([]string, error) {
 	if validate != nil {
 		m.validateSlice = validate
 	}
 	return m.runSlice()
 }
 
-func (m *MockTUI) GetSelection(prompt string, options []string) (string, error) {
+// GetSelection returns the next value in the Values slice as a string.
+func (m *MockTUI) GetSelection(_ string, options []string) (string, error) {
 	val, err := m.run()
 	if err != nil {
 		return val, err
@@ -55,7 +60,8 @@ func (m *MockTUI) GetSelection(prompt string, options []string) (string, error)
 	return val, nil
 }
 
-func (m *MockTUI) GetMultiSelection(prompt string, options []string, minSelections int) ([]string, error) {
+// GetMultiSelection returns the next minSelections values in the Values slice as a []string.
+func (m *MockTUI) GetMultiSelection(_ string, _ []string, minSelections int) ([]string, error) {
 	vals := make([]string, 0)
 	for i := 0; i < minSelections; i++ {
 		val, err := m.run()