4180bf53f7
Using "make_pretty.sh -j 1 -t 2" is often more likely to work than increasing the (hardwired) timeout value |
||
|---|---|---|
| .. | ||
| fprettify | ||
| prettify_cp2k | ||
| check_file_properties.py | ||
| clang_format_wrapper.sh | ||
| cloudbuild.yaml | ||
| deploy.sh | ||
| Dockerfile | ||
| format_fortran.py | ||
| format_fortran_test.py | ||
| format_input_file.py | ||
| format_makefile.py | ||
| fortitude.toml | ||
| install_requirements.sh | ||
| precommit.py | ||
| precommit_server.py | ||
| README.md | ||
| requirements.txt | ||
| start_local_server.sh | ||
CP2K Precommit
The precommit system consists of the following tools that analyze and format the source code:
- doxify to add Doxygen templates.
- prettify to format Fortran files.
- analyze_src to check copyright banners and a few other things.
- ast.parse to check Python syntax.
- clang-format to format C, Cuda, and OpenCL files.
- black to format Python scripts.
- shfmt to format Shell scripts.
- shellcheck to analyze Shell scripts.
- mdformat with gfm plugin to format Markdown scripts.
- cmake-format to format CMake scripts.
In contrast to the CP2K-CI these tools process each file individually, which makes them much more lightweight.
Install Git Hook
The precommit.py script can be readily installed as a git hook:
ln -fs ../../tools/precommit/precommit.py .git/hooks/pre-commit
Server
Many of the tools listed above require more than just Python. To avoid their tedious installation a remote server is used by default. It is hosted at https://precommit.cp2k.org via Cloud Run.
The same server can also be started locally when Docker is available:
./start_local_server.sh
The server can also be installed without Docker by following the steps in the Dockerfile.
Once the server is up and running it can be used like this:
$ export CP2K_PRECOMMIT_SERVER="http://127.0.0.1:8080"
$ ./precommit.py
Running precommit checks using 8 workers and server: http://127.0.0.1:8080
Searching for files...
Backups and Cache
Before precommit runs an external tool on a file it create a backup copy in obj/precommit. If the
tool leaves the file unmodified then the backup copy is remove afterwards. If the tool modifies the
file and precommit was invoked without --allow-modifications then the backup copy is used to
restore the file's original content.
After a successful tool run the file's timestamp is recorded in obj/precommit/cache.json and
precommit will skip it in future unless it's invoked with --no-cache.