hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

- Add pre-commit hook script to misc/scripts

Browse Source 
- Refer to it in CONTRIBUTING.md
- Add setup note in docs folder
This commit is contained in:
Mathias Vorreiter Pedersen
2021-01-05 13:38:45 +01:00
parent e87fd86e63
commit 229ab7623e
3 changed files with 33 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/pre-commit-hook-setup.md Normal file
View File

@@ -0,0 +1,13 @@
# CodeQL pre-commit-hook setup
As stated in [CONTRIBUTING](../CONTRIBUTING.md) all CodeQL files must be formatted according to our [CodeQL style guide](ql-style-guide.md). You can use our pre-commit hook to avoid committing incorrectly formatted code. To use it, simply copy the [pre-commit](../misc/scripts/pre-commit) script to `.git/modules/ql/hooks/pre-commit` and make sure that it is executable.
The script will abort a commit that contains incorrectly formatted code in .ql or .qll files and print an error message like:
```
> git commit -m "My commit."
code/ql/cpp/ql/src/Options.qll would change by autoformatting.
code/ql/cpp/ql/src/printAst.ql would change by autoformatting.
```
If you prefer to have the script automatically format the code (and not abort the commit), you can replace the line `codeql query format --check-only` with `codeql query format --in-place` (and `exit $exitVal` with `exit 0`).