godot/misc/hooks
Hugo Locurcio d45351f413
makerst: Print colored output for easier visual grepping
This is automatically enabled on all platforms including
Windows 10 and later, whenever a TTY environment is detected.

In non-TTY environments such as CI, this can be forced using the
`--color` command line argument.
2022-06-11 00:19:36 +02:00
..
README.md Fix style issue after #54148 2021-11-16 14:27:44 +01:00
canonicalize_filename.sh Replace HTTP links with HTTPS for sites with HTTPS versions 2021-08-22 20:13:11 -05:00
pre-commit Rename "makerst.py" to "make_rst.py" 2021-10-24 01:58:59 -05:00
pre-commit-black Fix typos with codespell 2022-02-10 12:30:19 +01:00
pre-commit-clang-format Relax version warning in clang-format precommit hook 2022-05-05 13:39:28 +02:00
pre-commit-make-rst makerst: Print colored output for easier visual grepping 2022-06-11 00:19:36 +02:00
winmessage.ps1 Cleanup: Remove executable bit from files which don't need it 2021-01-19 23:36:42 +01:00

README.md

Git hooks for 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

  • Pre-commit hook for clang-format: Applies clang-format to the staged files before accepting a commit; blocks the commit and generates a patch if the style is not respected. You may need to edit the file if your clang-format binary is not in the PATH, or if you want to enable colored output with pygmentize.
  • Pre-commit hook for black: Applies black to the staged Python files before accepting a commit.
  • Pre-commit hook for make_rst: Checks the class reference syntax using make_rst.py.

Installation

Copy all the files from this folder into your .git/hooks folder, and make sure the hooks and helper scripts are executable.

Linux/MacOS

The hooks rely on bash scripts and tools which should be in the system PATH, so they should work out of the box on Linux/macOS.

Windows

clang-format
black
  • Python installation: make sure Python is added to the PATH
  • Install black - in any console: pip3 install black