From 17add2dc86b7c52c93aac162242bd98c9bf2eed2 Mon Sep 17 00:00:00 2001
From: Hugo Locurcio <hugo.locurcio@hugo.pro>
Date: Fri, 6 Dec 2019 23:35:43 +0100
Subject: [PATCH] Add a pre-commit hook to check the class reference syntax

This also makes documentation helper scripts executable.
---
 doc/tools/doc_merge.py        | 0
 doc/tools/doc_status.py       | 0
 misc/hooks/README.md          | 8 +++++---
 misc/hooks/pre-commit         | 2 +-
 misc/hooks/pre-commit-makerst | 5 +++++
 5 files changed, 11 insertions(+), 4 deletions(-)
 mode change 100644 => 100755 doc/tools/doc_merge.py
 mode change 100644 => 100755 doc/tools/doc_status.py
 create mode 100755 misc/hooks/pre-commit-makerst

diff --git a/doc/tools/doc_merge.py b/doc/tools/doc_merge.py
old mode 100644
new mode 100755
diff --git a/doc/tools/doc_status.py b/doc/tools/doc_status.py
old mode 100644
new mode 100755
diff --git a/misc/hooks/README.md b/misc/hooks/README.md
index 6ec90fcc544..b18ba7df38b 100644
--- a/misc/hooks/README.md
+++ b/misc/hooks/README.md
@@ -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.
diff --git a/misc/hooks/pre-commit b/misc/hooks/pre-commit
index fc50ed70e7d..36e9935785a 100755
--- a/misc/hooks/pre-commit
+++ b/misc/hooks/pre-commit
@@ -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.
 
diff --git a/misc/hooks/pre-commit-makerst b/misc/hooks/pre-commit-makerst
new file mode 100755
index 00000000000..d9b684e73b8
--- /dev/null
+++ b/misc/hooks/pre-commit-makerst
@@ -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