Flexible Git Pre-Commit Hooks
Project description
Git Patrol
The goal is to create a plug and play git pre-commit hook that completes a bunch of basic checks, but also lints each file with its language’s respective linter.
Deeply inspired by Bob Gilmore’s githooks
Installation:
pip install gitpatrol
cd {location/of/your/repo}
gitpatrol init
Add a gitpatrol.toml file to root folder (samples are here)
Make some changes to some files in your repo that do not respect the checkers in your gitpatrol.toml file
Stage your changes for commit
git commit
You should get output that looks like this:
The value in quotations marks at the beginning of each line is the offending character sequence, which your checker found
The values in parentheses reference the checkers defined in the gitpatrol.toml file, which have found a problem with your commit
Your commit will be blocked until the checkers are happy (or you disable them)
Development
I would love it if you used the Issue Tracker to notify me of PRs you’d like to contribute to this project. There are a couple things I’d like to implement next. You can see them in the TODO.md
To run tests
Clone the project from its GitHub repo
pip install -r dev-requirements
nosetests
nosetests --with-coverage --cover-html --cover-branches (runs with coverage)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.