Google Git
Sign in
cobalt / pre-commit-hooks / 6f7932991089c1cc5a33083eeb27864feb2fc4ed
commit6f7932991089c1cc5a33083eeb27864feb2fc4ed[log] [tgz]
authorAnthony Sottile <asottile@umich.edu>Sun Jan 04 13:22:09 2015 -0800
committerAnthony Sottile <asottile@umich.edu>Sun Jan 04 13:22:09 2015 -0800
tree7b041e3dec459bd8ec61c0d99d27dccf7902de04
parent7a5a46a1dc68f4a41f836416073226937b22b2c0 [diff]
parent53f1dc0163330633d8fb3ba8590089166cd49e47 [diff]
Merge pull request #18 from pre-commit/docstring_first

Add check-docstring-first hook.
tree: 7b041e3dec459bd8ec61c0d99d27dccf7902de04
  1. pre_commit_hooks/
  2. testing/
  3. tests/
  4. .coveragerc
  5. .gitignore
  6. .pre-commit-config.yaml
  7. .travis.yml
  8. CHANGELOG
  9. hooks.yaml
  10. LICENSE
  11. Makefile
  12. pylintrc
  13. README.md
  14. requirements-dev.txt
  15. requirements.txt
  16. setup.py
  17. tox.ini
README.md

Build Status Coverage Status

pre-commit-hooks

Some out-of-the-box hooks for pre-commit.

See also: https://github.com/pre-commit/pre-commit

Using pre-commit-hooks with pre-commit

Add this to your .pre-commit-config.yaml

-   repo: git://github.com/pre-commit/pre-commit-hooks
    sha: ''  # Use the sha you want to point at
    hooks:
    -   id: trailing-whitespace
    # -   id: ...

Hooks available

  • autopep8-wrapper - Runs autopep8 over python source.
  • check-added-large-files - Prevent giant files from being committed.
  • check-docstring-first - Checks a common error of defining a docstring after code.
  • check-json - Attempts to load all json files to verify syntax.
  • check-yaml - Attempts to load all yaml files to verify syntax.
  • debug-statements - Check for pdb / ipdb / pudb statements in code.
  • end-of-file-fixer - Makes sure files end in a newline and only a newline.
  • flake8 - Run flake8 on your python files
  • name-tests-test - Assert that files in tests/ end in _test.py
  • pyflakes - Run pyflakes on your python files
  • requirements-txt-fixer - Sorts entries in requirements.txt
  • trailing-whitespace - Trims trailing whitespace.

As a standalone package

If you‘d like to use these hooks, they’re also available as a standalone package.

Simply pip install pre-commit-hooks