Add golangci-lint configuration and appease some linters

.github/workflows/golangci-lint.yml

@@ -0,0 +1,29 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - master
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.21'
+          cache: false
+      # Install libgit2-dev 1.5 for git2go
+      - run: sudo apt-get install -qqy wget
+      - run: wget http://archive.ubuntu.com/ubuntu/pool/universe/libg/libgit2/libgit2-{1.5,dev}_1.5.1+ds-1ubuntu1_amd64.deb
+      - run: sudo apt-get install -qqy ./*.deb
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.54

.golangci.yaml

@@ -0,0 +1,121 @@
+---
+linters:
+  enable-all: true
+  disable:
+    # Disabled to get codebase to pass the linter.
+    # We can enable these one at a time.
+    - cyclop
+    - forcetypeassert
+    - funlen
+    - gochecknoglobals
+    - gochecknoinits
+    - godox
+    - revive
+    - stylecheck
+    - wrapcheck
+    # Disabled permanently
+    - exhaustruct     # structs may be uninitialized
+    - nlreturn        # covered by wsl cuddle rules
+    - paralleltest    # tests are acceptable in sequence
+    - goimports       # conflicts with GCI
+    - depguard        # manage using go.mod for now
+    - nonamedreturns  # named returns are acceptable in short functions
+    # Deprecated
+    - exhaustivestruct
+    - scopelint
+    - interfacer
+    - maligned
+    - golint
+    - structcheck
+    - varcheck
+    - deadcode
+    - nosnakecase
+    - ifshort
+
+severity:
+  default-severity: major
+
+issues:
+  fast: false
+  max-issues-per-linter: 0
+  max-same-issues: 0
+  exclude-use-default: false
+  exclude-case-sensitive: true
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - gochecknoglobals
+        - errcheck
+        - wrapcheck
+        - gosec
+        - goerr113
+
+linters-settings:
+  exhaustive:
+    default-signifies-exhaustive: true
+
+  errcheck:
+    exclude-functions:
+      - (*os.File).Close
+
+  gci:
+    sections:
+      - standard
+      - default
+      - prefix(github.com/getsolus/usysconf)
+
+  gomnd:
+    ignored-numbers: ['2', '4', '8', '16', '32', '64', '10']
+
+  gosec:
+    excludes: []
+
+  govet:
+    enable-all: true
+    disable:
+      - fieldalignment  # misalignment is accepted
+
+  revive:
+    enable-all-rules: false
+    rules:  # see https://github.com/mgechev/revive#recommended-configuration
+      - name: blank-imports
+      - name: context-as-argument
+      - name: context-keys-type
+      - name: dot-imports
+      - name: error-return
+      - name: error-strings
+      - name: error-naming
+      - name: exported
+      - name: if-return
+      - name: increment-decrement
+      - name: var-naming
+      - name: var-declaration
+      - name: package-comments
+      - name: range
+      - name: receiver-naming
+      - name: time-naming
+      - name: unexported-return
+      - name: indent-error-flow
+      - name: errorf
+      - name: empty-block
+      - name: superfluous-else
+      - name: unused-parameter
+      - name: unreachable-code
+      - name: redefines-builtin-id
+
+  stylecheck:
+    checks: [all]
+
+  tagalign:
+    order:
+      - zero
+      - short
+      - long
+      - desc
+      - cmd
+      - arg
+      - aliases
+      - help
+
+  varnamelen:
+    min-name-length: 1

Makefile

@@ -54,16 +54,7 @@ uninstall:
 	$(RMDIR_IF_EMPTY) $(BINDIR)
 
 check:
-	$(GO) get -u golang.org/x/lint/golint
-	$(GO) get -u github.com/securego/gosec/cmd/gosec
-	$(GO) get -u honnef.co/go/tools/cmd/staticcheck
-	$(GO) get -u gitlab.com/opennota/check/cmd/aligncheck
-	$(GO) fmt -x ./...
-	$(GO) vet ./...
-	golint -set_exit_status `go list ./... | grep -v vendor`
-	gosec -exclude=G204 ./...
-	staticcheck ./...
-	aligncheck ./...
+	$(shell $(GO) env GOPATH)/bin/golangci-lint run
 	$(GO) test -cover ./...
 
 vendor: check clean

cli/cli.go

@@ -23,22 +23,23 @@ var Version string = "unknown"
 
 // GlobalFlags contains the flags for all commands.
 type GlobalFlags struct {
-	Debug   bool             `short:"d" long:"debug"  help:"Run in debug mode."`
-	Chroot  bool             `short:"c" long:"chroot" help:"Specify that command is being run from a chrooted environment."`
-	Live    bool             `short:"l" long:"live"   help:"Specify that command is being run from a live medium."`
-	Version kong.VersionFlag `short:"v" long:"version"   help:"Print version and exit."`
+	Debug   bool             `short:"d" long:"debug"   help:"Run in debug mode."`
+	Chroot  bool             `short:"c" long:"chroot"  help:"Specify that command is being run from a chrooted environment."` //nolint:lll
+	Live    bool             `short:"l" long:"live"    help:"Specify that command is being run from a live medium."`
+	Version kong.VersionFlag `short:"v" long:"version" help:"Print version and exit."`
 }
 
 type arguments struct {
 	GlobalFlags
 
-	Run   run   `cmd:"" aliases:"r" help:"Run specified trigger(s) to update the system configuration."`
+	Run   run   `cmd:"" aliases:"r"  help:"Run specified trigger(s) to update the system configuration."`
 	List  list  `cmd:"" aliases:"ls" help:"List available triggers to run (user-specific)."`
-	Graph graph `cmd:"" aliases:"g" help:"Print the dependencies for all available triggers."`
+	Graph graph `cmd:"" aliases:"g"  help:"Print the dependencies for all available triggers."`
 }
 
 func Parse() (*kong.Context, GlobalFlags) {
 	var args arguments
 	ctx := kong.Parse(&args, kong.Vars{"version": Version})
+
 	return ctx, args.GlobalFlags
 }

cli/graph.go

@@ -22,12 +22,14 @@ import (
 
 type graph struct{}
 
-// GraphDepsRun prints the usage for the requested command
+// GraphDepsRun prints the usage for the requested command.
 func (g graph) Run(flags GlobalFlags) error {
 	tm, err := config.LoadAll()
 	if err != nil {
 		return fmt.Errorf("failed to load triggers: %w", err)
 	}
+
 	tm.Graph(flags.Chroot, flags.Live).Print()
+
 	return nil
 }

cli/list.go

@@ -28,7 +28,9 @@ func (l list) Run(flags GlobalFlags) error {
 	if err != nil {
 		return fmt.Errorf("failed to load triggers: %w", err)
 	}
+
 	slog.Info("Available triggers:")
 	tm.Print(flags.Chroot, flags.Live)
+
 	return nil
 }

cli/run.go

@@ -26,18 +26,22 @@ import (
 
 type run struct {
 	Force  bool `short:"f" long:"force"   help:"Force run the configuration regardless if it should be skipped."`
-	DryRun bool `short:"n" long:"dry-run" help:"Test the configuration files without executing the specified binaries and arguments."`
+	DryRun bool `short:"n" long:"dry-run" help:"Test the configuration files without executing the specified binaries and arguments."` //nolint:lll
 
 	Triggers []string `arg:"" help:"Names of the triggers to run." optional:""`
 }
 
+var errNeedRoot = errors.New("you must have root privileges to run triggers")
+
 func (r run) Run(flags GlobalFlags) error {
 	if os.Geteuid() != 0 {
-		return errors.New("you must have root privileges to run triggers")
+		return errNeedRoot
 	}
+
 	if util.IsChroot() {
 		flags.Chroot = true
 	}
+
 	if util.IsLive() {
 		flags.Live = true
 	}
@@ -64,5 +68,6 @@ func (r run) Run(flags GlobalFlags) error {
 	}
 	// Run triggers.
 	tm.Run(s, n)
+
 	return nil
 }

config/load.go

@@ -35,36 +35,47 @@ func Load(path string) (triggers.Map, error) {
 			logger.Debug("Directory not found")
 			return nil, nil
 		}
+
 		return nil, fmt.Errorf("failed to read triggers: %w", err)
 	}
+
 	tm := make(triggers.Map, len(entries))
+
 	logger.Debug("Scanning directory")
+
 	for _, entry := range entries {
 		if entry.IsDir() {
 			continue
 		}
+
 		name := entry.Name()
 		if !strings.HasSuffix(name, ".toml") {
 			continue
 		}
+
 		t := triggers.Trigger{
 			Name: strings.TrimSuffix(name, ".toml"),
 			Path: filepath.Clean(filepath.Join(path, name)),
 		}
 		logger.Debug("Trigger found", "name", t.Name)
+
 		err = t.Load(t.Path)
 		if err != nil {
 			return nil, err
 		}
+
 		err = t.Validate()
 		if err != nil {
 			return nil, fmt.Errorf("failed to read %s from %s: %w", name, path, err)
 		}
+
 		tm[t.Name] = t
 	}
+
 	if len(tm) == 0 {
 		logger.Debug("No triggers found")
 	}
+
 	return tm, nil
 }
 
@@ -76,6 +87,7 @@ func LoadAll() (triggers.Map, error) {
 	if p, err := os.UserHomeDir(); err != nil {
 		paths = append(paths, p)
 	}
+
 	if os.Getuid() == 0 {
 		uname := os.Getenv("SUDO_USER")
 		if uname != "" && uname != "root" {
@@ -89,13 +101,17 @@ func LoadAll() (triggers.Map, error) {
 	}
 
 	tm := make(triggers.Map)
+
 	for _, path := range paths {
 		trig, err := Load(path)
 		if err != nil {
 			return nil, err
 		}
+
 		tm.Merge(trig)
 	}
+
 	slog.Info("Total triggers", "count", len(tm))
+
 	return tm, nil
 }

config/paths.go

@@ -15,8 +15,8 @@
 package config
 
 var (
-	// UsrDir is the path defined during build (Makefile) i.e. /usr/share/defaults/usysconf.d
+	// UsrDir is the path defined during build (Makefile) i.e. `/usr/share/defaults/usysconf.d`.
 	UsrDir string
-	// SysDir is the path defined during build (Makefile) i.e. /etc/usysconf.d
+	// SysDir is the path defined during build (Makefile) i.e. `/etc/usysconf.d`.
 	SysDir string
 )