linters

.github/workflows/deps.yml

@@ -0,0 +1,21 @@
+# https://github.com/actions/go-dependency-submission
+name: dependency-submission
+on:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: write
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version: "1.18"
+      - uses: actions/go-dependency-submission@v1
+        with:
+          go-mod-path: go.mod

.github/workflows/main.yml

@@ -0,0 +1,49 @@
+name: main
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        go-version:
+          - "1.18"
+          - "1.19"
+          - "1.20"
+          - "1.21"
+    steps:
+      - uses: actions/setup-go@v3
+        with:
+          go-version: ${{ matrix.go-version }}
+      - uses: actions/checkout@v3
+      - run: go test -v ./...
+
+  golangci-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.18
+      - uses: actions/checkout@v3
+      - uses: golangci/golangci-lint-action@v3
+
+  markdownlint-cli:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: nosborn/[email protected]
+        with:
+          files: .
+          config_file: .markdownlint.yaml
+          dot: true

.golangci.yaml

@@ -0,0 +1,21 @@
+linters:
+  disable:
+    - dupword
+    - depguard
+    - godot
+    - godox
+    - errorlint
+  presets:
+    - bugs
+    - comment
+    - complexity
+    # - error
+    - format
+    - import
+    # - metalinter
+    # - module
+    - performance
+    # - sql
+    # - style
+    # - test
+    - unused

.markdownlint.yaml

@@ -0,0 +1,18 @@
+# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+default: true   # enable all by default
+MD007:          # unordered list indentation
+  indent: 2
+MD013: false    # do not validate line length
+MD014: false    # allow $ before command output
+MD029:          # ordered list prefix, use all ones
+  style: "one"
+MD033:          # allow html tags
+  allowed_elements:
+    - b
+    - div
+    - h1
+    - img
+    - p
+    - picture
+    - source
+MD041: false    # the first line in readme is not a MD header

arguard/config.go

@@ -16,7 +16,7 @@ func (c *Config) flagSet() *flag.FlagSet {
 	fs := flag.NewFlagSet("contracts", flag.ExitOnError)
 	fs.BoolVar(
 		&c.ReportErrors, "report-errors", c.ReportErrors,
-		"show errors occuring during contract execution",
+		"show errors occurring during contract execution",
 	)
 	return fs
 }