godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/misc/hooks/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

43 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

clang-format: Add pre-commit hook Derived from https://github.com/githubbrowser/Pre-commit-hooks and https://gitlab.cern.ch/GeantV/geant/blob/master/hooks/pre-commit-clang-format
2017-02-11 23:51:14 +00:00
# Git hooks for Godot Engine
Add a pre-commit hook to check the class reference syntax This also makes documentation helper scripts executable.
2019-12-06 22:35:43 +00:00
This folder contains Git hooks meant to be installed locally by Godot Engine
clang-format: Add pre-commit hook Derived from https://github.com/githubbrowser/Pre-commit-hooks and https://gitlab.cern.ch/GeantV/geant/blob/master/hooks/pre-commit-clang-format
2017-02-11 23:51:14 +00:00
contributors to make sure they comply with our requirements.
## List of hooks
Hooks: Add pre-commit hook for psf/black formatting
2020-03-30 06:55:21 +00:00
- 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.
Rename "makerst.py" to "make_rst.py"
2021-10-24 06:48:03 +00:00
- Pre-commit hook for `make_rst`: Checks the class reference syntax using
`make_rst.py`.
clang-format: Add pre-commit hook Derived from https://github.com/githubbrowser/Pre-commit-hooks and https://gitlab.cern.ch/GeantV/geant/blob/master/hooks/pre-commit-clang-format
2017-02-11 23:51:14 +00:00
## Installation
Hooks: Add pre-commit hook for psf/black formatting
2020-03-30 06:55:21 +00:00
Copy all the files from this folder into your `.git/hooks` folder, and make
sure the hooks and helper scripts are executable.
Corrected capitalisation of macOS In documentation and comments, ignoring thirdparty code
2023-03-12 16:48:52 +00:00
#### Linux/macOS
Pre-commit hook instructions on Windows
2020-03-30 20:59:06 +00:00
Hooks: Add pre-commit hook for psf/black formatting
2020-03-30 06:55:21 +00:00
The hooks rely on bash scripts and tools which should be in the system `PATH`,
Pre-commit hook instructions on Windows
2020-03-30 20:59:06 +00:00
so they should work out of the box on Linux/macOS.
#### Windows
##### clang-format
Fix style issue after #54148
2021-11-16 13:26:42 +00:00
- Download LLVM for Windows (version 13 or later) from
Style: Mark clang-format 16 as supported for pre-commit hook It only introduced a difference in a .glsl file, which I've worked around by removing an empty line. This keeps formatting consistent between clang-format 15 and 16. Also added a change in the 3-to-4 project converter to fix bogus formatting in clang-format < 17. (cherry picked from commit 49f4860ce3e4122e17c869229701f7d86aa6956c)
2023-12-06 12:12:18 +00:00
<https://github.com/llvm/llvm-project/releases>
Pre-commit hook instructions on Windows
2020-03-30 20:59:06 +00:00
- Make sure LLVM is added to the `PATH` during installation
##### black
- Python installation: make sure Python is added to the `PATH`
- Install `black` - in any console: `pip3 install black`
Add ability to extend the set of Git pre-commit hooks
2022-08-30 10:18:58 +00:00
## Custom hooks
The pre-commit hook will run any other script in `.git/hooks` whose filename
matches `pre-commit-custom-*`, after the Godot ones.