Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-23 12:43:43 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
63544c3a9d
godot/misc/hooks
History
Rémi Verschelde 63544c3a9d
clang-format: Sync config with LLVM 13 
Disable minimum amount of spaces in comment prefix for now, as it otherwise
modifies the whole codebase. That's something we probably want to use as it
matches our convention, but we should look into fully converting these
comments to our style guide at the same time.
2021-10-22 21:51:02 +02:00
..
canonicalize_filename.sh Replace HTTP links with HTTPS for sites with HTTPS versions 2021-08-22 20:13:11 -05:00
pre-commit Hooks: Add pre-commit hook for psf/black formatting 2020-03-30 09:05:59 +02:00
pre-commit-black Git Hooks: Suppress "which" error messages. 2020-04-24 20:11:53 +03:00
pre-commit-clang-format clang-format: Sync config with LLVM 13 2021-10-22 21:51:02 +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
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 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