Add linting + CI

.github/workflows/checks.yml

@@ -0,0 +1,42 @@
+name: Checks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  checks:
+    name: Lint and Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ^1.21
+        id: go
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Install gofumpt
+        run: go install mvdan.cc/[email protected]
+
+      - name: Install staticcheck
+        run: go install honnef.co/go/tools/cmd/[email protected]
+
+      - name: Install golangci-lint
+        run: go install github.com/golangci/golangci-lint/cmd/[email protected]
+
+      - name: Run tests
+        run: make test
+
+      - name: Lint
+        run: make lint
+
+      - name: Ensure go mod tidy runs without changes
+        run: |
+          go mod tidy
+          git update-index -q --really-refresh
+          git diff-index HEAD

.golangci.yaml

@@ -0,0 +1,98 @@
+linters:
+  enable-all: true
+  disable:
+    - cyclop
+    - forbidigo
+    - funlen
+    - gochecknoglobals
+    - gochecknoinits
+    - gocritic
+    - godot
+    - godox
+    - gomnd
+    - lll
+    - nestif
+    - nilnil
+    - nlreturn
+    - noctx
+    - nonamedreturns
+    - nosnakecase
+    - paralleltest
+    - revive
+    - testpackage
+    - unparam
+    - varnamelen
+    - wrapcheck
+    - wsl
+    - deadcode
+    - varcheck
+    - exhaustruct
+    - depguard
+    - gomoddirectives
+    - goerr113
+
+    #
+    # Disabled because of generics:
+    #
+    - contextcheck
+    - rowserrcheck
+    - sqlclosecheck
+    - structcheck
+    - wastedassign
+
+    #
+    # Disabled because deprecated:
+    #
+    - exhaustivestruct
+    - golint
+    - ifshort
+    - interfacer
+    - maligned
+    - scopelint
+
+linters-settings:
+  #
+  # The G108 rule throws a false positive. We're not actually vulnerable. If
+  # you're not careful the profiling endpoint is automatically exposed on
+  # /debug/pprof if you import net/http/pprof. See this link:
+  #
+  #   https://mmcloughlin.com/posts/your-pprof-is-showing
+  #
+  gosec:
+    excludes:
+      - G108
+
+  tagliatelle:
+    case:
+      rules:
+        json: snake
+
+  gofumpt:
+    extra-rules: true
+
+  exhaustruct:
+    exclude:
+      #
+      # Because it's easier to read without the other fields.
+      #
+      - 'GetPayloadsFilters'
+
+      #
+      # Structures outside our control that have a ton of settings. It doesn't
+      # make sense to specify all of the fields.
+      #
+      - 'cobra.Command'
+      - 'database.*Entry'
+      - 'http.Server'
+      - 'logrus.*Formatter'
+      - 'Options' # redis
+
+      #
+      # Excluded because there are private fields (not capitalized) that are
+      # not initialized. If possible, I think these should be altered.
+      #
+      - 'Datastore'
+      - 'Housekeeper'
+      - 'MockBeaconClient'
+      - 'RelayAPI'
+      - 'Webserver'

Makefile

@@ -0,0 +1,27 @@
+VERSION := $(shell git describe --tags --always --dirty="-dev")
+
+.PHONY: clean
+clean:
+	rm -rf out/
+
+.PHONY: test
+test:
+	go test ./framework/...
+
+.PHONY: lint
+lint:
+	gofmt -d -s examples/ framework/
+	gofumpt -d -extra examples/ framework/
+	go vet ./examples/... ./framework/...
+	staticcheck ./examples/... ./framework/...
+	golangci-lint run
+
+.PHONY: fmt
+fmt:
+	gofmt -s -w examples/ framework/
+	gofumpt -extra -w examples/ framework/
+	gci write examples/ framework/
+	go mod tidy
+
+.PHONY: lt
+lt: lint test

framework/framework.go

@@ -124,7 +124,7 @@ func ensureTransactionSuccess(txn *sdk.TransactionResult) (*types.Receipt, error
 
 // DeployAndTransact is a helper function that deploys a suapp
 // and inmediately executes a function on it with a confidential request.
-func DeployAndTransact(path string, funcName string) {
+func DeployAndTransact(path, funcName string) {
 	contract, err := DeployContract(path)
 	if err != nil {
 		fmt.Printf("failed to deploy contract: %v", err)