chore: add pre-commit

Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>

Author: fzipi

.github/workflows/go.yml

@@ -34,7 +34,7 @@ jobs:
         go-version: '1.23'
 
     - name: Build
-      run: | 
+      run: |
         go run mage.go generate
 
     - name: Test

.github/workflows/python.yml

@@ -60,4 +60,3 @@ jobs:
       - name: "Run unit tests"
         run: |
           uv run pytest -vs
-

.gitignore

@@ -74,4 +74,4 @@ go.work.sum
 
 # Editor/IDE
 .idea/
-.vscode/
+.vscode/

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+---
+ci:
+    autofix_commit_msg: |
+        chore(formatting): auto fixes from pre-commit hooks
+
+        for more information, see https://pre-commit.ci
+    autofix_prs: true
+    skip: []
+    submodules: false
+# Update the rev variable with the release version that you want, from the yamllint repo
+# You can pass your custom .yamllint with args attribute.
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+    - id: check-yaml
+      args: [--allow-multiple-documents]
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+      exclude: '^regex-assembly/'
+      args: [--markdown-linebreak-ext=md]
+- repo: local
+  hooks:
+    - id: run-generate
+      name: run-generate
+      entry: './generate.sh'
+      language: script
+      pass_filenames: false
+      files: '^g4/'

README.md

@@ -23,7 +23,7 @@ tokens {
 }
 
 WS
-   : ([ \t\r\n]+ | '\\' '\n' | '\\')  -> skip 
+   : ([ \t\r\n]+ | '\\' '\n' | '\\')  -> skip
    ;
 
 COMMENT
@@ -117,8 +117,8 @@ RPAREN
 // MODSEC CONFIG
 ACTION_ACCURACY
 	: 'accuracy'
-	; 
-	
+	;
+
 ACTION_ALLOW
 	: 'allow:' ('REQUEST'|'PHASE') | ('phase:' ('REQUEST|PHASE') | 'allow')
 	;
@@ -1256,11 +1256,11 @@ SPACE_COL
 	: ' ' -> skip, pushMode(OPERATOR_START_MODE)
 	;
 
-COMMA_COL 
+COMMA_COL
 	: ',' -> type(COMMA), popMode
 	;
 
-QUOTE_COL 
+QUOTE_COL
 	: '"' -> type(QUOTE), popMode
 	;
 
@@ -1274,11 +1274,11 @@ SPACE_VAR
 	: ' ' -> skip, pushMode(OPERATOR_START_MODE)
 	;
 
-COMMA_VAR 
+COMMA_VAR
 	: ',' -> type(COMMA), popMode
 	;
 
-QUOTE_VAR 
+QUOTE_VAR
 	: '"' -> type(QUOTE), popMode
 	;
 
@@ -1323,10 +1323,10 @@ NOT_OPERATOR
 	;
 
 SKIP_CHARS
-   : [\\\t\r\n ]+  -> skip 
+   : [\\\t\r\n ]+  -> skip
    ;
 
-QUOTE_OP 
+QUOTE_OP
 	: '"' -> type(QUOTE), pushMode(OPERATOR_WITH_QUOTES)
 	;
 
@@ -1347,4 +1347,3 @@ AT
 OPERATOR_QUOTED_STRING
     : (('\\"') | ~([" @!])) (('\\"')|~('"'))* -> pushMode(DEFAULT_MODE)
     ;
-

g4/SecLangLexer.g4

@@ -487,4 +487,4 @@ assignment:
     EQUAL
     | EQUALS_PLUS
     | EQUALS_MINUS
-    ;
+    ;

g4/SecLangParser.g4

@@ -3,4 +3,4 @@
 
 package g4
 
-//go:generate ./generate.sh
+//go:generate ../generate.sh

g4/generate.go

@@ -2,6 +2,16 @@
 # Copyright 2023 Felipe Zipitria
 # SPDX-License-Identifier: Apache-2.0
 
+# This script is used to generate the parser files for the seclang DSL.
+# It is used by the pre-commit hook to ensure that the parser files are up to date.
+
+# Check if java is installed
+if ! command -v java >/dev/null 2>&1; then
+    echo "Java is not installed. Please install Java and try again."
+    exit 1
+fi
+
+cd g4
 
 alias antlr4='java -Xmx500M -cp "../lib/antlr-4.13.2-complete.jar:$CLASSPATH" org.antlr.v4.Tool'
 antlr4 -Dlanguage=Go -no-visitor -package parser -o ../parser *.g4