For Good

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: Checks
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  check-code:
+    name: Check code
+    runs-on: ubuntu-latest
+    env:
+      GO_VERSION: stable
+      GOLANGCI_LINT_VERSION: v1.63.4
+      CGO_ENABLED: 0
+
+    steps:
+
+      # https://github.com/marketplace/actions/checkout
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      # https://github.com/marketplace/actions/setup-go-environment
+      - name: Set up Go ${{ env.GO_VERSION }}
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: Check and get dependencies
+        run: |
+          go mod tidy
+          git diff --exit-code go.mod
+          git diff --exit-code go.sum
+
+      # https://golangci-lint.run/usage/install#other-ci
+      - name: Install golangci-lint ${{ env.GOLANGCI_LINT_VERSION }}
+        run: |
+          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
+          golangci-lint --version
+
+      - name: Make
+        run: make
+
+  check-local-install-script:
+    name: Installation script (local)
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check installation script
+        run: cat ./install-misspell.sh | sh -s -- -d -b "./install-misspell"

.github/workflows/go-cross.yml

@@ -0,0 +1,31 @@
+name: Compilation
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+
+  cross:
+    name: Go
+    runs-on: ${{ matrix.os }}
+    env:
+      CGO_ENABLED: 0
+
+    strategy:
+      matrix:
+        go-version: [ stable, oldstable ]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Test
+        run: go test -v -cover ./...
+
+      - name: Build
+        run: go build -v -ldflags "-s -w" -trimpath

.github/workflows/post-release.yml

@@ -0,0 +1,16 @@
+name: "Post release"
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  check-install-script:
+    name: Installation script (remote)
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - run: curl -sSfL https://raw.githubusercontent.com/golangci/misspell/master/install-misspell.sh | sh -s -- -b "./install-misspell"

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: "Release a tag"
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  release:
+    name: Release Process
+    runs-on: ubuntu-latest
+    env:
+      GO_VERSION: stable
+      CGO_ENABLED: 0
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      # https://goreleaser.com/ci/actions/
+      - name: Run GoReleaser
+        uses: goreleaser/goreleaser-action@v5
+        with:
+          version: latest
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN_REPO }}

.gitignore

@@ -2,6 +2,9 @@ dist/
 bin/
 vendor/
 
+.idea/
+/misspell
+
 # editor turds
 *~
 *.gz

.golangci.yml

@@ -0,0 +1,96 @@
+linters:
+  enable-all: true
+  disable:
+    - exportloopref # deprecated
+    - rowserrcheck # not relevant (SQL)
+    - sqlclosecheck # not relevant (SQL)
+    - cyclop # duplicate of gocyclo
+    - dupl
+    - exhaustive
+    - exhaustruct
+    - forbidigo
+    - gochecknoglobals
+    - gochecknoinits
+    - err113
+    - mnd
+    - lll
+    - nilnil
+    - nlreturn
+    - paralleltest
+    - prealloc
+    - testpackage
+    - tparallel
+    - varnamelen
+    - wrapcheck
+    - wsl
+    - misspell
+    - gosec # FIXME(ldez) must be fixed
+    - errcheck # FIXME(ldez) must be fixed
+    - nonamedreturns # FIXME(ldez) must be fixed
+    - nakedret # FIXME(ldez) must be fixed
+
+linters-settings:
+  govet:
+    enable-all: true
+    disable:
+      - fieldalignment
+  gocyclo:
+    min-complexity: 16
+  goconst:
+    min-len: 3
+    min-occurrences: 3
+  misspell:
+    locale: US
+  funlen:
+    lines: -1
+    statements: 40
+  gofumpt:
+    extra-rules: true
+  depguard:
+    rules:
+      main:
+        deny:
+          - pkg: "github.com/instana/testify"
+            desc: not allowed
+          - pkg: "github.com/pkg/errors"
+            desc: Should be replaced by standard lib errors package
+  godox:
+    keywords:
+      - FIXME
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - style
+      - performance
+    disabled-checks:
+      - sloppyReassign
+      - rangeValCopy
+      - octalLiteral
+      - paramTypeCombine # already handle by gofumpt.extra-rules
+      - exitAfterDefer # FIXME(ldez) must be fixed
+      - ifElseChain # FIXME(ldez) must be fixed
+    settings:
+      hugeParam:
+        sizeThreshold: 100
+  forbidigo:
+    forbid:
+      - '^print(ln)?$'
+      - '^panic$'
+      - '^spew\.Print(f|ln)?$'
+      - '^spew\.Dump$'
+
+issues:
+  exclude-use-default: false
+  max-issues-per-linter: 0
+  max-same-issues: 0
+  exclude:
+    - 'ST1000: at least one file in a package should have a package comment'
+    - 'package-comments: should have a package comment'
+  exclude-rules:
+    - path: .*_test.go
+      linters:
+        - funlen
+        - goconst
+
+run:
+  timeout: 2m

.pre-commit-hooks.yaml

@@ -0,0 +1,8 @@
+- id: misspell
+  name: misspell
+  description: Correct commonly misspelled English words... quickly
+  language: golang
+  entry: misspell
+  args:
+  - -w
+  - -error

Dockerfile

@@ -1,16 +1,13 @@
-FROM golang:1.10.0-alpine
+FROM golang:1.22-alpine
 
 # cache buster
-RUN echo 4 
+RUN echo 4
 
 # git is needed for "go get" below
 RUN apk add --no-cache git make
 
 # these are my standard testing / linting tools
 RUN /bin/true \
-    && go get -u github.com/golang/dep/cmd/dep \
-    && go get -u github.com/alecthomas/gometalinter \
-    && gometalinter --install \
     && rm -rf /go/src /go/pkg
 #
 # * SCOWL word list
@@ -35,3 +32,4 @@ RUN /bin/true \
   && wget -O /scowl-wl/words-US-60.txt ${SOURCE_US} \
   && wget -O /scowl-wl/words-GB-ise-60.txt ${SOURCE_GB_ISE} 
 
+RUN git config --global --add safe.directory "/go/src/github.com/golangci/misspell"

LICENSE

@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-