fmt: introduce golangci-lint and go vet using build tag

Author: gen2thomas

.github/workflows/golangci-lint.yml

@@ -0,0 +1,34 @@
+name: golangci-lint
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - dev
+  pull_request:
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: "Lint"
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-go@v6
+        with:
+          go-version: '1.22'
+          cache: false
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v8
+        with:
+          version: v2.5.0
+          args: --build-tags=lint
+
+          # Optional: show only new issues if it's a pull request. The default value is `false`.
+          # only-new-issues: true
+
+          # Optional: if set to true then the all caching functionality will be complete disabled,
+          #           takes precedence over all other caching options.
+          # skip-cache: true

.golangci.yml

@@ -1,4 +1,3 @@
-
 clean:
 	@rm -rf build
 
@@ -26,3 +25,29 @@ unit-test:
 	@go test -v $(addprefix ./,$(TESTS))
 
 test: clean fmt-check unit-test smoke-test
+
+fmt_quick_check:
+	@# a very fast check before build, but depends on accessibility of all imports
+	@# switch off the "stdmethods" analyzer is needed due to finding:
+	@# at24cx/at24cx.go:57:18: method WriteByte(eepromAddress uint16, value uint8) error should have signature WriteByte(byte) error
+	@# at24cx/at24cx.go:67:18: method ReadByte(eepromAddress uint16) (uint8, error) should have signature ReadByte() (byte, error)
+	@# switch off the "shift" analyzer is needed due to finding:
+	@#tmc5160/registers.go:1939:16: m.CUR_A (16 bits) too small for shift of 16
+	@#tmc5160/registers.go:1996:16: m.X3 (8 bits) too small for shift of 27
+	@#tmc5160/registers.go:1996:27: m.X2 (8 bits) too small for shift of 24
+	@#tmc5160/registers.go:1996:38: m.X1 (8 bits) too small for shift of 21
+	@#tmc5160/registers.go:1996:49: m.W3 (8 bits) too small for shift of 18
+	@#tmc5160/registers.go:1996:60: m.W2 (8 bits) too small for shift of 16
+	@#tmc5160/registers.go:1996:71: m.W1 (8 bits) too small for shift of 14
+	@#tmc5160/registers.go:1996:82: m.W0 (8 bits) too small for shift of 12
+	go vet -tags lint -stdmethods=false -shift=false ./...
+
+fmt_check:
+	@# a complete format check, but depends on accessibility of all imports
+	golangci-lint -v run --build-tags=lint
+
+fmt_fix:
+	@# an automatic reformat and complete format check, but depends on accessibility of all imports
+	@#TODO: activate when ready 
+	@#gofumpt -l -w ./...
+	golangci-lint -v run --build-tags=lint --fix

Makefile

@@ -12,6 +12,7 @@ import (
 	"os"
 	"testing"
 	"time"
+
 	"tinygo.org/x/drivers"
 	"tinygo.org/x/tinyfont"
 	"tinygo.org/x/tinyfont/freemono"

adafruit4650/device_test.go

@@ -1,6 +1,9 @@
+//go:build !lint
+
 // Package apa102 implements a driver for the APA102 SPI LED.
 //
 // Datasheet: https://cdn-shop.adafruit.com/product-files/2343/APA102C.pdf
+//
 package apa102 // import "tinygo.org/x/drivers/apa102"
 
 import (

apa102/apa102.go

@@ -1,3 +1,5 @@
+//go:build !lint
+
 package apa102
 
 import "machine"

apa102/softspi.go

@@ -1,3 +1,5 @@
+//go:build !lint
+
 package bmi160
 
 import (

bmi160/bmi160.go

@@ -1,4 +1,7 @@
+//go:build !lint
+
 // Package buzzer provides a very simplistic driver for a connected buzzer or low-fidelity speaker.
+//
 package buzzer // import "tinygo.org/x/drivers/buzzer"
 
 import (

buzzer/buzzer.go

@@ -19,7 +19,7 @@ func main() {
 
 func run(args []string) error {
 	if len(args) < 2 {
-		return fmt.Errorf("usage: %s FILE")
+		return fmt.Errorf("usage: %s FILE", args[0])
 	}
 
 	b, err := ioutil.ReadFile(args[1])

cmd/convert2bin/convert2bin.go

@@ -1,3 +1,5 @@
+//go:build !lint
+
 // Package comboat implements WiFi driver for the Aithinker-Combo-AT WiFi
 // device found on the Elecrow W5 rp2040 and rp2350 devices.  Ths WiFi device
 // is a RTL8720d variant.  The driver interface is via AT command set over UART