repo: setup golangci lint (#52)

shoenig · web-flow · commit c7978a544345 · 2023-04-05T23:49:28.000-05:00
* repo: setup golangci lint

* repo: fixup linter warnings
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,6 +1,17 @@
-name: run-ci
+name: Run CI Tests
 on: [push]
 jobs:
+  run-lint:  
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: hashicorp/setup-golang@v1
+        with:
+          version-file: go.mod
+      - uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.52.2
+          skip-cache: true
   run-tests:
     strategy:
       fail-fast: false
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -0,0 +1,11 @@
+run:
+  timeout: 5m
+linters:
+  enable:
+   - gofmt
+   - errcheck
+   - errname
+   - errorlint
+   - durationcheck
+   - whitespace
+
diff --git a/internal/netapi/client.go b/internal/netapi/client.go
@@ -1,7 +1,6 @@
 package netapi
 
 import (
-	"fmt"
 	"net/http"
 	"time"
 
@@ -20,5 +19,5 @@ var (
 	httpClient = &http.Client{Timeout: 10 * time.Second}
 
 	// the user-agent to use for all http requests
-	userAgent = fmt.Sprintf("ssh-key-sync bot/v2 (https://github.com/shoenig/ssh-key-sync)")
+	userAgent = "ssh-key-sync bot/v2 (https://github.com/shoenig/ssh-key-sync)"
 )
diff --git a/internal/ssh/keys_test.go b/internal/ssh/keys_test.go
@@ -41,7 +41,6 @@ func Test_Key_String_empty(t *testing.T) {
 }
 
 func Test_sortByMetadata(t *testing.T) {
-
 	keys := []Key{
 		key(true, "ned", "h5", "xcvwe"),
 		key(false, "xavior", "h4", "lkdsf"),
diff --git a/internal/ssh/reader_test.go b/internal/ssh/reader_test.go
@@ -10,7 +10,7 @@ func compareToFile(t *testing.T, filename string, expected []Key) {
 	reader := NewKeysReader()
 	keys, err := reader.ReadKeys(filename)
 	must.NoError(t, err)
-	must.SliceContainsAll(t, expected, keys.List())
+	must.SliceContainsAll(t, expected, keys.Slice())
 }
 
 func Test_read_1(t *testing.T) {
diff --git a/main.go b/main.go
@@ -12,4 +12,4 @@ func main() {
 		fmt.Println("[fatal]", err)
 		os.Exit(1)
 	}
- }
+}

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,6 @@ func Test_Key_String_empty(t *testing.T) {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`func Test_sortByMetadata(t *testing.T) {`
`44`		`-`
`45`	`44`	`keys := []Key{`
`46`	`45`	`key(true, "ned", "h5", "xcvwe"),`
`47`	`46`	`key(false, "xavior", "h4", "lkdsf"),`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ func compareToFile(t *testing.T, filename string, expected []Key) {`
`10`	`10`	`reader := NewKeysReader()`
`11`	`11`	`keys, err := reader.ReadKeys(filename)`
`12`	`12`	`must.NoError(t, err)`
`13`		`- must.SliceContainsAll(t, expected, keys.List())`
	`13`	`+ must.SliceContainsAll(t, expected, keys.Slice())`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`func Test_read_1(t *testing.T) {`
Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,4 @@ func main() {`
`12`	`12`	`fmt.Println("[fatal]", err)`
`13`	`13`	`os.Exit(1)`
`14`	`14`	`}`
`15`		`- }`
	`15`	`+}`