Merge pull request #10 from Bahjat/patch/adds-go-ruleguard

Patch/adds go ruleguard

Author: Bahjat

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v4.3.0
     hooks:
       - id: trailing-whitespace
       - id: check-yaml
+      - id: check-json
       - id: end-of-file-fixer
-  - repo: git://github.com/detailyang/pre-commit-shell
-    rev: 1.0.5
+  - repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.8.0
     hooks:
-      - id: shell-lint
-        args: [--format=json]
+      - id: shellcheck

.pre-commit-hooks.yaml

@@ -1,55 +1,62 @@
--   id: go-fmt-import
-    name: 'go import/fmt'
-    entry: run-go-fmt-import.sh
-    files: '\.go$'
-    language: 'script'
-    description: "Runs `goimport,gofmt`, requires golang"
-
--   id: go-vet
-    name: 'go vet'
-    entry: run-go-vet.sh
-    files: '\.go$'
-    language: 'script'
-    description: "Runs `go vet`, requires golang"
-
--   id: go-lint
-    name: 'golint'
-    entry: run-go-lint.sh
-    files: '\.go$'
-    language: 'script'
-    description: "Runs `go lint`, requires golang"
-
--   id: go-unit-tests
-    name: 'go unit test'
-    entry: run-go-unit-tests.sh
-    files: '\.go$'
-    language: 'script'
-    description: "Runs `go test`, requires golang"
-
--   id: gofumpt
-    name: 'gofumpt'
-    entry: run-go-gofumpt.sh
-    files: '\.go$'
-    language: 'script'
-    description: "Runs `gofumpt`, requires github.com/mvdan/gofumpt"
-
--   id: go-err-check
-    name: 'go errcheck'
-    entry: run-go-err-check.sh
-    files: '\.go$'
-    language: 'script'
-    description: "Runs `errcheck`, requires github.com/kisielk/errcheck"
-
--   id: go-static-check
-    name: 'go staticcheck'
-    entry: run-go-static-check.sh
-    files: '\.go$'
-    language: 'script'
-    description: "Runs `staticcheck`, install https://staticcheck.io/docs/"
-
--  id: golangci-lint
-   name: 'go golangci-lint'
-   entry: run-golangci-lint.sh
-   files: '\.go$'
-   language: 'script'
-   description: "Runs `golangci-lint`, install https://github.com/golangci/golangci-lint"
+- id: go-fmt-import
+  name: "go import/fmt"
+  entry: run-go-fmt-import.sh
+  files: '\.go$'
+  language: "script"
+  description: "Runs `goimport,gofmt`, requires golang"
+
+- id: go-vet
+  name: "go vet"
+  entry: run-go-vet.sh
+  files: '\.go$'
+  language: "script"
+  description: "Runs `go vet`, requires golang"
+
+- id: go-lint
+  name: "golint"
+  entry: run-go-lint.sh
+  files: '\.go$'
+  language: "script"
+  description: "Runs `go lint`, requires golang"
+
+- id: go-unit-tests
+  name: "go unit test"
+  entry: run-go-unit-tests.sh
+  files: '\.go$'
+  language: "script"
+  description: "Runs `go test`, requires golang"
+
+- id: gofumpt
+  name: "gofumpt"
+  entry: run-go-gofumpt.sh
+  files: '\.go$'
+  language: "script"
+  description: "Runs `gofumpt`, requires github.com/mvdan/gofumpt"
+
+- id: go-err-check
+  name: "go errcheck"
+  entry: run-go-err-check.sh
+  files: '\.go$'
+  language: "script"
+  description: "Runs `errcheck`, requires github.com/kisielk/errcheck"
+
+- id: go-static-check
+  name: "go staticcheck"
+  entry: run-go-static-check.sh
+  files: '\.go$'
+  language: "script"
+  description: "Runs `staticcheck`, install https://staticcheck.io/docs/"
+
+- id: golangci-lint
+  name: "go golangci-lint"
+  entry: run-golangci-lint.sh
+  files: '\.go$'
+  language: "script"
+  description: "Runs `golangci-lint`, install https://github.com/golangci/golangci-lint"
+
+- id: go-ruleguard
+  name: "go-ruleguard"
+  entry: run-go-ruleguard.sh
+  files: '\.go$'
+  language: "script"
+  description: "Runs `go-ruleguard`, install https://github.com/quasilyte/go-ruleguard"

README.md

@@ -23,7 +23,7 @@ Add a file named `.pre-commit-config.yaml` into the root directory of your repos
 ```yaml
 repos:
   - repo: https://github.com/Bahjat/pre-commit-golang
-    rev: v1.0.1
+    rev: v1.0.2
     hooks:
       - id: go-fmt-import
       - id: go-vet
@@ -34,6 +34,8 @@ repos:
       - id: go-static-check # install https://staticcheck.io/docs/
       - id: golangci-lint # requires github.com/golangci/golangci-lint
         args: [--config=.github/linters/.golangci.yml] # optional
+      - id: go-ruleguard # requires
+        args: [--rules=rules/rules.go] # required https://github.com/quasilyte/go-ruleguard
 ```
 
 ## Contributing

run-go-ruleguard.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+RULE_FILE="$1"
+
+if ! command -v ruleguard 2>&1 /dev/null
+then
+    echo "go-ruleguard could not be found"
+    exit
+fi
+
+PASS=true
+
+for FILE in "$@"
+do
+    
+    if ! ruleguard -c 0 -rules "$RULE_FILE" "$FILE"; 
+    then
+        PASS=false
+    fi
+done
+
+if [ "$PASS" = "false" ]; then
+    exit 1
+fi