Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2024-12-27 14:17:37 +01:00
Code Issues Packages Projects Releases Wiki Activity
d977ed360e
pandemonium_engine/misc/hooks
History
Rémi Verschelde 43de2b9ecc Style: Ensure consistent formatting with clang-format 15
2022-10-08 16:48:59 +02:00
..
canonicalize_filename.sh Added godot with all my currently used engine modules. 2022-03-15 13:29:32 +01:00
pre-commit Add ability to extend the set of Git pre-commit hooks 2022-09-16 22:47:07 +02:00
pre-commit-black Make Git hooks work on worktrees on Windows 2022-09-16 22:46:13 +02:00
pre-commit-clang-format Style: Ensure consistent formatting with clang-format 15 2022-10-08 16:48:59 +02:00
pre-commit-make-rst Added godot with all my currently used engine modules. 2022-03-15 13:29:32 +01:00
README.md Style: Ensure consistent formatting with clang-format 15 2022-10-08 16:48:59 +02:00
winmessage.ps1 Added godot with all my currently used engine modules. 2022-03-15 13:29:32 +01:00

README.md

Git hooks for Pandemonium Engine

This folder contains Git hooks meant to be installed locally by Pandemonium 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

Custom hooks

The pre-commit hook will run any other script in .git/hooks whose filename matches pre-commit-custom-*, after the Godot ones.