godot/misc/hooks
Rémi Verschelde dfed5efea3
Merge pull request #37445 from nekomatata/hook-makerst-fix
Fixed errors in makerst pre-commit hook
2020-03-31 00:17:51 +02:00
..
canonicalize_filename.sh
pre-commit Hooks: Add pre-commit hook for psf/black formatting 2020-03-30 09:05:59 +02:00
pre-commit-black Hooks: Use pygmentize if available to visualize diff 2020-03-30 09:05:59 +02:00
pre-commit-clang-format Hooks: Use pygmentize if available to visualize diff 2020-03-30 09:05:59 +02:00
pre-commit-makerst Fixed errors in makerst pre-commit hook 2020-03-31 00:02:11 +02:00
README.md Pre-commit hook instructions on Windows 2020-03-30 22:59:06 +02:00

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 makerst: Checks the class reference syntax using makerst.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