https://github.com/precice/precice-pre-commit-hooks
preCICE specific hooks to use with pre-commit
https://github.com/precice/precice-pre-commit-hooks
Last synced: over 1 year ago
JSON representation
preCICE specific hooks to use with pre-commit
- Host: GitHub
- URL: https://github.com/precice/precice-pre-commit-hooks
- Owner: precice
- Created: 2022-07-06T12:14:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-21T12:26:27.000Z (over 2 years ago)
- Last Synced: 2024-03-26T07:17:10.074Z (about 2 years ago)
- Language: Python
- Size: 9.77 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pre-commit hooks for preCICE
This repo contains [pre-commit](https://github.com/pre-commit/pre-commit) hooks for [preCICE](https://github.com/precice/precice).
## Versioning of this repo
Hooks cover a major version of preCICE.
The version is `vX.Y`, where `X` is the major version of preCICE and `Y` is the release of the hook.
Thus, if you plan to use these hooks with preCICE version `2.3.1`, then only the `2` is important for the hook version.
## Using the hooks
Add this to your `.pre-commit-config.yaml` in the root of your project:
```yaml
- repo: https://github.com/precice/precice-pre-commit-hooks
rev: '' # Use the tag you want to use
hooks:
- id: format-precice-config
exclude: '^thridparty' # optionally exclude directories here
- id: check-image-prefix
files: 'docs/images/.*'
args: [ --prefix=docs-myspecialcomponent- ]
```
**Note:**
The hook will treat every `.xml` file as a preCICE configuration file.
You may need to exclude directories using `exclude`.
## Hooks
### format-precice-config
Formats given preCICE configuration files.
Returns 0 on success, 1 on error, and 2 if a file was modified.
### check-image-prefix
This hook is only relevant for repositories integrated into [the website](https://github.com/precice/precice.github.io)
Checks if given images have the requested prefix.
Only takes images into account that are inside a folder called `images/`.
Pass the prefix to the hook by defining `args: [ --prefix=my-prefix- ]`.
Returns 0 on success, 1 on incorrect prefix.