Skip to main content

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:

  1. pip install gitpatrol
  2. cd {location/of/your/repo}
  3. gitpatrol init
  4. Add a gitpatrol.toml file to root folder (samples are here)
  5. Make some changes to some files in your repo that do not respect the checkers in your gitpatrol.toml file
  6. Stage your changes for commit
  7. git commit
  8. You should get output that looks like this: Git Patrol output
  9. The value in quotations marks at the beginning of each line is the offending character sequence, which your checker found
  10. The values in parentheses reference the checkers defined in the gitpatrol.toml file, which have found a problem with your commit
  11. 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

  1. Clone the project from its GitHub repo
  2. pip install -r dev-requirements
  3. nosetests
  4. nosetests --with-coverage --cover-html --cover-branches (runs with coverage)

Project details


Release history Release notifications

This version
History Node

0.0.2

History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
gitpatrol-0.0.2.tar.gz (5.8 kB) Copy SHA256 hash SHA256 Source None Jun 23, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page