pre-commit/pre-commit-hooks
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit-hooks.git synced 2026-03-29 18:16:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Some out-of-the-box hooks for pre-commit
106 commits 1 branch 56 tags 5.8 MiB
Find a file
Anthony Sottile a8b89150ff Add test for readme
2015-01-18 09:48:14 -08:00
pre_commit_hooks Add check-xml hook. 2015-01-17 10:30:58 -08:00
testing Add check-xml hook. 2015-01-17 10:30:58 -08:00
tests Add test for readme 2015-01-18 09:48:14 -08:00
.coveragerc Remove timid coverage. 2014-06-05 15:52:56 -07:00
.gitignore Update pre-commit config. 2014-06-05 09:23:49 -07:00
.pre-commit-config.yaml Update pre-commit hooks 2015-01-04 16:05:54 -08:00
.travis.yml Add check-xml hook. 2015-01-17 10:30:58 -08:00
CHANGELOG v0.3.0 2014-08-22 11:11:31 -07:00
hooks.yaml Add check-xml hook. 2015-01-17 10:30:58 -08:00
LICENSE MIT 2014-06-05 08:58:48 -07:00
Makefile requirements_dev -> requirements-dev 2014-06-05 09:09:21 -07:00
pylintrc Add check_case_conflict hook #21 2015-01-12 15:38:22 -08:00
README.md Add check-xml hook. 2015-01-17 10:30:58 -08:00
requirements-dev.txt Add check-xml hook. 2015-01-17 10:30:58 -08:00
requirements.txt Update project setup. 2014-04-13 22:09:26 -07:00
setup.py Add check-xml hook. 2015-01-17 10:30:58 -08:00
tox.ini Add check-xml hook. 2015-01-17 10:30:58 -08:00

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. (You'll want args: ['-i] when using this hook, see .pre-commit-config.yaml for an example.)
  • check-added-large-files - Prevent giant files from being committed.
  • check-case-conflict - Check for files that would conflict in case-insensitive filesystems.
  • 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-xml - Attempts to load all xml 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