refactor: extend nix configuration to support linting and testing (#191)

As part of this rework, an improved golangci-lint configuration has been
adopted. All identified linting issues have been resolved. Minimal
refactoring was introduced through the (errname) linter

nsv: force~minor

Author: purpleclay

.github/workflows/ci.yml

@@ -20,25 +20,75 @@ permissions:
 
 jobs:
   test:
-    uses: purpleclay/github/.github/workflows/go-test.yml@main
     strategy:
       matrix:
-        os: [ubuntu-24.04, macos-14, windows-2022]
-    with:
-      go-version: ${{ vars.GO_VERSION }}
-    secrets:
-      github-token: ${{ secrets.GITHUB_TOKEN }}
-
-  # lint:
-  #   runs-on: ubuntu-24.04
-  #   steps:
-  #     - name: Checkout
-  #       uses: actions/checkout@v4
-
-  #     - name: golangci-lint
-  #       uses: dagger/dagger-for-github@v7
-  #       with:
-  #         verb: call
-  #         module: github.com/purpleclay/daggerverse/golang
-  #         args: --src . lint
-  #         cloud-token: ${{ secrets.DAGGER_CLOUD_TOKEN }}
+        os: [ubuntu-24.04, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - uses: cachix/install-nix-action@f0fe604f8a612776892427721526b4c7cfb23aba # v31
+
+      - uses: cachix/cachix-action@0fc020193b5a1fa3ac4575aa3a7d3aa6a35435ad # v16
+        with:
+          name: purpleclay
+          authToken: "${{ secrets.GH_CACHIX }}"
+
+      - run: nix run .#test
+
+      - name: Publish Summary
+        if: always()
+        run: nix develop -c tparse -format markdown -file reports/unittest.json -all > $GITHUB_STEP_SUMMARY
+        env:
+          NO_COLOR: 1
+
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - uses: cachix/install-nix-action@f0fe604f8a612776892427721526b4c7cfb23aba # v31
+
+      - uses: cachix/cachix-action@0fc020193b5a1fa3ac4575aa3a7d3aa6a35435ad # v16
+        with:
+          name: purpleclay
+          authToken: "${{ secrets.GH_CACHIX }}"
+
+      - run: nix run .#lint
+
+  alejandra:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - uses: cachix/install-nix-action@f0fe604f8a612776892427721526b4c7cfb23aba # v31
+
+      - uses: cachix/cachix-action@0fc020193b5a1fa3ac4575aa3a7d3aa6a35435ad # v16
+        with:
+          name: purpleclay
+          authToken: "${{ secrets.GH_CACHIX }}"
+          skipPush: true
+          useDaemon: false
+
+      - name: Run Alejandra
+        run: nix develop -c alejandra --check .
+
+  typos:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - uses: cachix/install-nix-action@f0fe604f8a612776892427721526b4c7cfb23aba # v31
+
+      - uses: cachix/cachix-action@0fc020193b5a1fa3ac4575aa3a7d3aa6a35435ad # v16
+        with:
+          name: purpleclay
+          authToken: "${{ secrets.GH_CACHIX }}"
+          skipPush: true
+          useDaemon: false
+
+      - name: Run Typos
+        run: nix develop -c typos

.gitignore

@@ -7,13 +7,15 @@
 !.gitignore
 !.golangci.yaml
 !.goreleaser.yaml
+!.zed/settings.json
 !CODEOWNERS
 !CODE_OF_CONDUCT.md
 !htmltest.yml
 !LICENSE
 !mkdocs.yml
 !README.md
 !taskfile.yaml
+!justfile
 !docs/**/*
 
 # Allow Nix files

.golangci.yaml

@@ -1,21 +1,62 @@
+version: "2"
 run:
   timeout: 5m
+  tests: true
 
 linters:
-  disable-all: true
+  default: none
   enable:
+    - bodyclose
+    - contextcheck
+    - copyloopvar
     - dupl
-    - gofumpt
-    - goimports
-    - gosimple
+    - durationcheck
+    - errcheck
+    - errname
+    - forbidigo
+    - goconst
+    - gocritic
+    - gocyclo
+    - godot
+    - gosec
     - govet
     - ineffassign
     - misspell
-    - nakedret
+    - nilnil
+    - reassign
     - revive
+    - spancheck
     - staticcheck
+    - tagliatelle
+    - testifylint
+    - thelper
+    - tparallel
     - unused
+    - wrapcheck
+  settings:
+    errcheck:
+      check-type-assertions: true
+    goconst:
+      numbers: true
+    gocyclo:
+      min-complexity: 15
+    tagliatelle:
+      case:
+        rules:
+          json: snake
+
+formatters:
+  enable:
+    - gci
+    - gofumpt
+
+  settings:
+    gci:
+      sections:
+        - standard
+        - default
+        - localmodule
 
-linters-settings:
-  dupl:
-    threshold: 400
+issues:
+  max-issues-per-linter: 50
+  max-same-issues: 0

.zed/settings.json

@@ -0,0 +1,21 @@
+{
+  "languages": {
+    "Nix": {
+      "language_servers": ["nil", "!nixd"]
+    }
+  },
+  "lsp": {
+    "nil": {
+      "initialization_options": {
+        "formatting": {
+          "command": ["alejandra", "--quiet", "--"]
+        }
+      },
+      "settings": {
+        "diagnostics": {
+          "ignored": ["unused_binding"]
+        }
+      }
+    }
+  }
+}

checkout.go

@@ -6,7 +6,7 @@ import (
 
 // CheckoutOption provides a way for setting specific options while attempting
 // to checkout a branch. Each supported option can customize how a branch is checked
-// out from the remote and integrated into the current repository (working directory)
+// out from the remote and integrated into the current repository (working directory).
 type CheckoutOption func(*checkoutOptions)
 
 type checkoutOptions struct {
@@ -18,7 +18,7 @@ type checkoutOptions struct {
 // any config defined within existing git config files. Config must be
 // provided as key value pairs, mismatched config will result in an
 // [ErrMissingConfigValue] error. Any invalid paths will result in an
-// [ErrInvalidConfigPath] error
+// [ErrInvalidConfigPath] error.
 func WithCheckoutConfig(kv ...string) CheckoutOption {
 	return func(opts *checkoutOptions) {
 		opts.Config = trim(kv...)
@@ -28,7 +28,7 @@ func WithCheckoutConfig(kv ...string) CheckoutOption {
 // Checkout will attempt to checkout a branch with the given name. If the branch
 // does not exist, it is created at the current working tree reference (or commit),
 // and then switched to. If the branch does exist, then switching to it restores
-// all working tree files
+// all working tree files.
 func (c *Client) Checkout(branch string, opts ...CheckoutOption) (string, error) {
 	options := &checkoutOptions{}
 	for _, opt := range opts {

checkout_test.go

@@ -3,10 +3,11 @@ package git_test
 import (
 	"testing"
 
-	git "github.com/purpleclay/gitz"
-	"github.com/purpleclay/gitz/gittest"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	git "github.com/purpleclay/gitz"
+	"github.com/purpleclay/gitz/gittest"
 )
 
 func TestCheckout(t *testing.T) {
@@ -21,7 +22,7 @@ write tests for branch checkout
 
 	// Inspect the raw git output
 	assert.Contains(t, out, "Switched to branch 'main'")
-	assert.Equal(t, gittest.LastCommit(t).Message, "docs: update existing project README")
+	assert.Equal(t, "docs: update existing project README", gittest.LastCommit(t).Message)
 }
 
 func TestCheckoutCreatesLocalBranch(t *testing.T) {