pre-commit/pre-commit-hooks
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit-hooks.git synced 2026-04-07 04:26:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Allow linking directly to each hook

Browse source
This commit is contained in:
Jacob Bundgaard 2020-02-03 14:10:31 +01:00 • committed by GitHub
parent 31853d6c43
commit e4dcfc650b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -22,30 +22,30 @@ Add this to your `.pre-commit-config.yaml`
### Hooks available ### Hooks available
- `check-added-large-files` - Prevent giant files from being committed. - <a name="check-added-large-files">`check-added-large-files`</a> - Prevent giant files from being committed.
- Specify what is "too large" with `args: ['--maxkb=123']` (default=500kB). - Specify what is "too large" with `args: ['--maxkb=123']` (default=500kB).
- If `git-lfs` is installed, lfs files will be skipped - If `git-lfs` is installed, lfs files will be skipped
(requires `git-lfs>=2.2.1`) (requires `git-lfs>=2.2.1`)
- `check-ast` - Simply check whether files parse as valid python. - <a name="check-ast">`check-ast`</a> - Simply check whether files parse as valid python.
- `check-builtin-literals` - Require literal syntax when initializing empty or zero Python builtin types. - <a name="check-builtin-literals">`check-builtin-literals`</a> - Require literal syntax when initializing empty or zero Python builtin types.
- Allows calling constructors with positional arguments (e.g., `list('abc')`). - Allows calling constructors with positional arguments (e.g., `list('abc')`).
- Allows calling constructors from the `builtins` (`__builtin__`) namespace (`builtins.list()`). - Allows calling constructors from the `builtins` (`__builtin__`) namespace (`builtins.list()`).
- Ignore this requirement for specific builtin types with `--ignore=type1,type2,…`. - Ignore this requirement for specific builtin types with `--ignore=type1,type2,…`.
- Forbid `dict` keyword syntax with `--no-allow-dict-kwargs`. - Forbid `dict` keyword syntax with `--no-allow-dict-kwargs`.
- `check-byte-order-marker` - Forbid files which have a UTF-8 byte-order marker - <a name="check-byte-order-marker">`check-byte-order-marker`</a> - Forbid files which have a UTF-8 byte-order marker
- `check-case-conflict` - Check for files with names that would conflict on a - <a name="check-case-conflict">`check-case-conflict`</a> - Check for files with names that would conflict on a
case-insensitive filesystem like MacOS HFS+ or Windows FAT. case-insensitive filesystem like MacOS HFS+ or Windows FAT.
- `check-docstring-first` - Checks for a common error of placing code before - <a name="check-docstring-first">`check-docstring-first`</a> - Checks for a common error of placing code before
the docstring. the docstring.
- `check-executables-have-shebangs` - Checks that non-binary executables have a - <a name="check-executables-have-shebangs">`check-executables-have-shebangs`</a> - Checks that non-binary executables have a
proper shebang. proper shebang.
- `check-json` - Attempts to load all json files to verify syntax. - <a name="check-json">`check-json`</a> - Attempts to load all json files to verify syntax.
- `check-merge-conflict` - Check for files that contain merge conflict strings. - <a name="check-merge-conflict">`check-merge-conflict`</a> - Check for files that contain merge conflict strings.
- `check-symlinks` - Checks for symlinks which do not point to anything. - <a name="check-symlinks">`check-symlinks`</a> - Checks for symlinks which do not point to anything.
- `check-toml` - Attempts to load all TOML files to verify syntax. - <a name="check-toml">`check-toml`</a> - Attempts to load all TOML files to verify syntax.
- `check-vcs-permalinks` - Ensures that links to vcs websites are permalinks. - <a name="check-vcs-permalinks">`check-vcs-permalinks`</a> - Ensures that links to vcs websites are permalinks.
- `check-xml` - Attempts to load all xml files to verify syntax. - <a name="check-xml">`check-xml`</a> - Attempts to load all xml files to verify syntax.
- `check-yaml` - Attempts to load all yaml files to verify syntax. - <a name="check-yaml">`check-yaml`</a> - Attempts to load all yaml files to verify syntax.
- `--allow-multiple-documents` - allow yaml files which use the - `--allow-multiple-documents` - allow yaml files which use the
[multi-document syntax](http://www.yaml.org/spec/1.2/spec.html#YAML) [multi-document syntax](http://www.yaml.org/spec/1.2/spec.html#YAML)
- `--unsafe` - Instead of loading the files, simply parse them for syntax. - `--unsafe` - Instead of loading the files, simply parse them for syntax.
@ -53,9 +53,9 @@ Add this to your `.pre-commit-config.yaml`
otherwise be forbidden. Using this option removes all guarantees of otherwise be forbidden. Using this option removes all guarantees of
portability to other yaml implementations. portability to other yaml implementations.
Implies `--allow-multiple-documents`. Implies `--allow-multiple-documents`.
- `debug-statements` - Check for debugger imports and py37+ `breakpoint()` - <a name="debug-statements">`debug-statements`</a> - Check for debugger imports and py37+ `breakpoint()`
calls in python source. calls in python source.
- `detect-aws-credentials` - Checks for the existence of AWS secrets that you - <a name="detect-aws-credentials">`detect-aws-credentials`</a> - Checks for the existence of AWS secrets that you
have set up with the AWS CLI. have set up with the AWS CLI.
The following arguments are available: The following arguments are available:
- `--credentials-file CREDENTIALS_FILE` - additional AWS CLI style - `--credentials-file CREDENTIALS_FILE` - additional AWS CLI style
@ -63,31 +63,31 @@ Add this to your `.pre-commit-config.yaml`
credentials from. Can be repeated multiple times. credentials from. Can be repeated multiple times.
- `--allow-missing-credentials` - Allow hook to pass when no credentials are - `--allow-missing-credentials` - Allow hook to pass when no credentials are
detected. detected.
- `detect-private-key` - Checks for the existence of private keys. - <a name="detect-private-key">`detect-private-key`</a> - Checks for the existence of private keys.
- `double-quote-string-fixer` - This hook replaces double quoted strings - <a name="double-quote-string-fixer">`double-quote-string-fixer`</a> - This hook replaces double quoted strings
with single quoted strings. with single quoted strings.
- `end-of-file-fixer` - Makes sure files end in a newline and only a newline. - <a name="end-of-file-fixer">`end-of-file-fixer`</a> - Makes sure files end in a newline and only a newline.
- `fix-encoding-pragma` - Add `# -*- coding: utf-8 -*-` to the top of python files. - <a name="fix-encoding-pragma">`fix-encoding-pragma`</a> - Add `# -*- coding: utf-8 -*-` to the top of python files.
- To remove the coding pragma pass `--remove` (useful in a python3-only codebase) - To remove the coding pragma pass `--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. - <a name="file-contents-sorter">`file-contents-sorter`</a> - 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. - <a name="flake8">`flake8`</a> - Run flake8 on your python files.
- `forbid-new-submodules` - Prevent addition of new git submodules. - <a name="forbid-new-submodules">`forbid-new-submodules`</a> - Prevent addition of new git submodules.
- `mixed-line-ending` - Replaces or checks mixed line ending. - <a name="mixed-line-ending">`mixed-line-ending`</a> - Replaces or checks mixed line ending.
- `--fix={auto,crlf,lf,no}` - `--fix={auto,crlf,lf,no}`
- `auto` - Replaces automatically the most frequent line ending. This is the default argument. - `auto` - Replaces automatically the most frequent line ending. This is the default argument.
- `crlf`, `lf` - Forces to replace line ending by respectively CRLF and LF. - `crlf`, `lf` - Forces to replace line ending by respectively CRLF and LF.
- This option isn't compatible with git setup check-in LF check-out CRLF as git smudge this later than the hook is invoked. - This option isn't compatible with git setup check-in LF check-out CRLF as git smudge this later than the hook is invoked.
- `no` - Checks if there is any mixed line ending without modifying any file. - `no` - Checks if there is any mixed line ending without modifying any file.
- `name-tests-test` - Assert that files in tests/ end in `_test.py`. - <a name="name-tests-test">`name-tests-test`</a> - Assert that files in tests/ end in `_test.py`.
- Use `args: ['--django']` to match `test*.py` instead. - Use `args: ['--django']` to match `test*.py` instead.
- `no-commit-to-branch` - Protect specific branches from direct checkins. - <a name="no-commit-to-branch">`no-commit-to-branch`</a> - Protect specific branches from direct checkins.
- Use `args: [--branch, staging, --branch, master]` to set the branch. - Use `args: [--branch, staging, --branch, master]` to set the branch.
`master` is the default if no branch argument is set. `master` is the default if no branch argument is set.
- `-b` / `--branch` may be specified multiple times to protect multiple - `-b` / `--branch` may be specified multiple times to protect multiple
branches. branches.
- `-p` / `--pattern` can be used to protect branches that match a supplied regex - `-p` / `--pattern` can be used to protect branches that match a supplied regex
(e.g. `--pattern, release/.*`). May be specified multiple times. (e.g. `--pattern, release/.*`). May be specified multiple times.
- `pretty-format-json` - Checks that all your JSON files are pretty. "Pretty" - <a name="pretty-format-json">`pretty-format-json`</a> - Checks that all your JSON files are pretty. "Pretty"
here means that keys are sorted and indented. You can configure this with here means that keys are sorted and indented. You can configure this with
the following commandline options: the following commandline options:
- `--autofix` - automatically format json files - `--autofix` - automatically format json files
@ -95,8 +95,8 @@ Add this to your `.pre-commit-config.yaml`
- `--no-ensure-ascii` preserve unicode characters instead of converting to escape sequences - `--no-ensure-ascii` preserve unicode characters instead of converting to escape sequences
- `--no-sort-keys` - when autofixing, retain the original key ordering (instead of sorting the keys) - `--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. - `--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 `pkg-resources==0.0.0` - <a name="requirements-txt-fixer">`requirements-txt-fixer`</a> - Sorts entries in requirements.txt and removes incorrect entry for `pkg-resources==0.0.0`
- `sort-simple-yaml` - Sorts simple YAML files which consist only of top-level - <a name="sort-simple-yaml">`sort-simple-yaml`</a> - Sorts simple YAML files which consist only of top-level
keys, preserving comments and blocks. keys, preserving comments and blocks.
Note that `sort-simple-yaml` by default matches no `files` as it enforces a Note that `sort-simple-yaml` by default matches no `files` as it enforces a
@ -108,7 +108,7 @@ Add this to your `.pre-commit-config.yaml`
files: ^config/simple/ files: ^config/simple/
``` ```
- `trailing-whitespace` - Trims trailing whitespace. - <a name="trailing-whitespace">`trailing-whitespace`</a> - Trims trailing whitespace.
- To preserve Markdown [hard linebreaks](https://github.github.com/gfm/#hard-line-break) - To preserve Markdown [hard linebreaks](https://github.github.com/gfm/#hard-line-break)
use `args: [--markdown-linebreak-ext=md]` (or other extensions used use `args: [--markdown-linebreak-ext=md]` (or other extensions used
by your markdownfiles). If for some reason you want to treat all files by your markdownfiles). If for some reason you want to treat all files