chore: add Makefile and linters configuration

Author: tzdybal

.golangci.yml

@@ -0,0 +1,49 @@
+run:
+  timeout: 5m
+  modules-download-mode: readonly
+
+linters:
+  enable:
+    - errorlint
+    - errcheck
+    - gofmt
+    - goimports
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - revive
+    - staticcheck
+    - typecheck
+    - unconvert
+    - unused
+
+issues:
+  exclude-use-default: false
+  # mempool and indexer code is borrowed from Tendermint
+  exclude-dirs:
+    - mempool
+    - state/indexer
+    - state/txindex
+    - third_party
+  include:
+    - EXC0012 # EXC0012 revive: Annoying issue about not having a comment. The rare codebase has such comments
+    - EXC0014 # EXC0014 revive: Annoying issue about not having a comment. The rare codebase has such comments
+
+linters-settings:
+  gosec:
+    excludes:
+      - G115
+  revive:
+    rules:
+      - name: package-comments
+        disabled: true
+      - name: duplicated-imports
+        severity: warning
+      - name: exported
+        arguments:
+          - disableStutteringCheck
+
+  goimports:
+    local-prefixes: github.com/rollkit

.markdownlint.yaml

@@ -0,0 +1,6 @@
+default: true
+MD010:
+  code_blocks: false
+MD013: false
+MD024:
+  allow_different_nesting: true

.yamllint.yml

@@ -0,0 +1,9 @@
+---
+# Built from docs https://yamllint.readthedocs.io/en/stable/configuration.html
+extends: default
+
+rules:
+  # 120 chars should be enough, but don't fail if a line is longer
+  line-length:
+    max: 120
+    level: warning

Makefile

@@ -0,0 +1,63 @@
+# Define pkgs, run, and cover vairables for test so that we can override them in
+# the terminal more easily.
+pkgs := $(shell go list ./...)
+run := .
+count := 1
+
+## help: Show this help message
+help: Makefile
+	@echo " Choose a command run in "$(PROJECTNAME)":"
+	@sed -n 's/^##//p' $< | column -t -s ':' |  sed -e 's/^/ /'
+.PHONY: help
+
+## clean: clean testcache
+clean:
+	@echo "--> Clearing testcache"
+	@go clean --testcache
+.PHONY: clean
+
+## cover: generate to code coverage report.
+cover:
+	@echo "--> Generating Code Coverage"
+	@go install github.com/ory/go-acc@latest
+	@go-acc -o coverage.txt $(pkgs)
+.PHONY: cover
+
+## deps: Install dependencies
+deps:
+	@echo "--> Installing dependencies"
+	@go mod download
+#	@make proto-gen
+	@go mod tidy
+.PHONY: deps
+
+## lint: Run linters golangci-lint and markdownlint.
+lint: vet
+	@echo "--> Running golangci-lint"
+	@golangci-lint run
+	@echo "--> Running markdownlint"
+	@markdownlint --config .markdownlint.yaml '**/*.md'
+	@echo "--> Running yamllint"
+	@yamllint --no-warnings . -c .yamllint.yml
+
+.PHONY: lint
+
+## fmt: Run fixes for linters. Currently only markdownlint.
+fmt:
+	@echo "--> Formatting markdownlint"
+	@markdownlint --config .markdownlint.yaml '**/*.md' -f
+	@echo "--> Formatting go"
+	@golangci-lint run --fix
+.PHONY: fmt
+
+## vet: Run go vet
+vet: 
+	@echo "--> Running go vet"
+	@go vet $(pkgs)
+.PHONY: vet
+
+## test: Running unit tests
+test: vet
+	@echo "--> Running unit tests"
+	@go test -v -race -covermode=atomic -coverprofile=coverage.txt $(pkgs) -run $(run) -count=$(count)
+.PHONY: test