Add a pre-commit hook to check the class reference syntax

This also makes documentation helper scripts executable.
This commit is contained in:
Hugo Locurcio 2019-12-06 23:35:43 +01:00
parent 111ba06310
commit 17add2dc86
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
5 changed files with 11 additions and 4 deletions

0
doc/tools/doc_merge.py Normal file → Executable file
View file

0
doc/tools/doc_status.py Normal file → Executable file
View file

View file

@ -1,6 +1,6 @@
# Git hooks for Godot Engine
This folder contains git hooks meant to be installed locally by Godot Engine
This folder contains Git hooks meant to be installed locally by Godot Engine
contributors to make sure they comply with our requirements.
## List of hooks
@ -9,10 +9,12 @@ contributors to make sure they comply with our requirements.
before accepting a commit; blocks the commit and generates a patch if the
style is not respected.
Should work on Linux and macOS. You may need to edit the file if your
clang-format binary is not in the $PATH, or if you want to enable colored
clang-format binary is not in the `$PATH`, or if you want to enable colored
output with pygmentize.
- Pre-commit hook for makerst: Checks the class reference syntax using `makerst.py`.
Should work on Linux and macOS.
## Installation
Copy all the files from this folder into your .git/hooks folder, and make sure
Copy all the files from this folder into your `.git/hooks` folder, and make sure
the hooks and helper scripts are executable.

View file

@ -14,7 +14,7 @@
# as this script. Hooks should return 0 if successful and nonzero to cancel the
# commit. They are executed in the order in which they are listed.
#HOOKS="pre-commit-compile pre-commit-uncrustify"
HOOKS="pre-commit-clang-format"
HOOKS="pre-commit-clang-format pre-commit-makerst"
###########################################################
# There should be no need to change anything below this line.

5
misc/hooks/pre-commit-makerst Executable file
View file

@ -0,0 +1,5 @@
#!/usr/bin/env bash
# Git pre-commit hook that checks the class reference syntax using makerst.py.
doc/tools/makerst.py doc/classes modules --dry-run