Merge pull request #5 from mgrzybek/tools

[tools] add gitignore, pre-commit and makefile

Author: fcomte

.gitignore

@@ -0,0 +1,3 @@
+*.exe
+main
+onyxiactl

.pre-commit-config.yaml

@@ -0,0 +1,74 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.0.1
+  hooks:
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v1.5.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, '2']
+
+- repo: https://github.com/tekwizely/pre-commit-golang
+  rev: v0.8.3
+  hooks:
+    #
+    # Go Build
+    #
+    #-   id: go-build-mod
+    #-   id: go-build-pkg
+    #-   id: go-build-repo-mod
+    #-   id: go-build-repo-pkg
+    #
+    # Go Test
+    #
+  - id: go-test-mod
+    #-   id: go-test-pkg
+  - id: go-test-repo-mod
+    #-   id: go-test-repo-pkg
+    #
+    # Go Vet
+    #
+    #-   id: go-vet
+  - id: go-vet-mod
+    #-   id: go-vet-pkg
+  - id: go-vet-repo-mod
+    #-   id: go-vet-repo-pkg
+    #
+    # Revive
+    #
+    #-   id: go-revive
+    #-   id: go-revive-mod
+    #-   id: go-revive-repo-mod
+    #
+    # GoSec
+    #
+    #-   id: go-sec-mod
+    #-   id: go-sec-pkg
+    #-   id: go-sec-repo-mod
+    #-   id: go-sec-repo-pkg
+    #
+    # Formatters
+    #
+  - id: go-fmt
+    #-   id: go-imports # Replaces go-fmt
+    #-   id: go-returns # Replaces go-imports & go-fmt
+    #
+    # Style Checkers
+    #
+  - id: go-lint
+    #-   id: go-critic
+    #
+    # GolangCI-Lint
+    # - Fast Multi-Linter
+    # - Can be configured to replace MOST other hooks
+    # - Supports repo config file for configuration
+    # - https://github.com/golangci/golangci-lint
+    #
+    #-   id: golangci-lint
+    #-   id: golangci-lint-mod
+    #-   id: golangci-lint-pkg
+    #-   id: golangci-lint-repo-mod
+    #-   id: golangci-lint-repo-pkg

Makefile

@@ -0,0 +1,32 @@
+.PHONY: help # This help message
+help:
+	@grep '^.PHONY: .* #' Makefile \
+	| sed 's/\.PHONY: \(.*\) # \(.*\)/\1\t\2/' \
+	| expand -t20 \
+	| sort
+
+.PHONY: dev-prepare # Install go tools and pre-commit hooks
+dev-prepare:
+	go get github.com/securego/gosec/v2/cmd/gosec
+	go get github.com/mgechev/revive
+	go get golang.org/x/lint/golint
+	#go get github.com/go-critic/go-critic/cmd/gocritic
+	#go get github.com/akrennmair/go-imports
+	#go get github.com/golangci/golangci-lint/cmd/golangci-lint
+
+	pre-commit install
+
+.PHONY: pre-commit # Run pre-commit compliance tests
+pre-commit:
+	pre-commit run --all-files
+
+.PHONY: test # Run go test
+test:
+	go test
+
+onyxiactl: test
+	go build -o onyxyactl main.go
+
+.PHONY: all # lint, test and build
+all: onyxiactl
+	@echo