Make the hook list more readable (folding descriptions)

The hook list is:

- `check-added-large-files`
- `check-ast`
- `check-builtin-literals`
- `check-case-conflict`
- `check-docstring-first`
- `check-executables-have-shebangs`
- `check-illegal-windows-names`
- `check-json`
- `check-merge-conflict`
- `check-shebang-scripts-are-executable`
- `check-symlinks`
- `check-toml`
- `check-vcs-permalinks`
- `check-xml`
- `check-yaml`
- `debug-statements`
- `destroyed-symlinks`
- `detect-aws-credentials`
- `detect-private-key`
- `double-quote-string-fixer`
- `end-of-file-fixer`
- `file-contents-sorter`
- `fix-byte-order-marker`
- `fix-encoding-pragma`
- `forbid-new-submodules`
- `forbid-submodules`
- `mixed-line-ending`
- `name-tests-test`
- `no-commit-to-branch`
- `pretty-format-json`
- `requirements-txt-fixer`
- `sort-simple-yaml`
- `trailing-whitespace`
This commit is contained in:
Zafar 2025-04-03 16:05:03 -07:00 committed by GitHub
parent 6db05e22aa
commit beb40f0aad
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

210
README.md
View file

@ -23,7 +23,12 @@ Add this to your `.pre-commit-config.yaml`
### Hooks available ### Hooks available
<details>
<summary>
#### `check-added-large-files` #### `check-added-large-files`
</summary>
Prevent giant files from being committed. 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).
- Limits checked files to those indicated as staged for addition by git. - Limits checked files to those indicated as staged for addition by git.
@ -31,56 +36,134 @@ Prevent giant files from being committed.
(requires `git-lfs>=2.2.1`) (requires `git-lfs>=2.2.1`)
- `--enforce-all` - Check all listed files not just those staged for - `--enforce-all` - Check all listed files not just those staged for
addition. addition.
</details>
<details>
<summary>
#### `check-ast` #### `check-ast`
</summary>
Simply check whether files parse as valid python. Simply check whether files parse as valid python.
</details>
<details>
<summary>
#### `check-builtin-literals` #### `check-builtin-literals`
Require literal syntax when initializing empty or zero Python builtin types. </summary>
- Allows calling constructors with positional arguments (e.g., `list('abc')`). </details>
- Allows calling constructors from the `builtins` (`__builtin__`) namespace (`builtins.list()`).
- Ignore this requirement for specific builtin types with `--ignore=type1,type2,…`. <details>
- Forbid `dict` keyword syntax with `--no-allow-dict-kwargs`. <summary>
#### `check-case-conflict` #### `check-case-conflict`
</summary>
Check for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT. Check for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT.
</details>
<details>
<summary>
#### `check-docstring-first` #### `check-docstring-first`
</summary>
Checks for a common error of placing code before the docstring. Checks for a common error of placing code before the docstring.
</details>
<details>
<summary>
#### `check-executables-have-shebangs` #### `check-executables-have-shebangs`
</summary>
Checks that non-binary executables have a proper shebang. Checks that non-binary executables have a proper shebang.
</details>
<details>
<summary>
#### `check-illegal-windows-names` #### `check-illegal-windows-names`
</summary>
Check for files that cannot be created on Windows. Check for files that cannot be created on Windows.
</details>
<details>
<summary>
#### `check-json` #### `check-json`
</summary>
Attempts to load all json files to verify syntax. Attempts to load all json files to verify syntax.
</details>
<details>
<summary>
#### `check-merge-conflict` #### `check-merge-conflict`
</summary>
Check for files that contain merge conflict strings. Check for files that contain merge conflict strings.
- `--assume-in-merge` - Allows running the hook when there is no ongoing merge operation - `--assume-in-merge` - Allows running the hook when there is no ongoing merge operation
</details>
<details>
<summary>
#### `check-shebang-scripts-are-executable` #### `check-shebang-scripts-are-executable`
</summary>
Checks that scripts with shebangs are executable. Checks that scripts with shebangs are executable.
</details>
<details>
<summary>
#### `check-symlinks` #### `check-symlinks`
</summary>
Checks for symlinks which do not point to anything. Checks for symlinks which do not point to anything.
</details>
<details>
<summary>
#### `check-toml` #### `check-toml`
</summary>
Attempts to load all TOML files to verify syntax. Attempts to load all TOML files to verify syntax.
</details>
<details>
<summary>
#### `check-vcs-permalinks` #### `check-vcs-permalinks`
</summary>
Ensures that links to vcs websites are permalinks. Ensures that links to vcs websites are permalinks.
- `--additional-github-domain DOMAIN` - Add check for specified domain. - `--additional-github-domain DOMAIN` - Add check for specified domain.
Can be repeated multiple times. for example, if your company uses Can be repeated multiple times. for example, if your company uses
GitHub Enterprise you may use something like GitHub Enterprise you may use something like
`--additional-github-domain github.example.com` `--additional-github-domain github.example.com`
</details>
<details>
<summary>
#### `check-xml` #### `check-xml`
</summary>
Attempts to load all xml files to verify syntax. Attempts to load all xml files to verify syntax.
</details>
<details>
<summary>
#### `check-yaml` #### `check-yaml`
</summary>
Attempts to load all yaml files to verify syntax. 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)
@ -89,34 +172,76 @@ Attempts to load all yaml files to verify syntax.
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`.
</details>
<details>
<summary>
#### `debug-statements` #### `debug-statements`
</summary>
Check for debugger imports and py37+ `breakpoint()` calls in python source. Check for debugger imports and py37+ `breakpoint()` calls in python source.
</details>
<details>
<summary>
#### `destroyed-symlinks` #### `destroyed-symlinks`
</summary>
Detects symlinks which are changed to regular files with a content of a path Detects symlinks which are changed to regular files with a content of a path
which that symlink was pointing to. which that symlink was pointing to.
This usually happens on Windows when a user clones a repository that has This usually happens on Windows when a user clones a repository that has
symlinks but they do not have the permission to create symlinks. symlinks but they do not have the permission to create symlinks.
</details>
<details>
<summary>
#### `detect-aws-credentials` #### `detect-aws-credentials`
</summary>
Checks for the existence of AWS secrets that you have set up with the AWS CLI. Checks for the existence of AWS secrets that you 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
configuration file in a non-standard location to fetch configured configuration file in a non-standard location to fetch configured
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 detected. - `--allow-missing-credentials` - Allow hook to pass when no credentials are detected.
</details>
<details>
<summary>
#### `detect-private-key` #### `detect-private-key`
</summary>
Checks for the existence of private keys. Checks for the existence of private keys.
</details>
<details>
<summary>
#### `double-quote-string-fixer` #### `double-quote-string-fixer`
</summary>
This hook replaces double quoted strings with single quoted strings. This hook replaces double quoted strings with single quoted strings.
</details>
<details>
<summary>
#### `end-of-file-fixer` #### `end-of-file-fixer`
</summary>
Makes sure files end in a newline and only a newline. Makes sure files end in a newline and only a newline.
</details>
<details>
<summary>
#### `file-contents-sorter` #### `file-contents-sorter`
</summary>
Sort the lines in specified files (defaults to alphabetical). Sort the lines in specified files (defaults to alphabetical).
You must provide the target [`files`](https://pre-commit.com/#config-files) as input. You must provide the target [`files`](https://pre-commit.com/#config-files) as input.
Note that this hook WILL remove blank lines and does NOT respect any comments. Note that this hook WILL remove blank lines and does NOT respect any comments.
@ -125,41 +250,83 @@ All newlines will be converted to line feeds (`\n`).
The following arguments are available: The following arguments are available:
- `--ignore-case` - fold lower case to upper case characters. - `--ignore-case` - fold lower case to upper case characters.
- `--unique` - ensure each line is unique. - `--unique` - ensure each line is unique.
</details>
<details>
<summary>
#### `fix-byte-order-marker` #### `fix-byte-order-marker`
</summary>
removes UTF-8 byte order marker removes UTF-8 byte order marker
</details>
<details>
<summary>
#### `fix-encoding-pragma` #### `fix-encoding-pragma`
</summary>
_Deprecated since py2 is EOL - use [pyupgrade](https://github.com/asottile/pyupgrade) instead._ _Deprecated since py2 is EOL - use [pyupgrade](https://github.com/asottile/pyupgrade) instead._
Add `# -*- coding: utf-8 -*-` to the top of python files. 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)
</details>
<details>
<summary>
#### `forbid-new-submodules` #### `forbid-new-submodules`
</summary>
Prevent addition of new git submodules. Prevent addition of new git submodules.
This is intended as a helper to migrate away from submodules. If you want to This is intended as a helper to migrate away from submodules. If you want to
ban them entirely use `forbid-submodules` ban them entirely use `forbid-submodules`
</details>
<details>
<summary>
#### `forbid-submodules` #### `forbid-submodules`
</summary>
forbids any submodules in the repository. forbids any submodules in the repository.
</details>
<details>
<summary>
#### `mixed-line-ending` #### `mixed-line-ending`
</summary>
Replaces or checks mixed line ending. 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.
</details>
<details>
<summary>
#### `name-tests-test` #### `name-tests-test`
</summary>
verifies that test files are named correctly. verifies that test files are named correctly.
- `--pytest` (the default): ensure tests match `.*_test\.py` - `--pytest` (the default): ensure tests match `.*_test\.py`
- `--pytest-test-first`: ensure tests match `test_.*\.py` - `--pytest-test-first`: ensure tests match `test_.*\.py`
- `--django` / `--unittest`: ensure tests match `test.*\.py` - `--django` / `--unittest`: ensure tests match `test.*\.py`
</details>
<details>
<summary>
#### `no-commit-to-branch` #### `no-commit-to-branch`
</summary>
Protect specific branches from direct checkins. Protect specific branches from direct checkins.
- Use `args: [--branch, staging, --branch, main]` to set the branch. - Use `args: [--branch, staging, --branch, main]` to set the branch.
Both `main` and `master` are protected by default if no branch argument is set. Both `main` and `master` are protected by default if no branch argument is set.
@ -174,8 +341,14 @@ As a result, it will ignore any setting of [`files`](https://pre-commit.com/#con
or [`exclude_types`](https://pre-commit.com/#config-exclude_types). or [`exclude_types`](https://pre-commit.com/#config-exclude_types).
Set [`always_run: false`](https://pre-commit.com/#config-always_run) to allow this hook to be skipped according to these Set [`always_run: false`](https://pre-commit.com/#config-always_run) to allow this hook to be skipped according to these
file filters. Caveat: In this configuration, empty commits (`git commit --allow-empty`) would always be allowed by this hook. file filters. Caveat: In this configuration, empty commits (`git commit --allow-empty`) would always be allowed by this hook.
</details>
<details>
<summary>
#### `pretty-format-json` #### `pretty-format-json`
</summary>
Checks that all your JSON files are pretty. "Pretty" 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:
@ -184,11 +357,23 @@ the following commandline options:
- `--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.
</details>
<details>
<summary>
#### `requirements-txt-fixer` #### `requirements-txt-fixer`
</summary>
Sorts entries in requirements.txt and constraints.txt and removes incorrect entry for `pkg-resources==0.0.0` Sorts entries in requirements.txt and constraints.txt and removes incorrect entry for `pkg-resources==0.0.0`
</details>
<details>
<summary>
#### `sort-simple-yaml` #### `sort-simple-yaml`
</summary>
Sorts simple YAML files which consist only of top-level Sorts simple YAML files which consist only of top-level
keys, preserving comments and blocks. keys, preserving comments and blocks.
@ -199,9 +384,14 @@ very specific format. You must opt in to this by setting [`files`](https://pre-
- id: sort-simple-yaml - id: sort-simple-yaml
files: ^config/simple/ files: ^config/simple/
``` ```
</details>
<details>
<summary>
#### `trailing-whitespace` #### `trailing-whitespace`
</summary>
Trims trailing whitespace. 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
@ -209,10 +399,18 @@ Trims trailing whitespace.
as markdown, use `--markdown-linebreak-ext=*`. as markdown, use `--markdown-linebreak-ext=*`.
- By default, this hook trims all whitespace from the ends of lines. - By default, this hook trims all whitespace from the ends of lines.
To specify a custom set of characters to trim instead, use `args: [--chars,"<chars to trim>"]`. To specify a custom set of characters to trim instead, use `args: [--chars,"<chars to trim>"]`.
</details>
### Deprecated / replaced hooks ### Deprecated / replaced hooks
- `check-byte-order-marker`: instead use fix-byte-order-marker <details>
<summary>
#### `check-byte-order-marker`
</summary>
instead use fix-byte-order-marker
</details>
### As a standalone package ### As a standalone package