Go lang linter (#53)

* Add GO lang linter to GH workflow and pre-commit hook * fix .golangci.yaml * go lang ci lint workflow * remove comments from golang-ci.yml
lablabs · Nov 30, 2021 · aef471c · aef471c
1 parent b706560
commit aef471c
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 0 deletions.
diff --git a/.github/workflows/golangci-lint.yml b/.github/workflows/golangci-lint.yml
@@ -0,0 +1,17 @@
+name: golangci-lint
+on:
+  push:
+  pull_request:
+permissions:
+  contents: read
+
+jobs:
+  golangci:
+    name: GO lang CI linter
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2 # https://github.com/marketplace/actions/run-golangci-lint
+        with:
+          version: v1.43
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -0,0 +1,11 @@
+linters:
+  enable:
+    - megacheck
+    - gofmt
+    - govet
+    - revive # replacement for golint
+
+linters-settings:
+  gofmt:
+    # simplify code: gofmt with `-s` option, true by default
+    simplify: true
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/golangci/golangci-lint
+    rev: v1.43.0
+    hooks:
+      - id: golangci-lint
diff --git a/README.md b/README.md
@@ -137,6 +137,17 @@ docker run --rm -p 8080:8080 -i ghcr.io/lablabs/cloudflare_exporter --help
 ## Contributing and reporting issues
 Feel free to create an issue in this repository if you have questions, suggestions or feature requests.
 
+### Validation, linters and pull-requests
+
+We want to provide high quality code and modules. For this reason we are using
+several [pre-commit hooks](.pre-commit-config.yaml) and
+[GitHub Actions workflow](.github/workflows/golangci-lint.yml). A pull-request to the
+master branch will trigger these validations and lints automatically. Please
+check your code before you will create pull-requests. See
+[pre-commit documentation](https://pre-commit.com/) and
+[GitHub Actions documentation](https://docs.github.com/en/actions) for further
+details.
+
 ## License
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)