https://github.com/marcinorlowski/pre-commit-hooks
Handy Git hooks to integrate with pre-commit framework.
https://github.com/marcinorlowski/pre-commit-hooks
git pre-commit pre-commit-hooks
Last synced: 9 months ago
JSON representation
Handy Git hooks to integrate with pre-commit framework.
- Host: GitHub
- URL: https://github.com/marcinorlowski/pre-commit-hooks
- Owner: MarcinOrlowski
- License: mit
- Created: 2021-09-23T16:58:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-07T09:59:41.000Z (over 3 years ago)
- Last Synced: 2025-02-03T08:13:37.317Z (about 1 year ago)
- Topics: git, pre-commit, pre-commit-hooks
- Language: Python
- Homepage:
- Size: 80.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
Handy Git hooks to integrate with [pre-commit](http://pre-commit.com/) framework.
---
- [Configure pre-commit](#configure-pre-commit)
- [Two ways to invoke pre-commit](#two-ways-to-invoke-pre-commit)
- **Available hooks**
* [checkstyle-jar](docs/checkstyle-jar.md)
* [end-of-file](docs/end-of-file.md)
* [trailing-whitespaces](docs/trailing-whitespaces.md)
- [License](#license)
---
## Configure pre-commit
**NOTE:** hooks require Python 3.
Add `.pre-commit-config.yaml` config file to in your project:
```yaml
- repo: https://github.com/MarcinOrlowski/pre-commit-hooks
rev: 1.0.0 # or any specific git tag
hooks:
- id: checkstyle-jar
# args: [ '--jar=/path/to/checkstyle.jar' ]
- id: end-of-file
# exclude_types: ['xml','png','jpeg','svg']
# args: [ '--fix=yes' ]
- id: trailing-whitespaces
# exclude_types: ['xml','png','jpeg','svg']
# args: [ '--fix=no' ]
```
---
## Two ways to invoke pre-commit
If you want to invoke the checks as a git pre-commit hook, run:
```bash
$ pre-commit install
```
If you want to run the checks on-demand (outside of git hooks), run:
```bash
$ pre-commit run --all-files --verbose
```
To try your hooks with all the files present.
> **NOTE:** This will apply your hooks too **ALL** the files, which
> in case of using modifying hooks might not what you really want!
## License ##
* Written and copyrighted ©2021-2022 by Marcin Orlowski
* This is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)