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
Files
33cce2b5ac9d6528815e266ad301e740374f54b5
codeql/docs/pre-commit-hook-setup.md
Paolo Tranquilli 33cce2b5ac add pre-commit configuration 
This enables use of the `pre-commit` framework to run quick pre-commit
checks. In particular this allows to automatically fix:
* trailing white spaces
* absence or multiple newlines at the end of files
* QL code formatting
* file sync

More could be added in the future: anything that can be checked fast
can be added in the configuration (for example well-formedness of
`qldoc` files).

This is a purely opt-in feature. Instructions for enabling it and
possibly configuring its behaviour are in `pre-commit-hook-setup.md`.
2022-02-22 17:40:07 +01:00

2.1 KiB
Raw Blame History

CodeQL pre-commit-hook setup

As stated in CONTRIBUTING all CodeQL files must be formatted according to our CodeQL style guide. You can use our pre-commit hook to avoid committing incorrectly formatted code. To use it, simply copy the pre-commit script to .git/hooks/pre-commit and make sure that:

  • The script is executable. On Linux and macOS this can be done using chmod +x.
  • The CodeQL CLI has been added to your PATH.

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."
ql/cpp/ql/src/Options.qll would change by autoformatting.
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).

Using the pre-commit framework

Alternatively, you can use the pre-commit framework. There are some pre-commit hooks already configured on .pre-commit-config.yaml. In order to install them you need to follow pre-commit's installation instructions and then run pre-commit install.

By default, pre-commit will check and fix

  • trailing whitespaces;
  • absence of double newlines at end of files;
  • QL formatting;
  • files out of sync (see config/sync-files.py).

It will run the checks only on files changed by the commit (except for the file sync check) and it will skip all files under test directories unless they are .ql, .qll or .qlref files.

If you want to change one of these default behaviours (for example, you want to skip the out-of-sync file check, or you prefer to pass --check-only instead of --in-place to the query formatter), run

git update-index --assume-unchanged .pre-commit-config.yaml

and you can then modify the configuration at your will.