mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-04-01 00:41:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
godot/misc/hooks
History
Hugo Locurcio 3a3e796485
Check for clang-format version in the pre-commit hook 
Different clang-format versions may result in different formatting.
Therefore, it's recommended to use the same version as used in CI.

(cherry picked from commit 3333b58a7f115aeb4a7917138bafc6974fa1559b)
2021-01-26 17:00:17 +01:00
..
canonicalize_filename.sh
clang-format: Add pre-commit hook
2017-02-12 00:51:31 +01:00
pre-commit
Hooks: Add pre-commit hook for psf/black formatting
2020-06-10 15:30:52 +02:00
pre-commit-black
Git Hooks: Suppress "which" error messages.
2020-06-10 15:33:27 +02:00
pre-commit-clang-format
Check for clang-format version in the pre-commit hook
2021-01-26 17:00:17 +01:00
pre-commit-makerst
Fixed errors in makerst pre-commit hook
2020-04-06 18:16:11 +02:00
README.md
Pre-commit hook instructions on Windows
2020-06-10 15:32:18 +02:00
winmessage.ps1
Cleanup: Remove executable bit from files which don't need it
2021-01-26 17:00:15 +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 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