Feat/lint

.github/workflows/ci.yml

@@ -1,11 +1,60 @@
-name: deploy
+name: Lint & Test
+
 on:
   push:
+    branches: [ master ]
   pull_request:
-    branches:
-      - master
+    branches: [ master ]
+
 jobs:
-  build:
+
+  lint:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v2
+      - name: Create cache directories
+        run: |
+          mkdir -p ~/.cache/golangci-lint
+          mkdir -p ~/.cache/go-build
+
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+
+      - name: Go Lint Cache
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/golangci-lint/
+          key: go-lint-cache-${{ runner.os }}-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            go-lint-cache-${{ runner.os }}-
+
+      - name: Go Mod Cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cache/go-build
+          key: go-mod-cache-${{ runner.os }}-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            go-mod-cache-${{ runner.os }}-
+
+      - name: Debug Cache Path
+        run: |
+          ls -la ~/.cache/golangci-lint/ || echo "golangci cache path does not exist"
+          ls -la ~/.cache/go-build || echo "go-build cache path does not exist"
+
+      - name: Check go mod
+        run: |
+          go env
+          go mod tidy
+          git diff --exit-code go.mod
+          git diff --exit-code go.sum
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v8
+        with:
+          args: --timeout=10m --verbose
+          skip-cache: false
+        env:
+          GOLANGCI_LINT_CACHE: go-lint-cache-${{ runner.os }}-${{ hashFiles('**/go.sum') }}

.golangci.yaml

@@ -0,0 +1,53 @@
+version: "2"
+issues:
+  fix: true
+linters:
+  default: none
+  enable:
+    - govet
+  exclusions:
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - internal/example
+      - cmds
+      - vendor
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - goimports
+    - gofmt
+    - gofumpt
+  settings:
+    gofumpt:
+      extra-rules: true
+    goimports:
+      # A list of prefixes, which, if set, checks import paths
+      # with the given prefixes are grouped after 3rd-party packages.
+      # Default: []
+      local-prefixes:
+        - github.com/pubgo/opendoc
+    gofmt:
+      # Simplify code: gofmt with `-s` option.
+      # Default: true
+      simplify: false
+      # Apply the rewrite rules to the source before reformatting.
+      # https://pkg.go.dev/cmd/gofmt
+      # Default: []
+      rewrite-rules:
+        - pattern: 'interface{}'
+          replacement: 'any'
+        - pattern: 'a[b:len(a)]'
+          replacement: 'a[b:]'
+
+  exclusions:
+    paths:
+      - internal/example
+      - vendor
+      - examples$
+      - proto

.version/VERSION

@@ -0,0 +1 @@
+v0.1.2

Makefile

@@ -6,3 +6,9 @@ run-example:
 
 goimports:
 	goimports -w -local github.com/pubgo/opendoc .
+
+refactor:
+	gofumpt -l -w -extra .
+
+lint:
+	golangci-lint run --timeout=10m --verbose