|author||Anthony Sottile <email@example.com>||Mon Oct 28 15:19:58 2019 -0700|
|committer||Anthony Sottile <firstname.lastname@example.org>||Mon Oct 28 15:19:58 2019 -0700|
Some out-of-the-box hooks for pre-commit.
See also: https://github.com/pre-commit/pre-commit
Add this to your
- repo: https://github.com/pre-commit/pre-commit-hooks rev: v2.4.0 # Use the ref you want to point at hooks: - id: trailing-whitespace # - id: ...
check-added-large-files - Prevent giant files from being committed.
git-lfsis installed, lfs files will be skipped (requires
check-ast - Simply check whether files parse as valid python.
check-builtin-literals - Require literal syntax when initializing empty or zero Python builtin types.
__builtin__) namespace (
dictkeyword syntax with
check-byte-order-marker - Forbid files which have a UTF-8 byte-order marker
check-case-conflict - Check for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT.
check-docstring-first - Checks for a common error of placing code before the docstring.
check-executables-have-shebangs - Checks that non-binary executables have a proper shebang.
check-json - Attempts to load all json files to verify syntax.
check-merge-conflict - Check for files that contain merge conflict strings.
check-symlinks - Checks for symlinks which do not point to anything.
check-toml - Attempts to load all TOML files to verify syntax.
check-vcs-permalinks - Ensures that links to vcs websites are permalinks.
check-xml - Attempts to load all xml files to verify syntax.
check-yaml - Attempts to load all yaml files to verify syntax.
--allow-multiple-documents- allow yaml files which use the multi-document syntax
--unsafe- Instead of loading the files, simply parse them for syntax. A syntax-only check enables extensions and unsafe constructs which would otherwise be forbidden. Using this option removes all guarantees of portability to other yaml implementations. Implies
debug-statements - Check for debugger imports and py37+
breakpoint() calls in python source.
detect-aws-credentials - Checks for the existence of AWS secrets that you have set up with the AWS CLI. The following arguments are available:
--credentials-file CREDENTIALS_FILE- additional AWS CLI style configuration file in a non-standard location to fetch configured credentials from. Can be repeated multiple times.
--allow-missing-credentials- Allow hook to pass when no credentials are detected.
detect-private-key - Checks for the existence of private keys.
double-quote-string-fixer - This hook replaces double quoted strings with single quoted strings.
end-of-file-fixer - Makes sure files end in a newline and only a newline.
fix-encoding-pragma - Add
# -*- coding: utf-8 -*- to the top of python files.
--remove(useful in a python3-only codebase)
file-contents-sorter - Sort the lines in specified files (defaults to alphabetical). You must provide list of target files as input to it. Note that this hook WILL remove blank lines and does NOT respect any comments.
flake8 - Run flake8 on your python files.
forbid-new-submodules - Prevent addition of new git submodules.
mixed-line-ending - Replaces or checks mixed line ending.
auto- Replaces automatically the most frequent line ending. This is the default argument.
lf- Forces to replace line ending by respectively CRLF and LF.
no- Checks if there is any mixed line ending without modifying any file.
name-tests-test - Assert that files in tests/ end in
args: ['--django']to match
no-commit-to-branch - Protect specific branches from direct checkins.
args: [--branch, staging, --branch, master]to set the branch.
masteris the default if no branch argument is set.
--branchmay be specified multiple times to protect multiple branches.
--patterncan be used to protect branches that match a supplied regex (e.g.
--pattern, release/.*). May be specified multiple times.
pretty-format-json - Checks that all your JSON files are pretty. “Pretty” here means that keys are sorted and indented. You can configure this with the following commandline options:
--autofix- automatically format json files
--indent ...- Control the indentation (either a number for a number of spaces or a string of whitespace). Defaults to 4 spaces.
--no-sort-keys- when autofixing, retain the original key ordering (instead of sorting the keys)
--top-keys comma,separated,keys- Keys to keep at the top of mappings.
requirements-txt-fixer - Sorts entries in requirements.txt and removes incorrect entry for
sort-simple-yaml - Sorts simple YAML files which consist only of top-level keys, preserving comments and blocks.
sort-simple-yaml by default matches no
files as it enforces a very specific format. You must opt in to this by setting
files, for example:
- id: sort-simple-yaml files: ^config/simple/
trailing-whitespace - Trims trailing whitespace.
args: [--markdown-linebreak-ext=md](or other extensions used by your markdownfiles). If for some reason you want to treat all files as markdown, use
args: [--chars,"<chars to trim>"].
autopep8-wrapper: instead use mirrors-autopep8
pyflakes: instead use
If you‘d like to use these hooks, they’re also available as a standalone package.
pip install pre-commit-hooks