Package: pre-commit-hooks
pre-commit-hooksSome out-of-the-box hooks for pre-commit.See also:https://github.com/pre-commit/pre-commitUsing pre-commit-hooks with pre-commitAdd this to your.pre-commit-config.yaml-repo:https://github.com/pre-commit/pre-commit-hooksrev:v4.5.0# Use the ref you want to point athooks:-id:trailing-whitespace# -   id: ...Hooks availablecheck-added-large-filesPrevent giant files from being committed.Specify what is "too large" withargs: ['--maxkb=123'](default=500kB).Limits checked files to those indicated as staged for addition by git.Ifgit-lfsis installed, lfs files will be skipped
(requiresgit-lfs>=2.2.1)--enforce-all- Check all listed files not just those staged for
addition.check-astSimply check whether files parse as valid python.check-builtin-literalsRequire literal syntax when initializing empty or zero Python builtin types.Allows calling constructors with positional arguments (e.g.,list('abc')).Allows calling constructors from thebuiltins(__builtin__) namespace (builtins.list()).Ignore this requirement for specific builtin types with--ignore=type1,type2,….Forbiddictkeyword syntax with--no-allow-dict-kwargs.check-case-conflictCheck for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT.check-docstring-firstChecks for a common error of placing code before the docstring.check-executables-have-shebangsChecks that non-binary executables have a proper shebang.check-jsonAttempts to load all json files to verify syntax.check-merge-conflictCheck for files that contain merge conflict strings.--assume-in-merge- Allows running the hook when there is no ongoing merge operationcheck-shebang-scripts-are-executableChecks that scripts with shebangs are executable.check-symlinksChecks for symlinks which do not point to anything.check-tomlAttempts to load all TOML files to verify syntax.check-vcs-permalinksEnsures that links to vcs websites are permalinks.--additional-github-domain DOMAIN- Add check for specified domain.
Can be repeated multiple times.  for example, if your company uses
GitHub Enterprise you may use something like--additional-github-domain github.example.comcheck-xmlAttempts to load all xml files to verify syntax.check-yamlAttempts to load all yaml files to verify syntax.--allow-multiple-documents- allow yaml files which use themulti-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--allow-multiple-documents.debug-statementsCheck for debugger imports and py37+breakpoint()calls in python source.destroyed-symlinksDetects symlinks which are changed to regular files with a content of a path
which that symlink was pointing to.
This usually happens on Windows when a user clones a repository that has
symlinks but they do not have the permission to create symlinks.detect-aws-credentialsChecks 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-keyChecks for the existence of private keys.double-quote-string-fixerThis hook replaces double quoted strings with single quoted strings.end-of-file-fixerMakes sure files end in a newline and only a newline.file-contents-sorterSort the lines in specified files (defaults to alphabetical).
You must provide the targetfilesas input.
Note that this hook WILL remove blank lines and does NOT respect any comments.
All newlines will be converted to line feeds (\n).The following arguments are available:--ignore-case- fold lower case to upper case characters.--unique- ensure each line is unique.fix-byte-order-markerremoves UTF-8 byte order markerfix-encoding-pragmaAdd# -*- coding: utf-8 -*-to the top of python files.To remove the coding pragma pass--remove(useful in a python3-only codebase)forbid-new-submodulesPrevent addition of new git submodules.This is intended as a helper to migrate away from submodules.  If you want to
ban them entirely useforbid-submodulesforbid-submodulesforbids any submodules in the repository.mixed-line-endingReplaces or checks mixed line ending.--fix={auto,crlf,lf,no}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.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.name-tests-testverifies that test files are named correctly.--pytest(the default): ensure tests match.*_test\.py--pytest-test-first: ensure tests matchtest_.*\.py--django/--unittest: ensure tests matchtest.*\.pyno-commit-to-branchProtect specific branches from direct checkins.Useargs: [--branch, staging, --branch, main]to set the branch.
Bothmainandmasterare protected by default if no branch argument is set.-b/--branchmay be specified multiple times to protect multiple
branches.-p/--patterncan be used to protect branches that match a supplied regex
(e.g.--pattern, release/.*). May be specified multiple times.Note thatno-commit-to-branchis configured by default toalways_run.
As a result, it will ignore any setting offiles,exclude,typesorexclude_types.
Setalways_run: falseto 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.pretty-format-jsonChecks 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 2 spaces.--no-ensure-asciipreserve unicode characters instead of converting to escape sequences--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-fixerSorts entries in requirements.txt and constraints.txt and removes incorrect entry forpkg-resources==0.0.0sort-simple-yamlSorts simple YAML files which consist only of top-level
keys, preserving comments and blocks.Note thatsort-simple-yamlby default matches nofilesas it enforces a
very specific format.  You must opt in to this by settingfiles, for example:-id:sort-simple-yamlfiles:^config/simple/trailing-whitespaceTrims trailing whitespace.To preserve Markdownhard linebreaksuseargs: [--markdown-linebreak-ext=md](or other extensions used
by your markdownfiles).  If for some reason you want to treat all files
as markdown, use--markdown-linebreak-ext=*.By default, this hook trims all whitespace from the ends of lines.
To specify a custom set of characters to trim instead, useargs: [--chars,"<chars to trim>"].Deprecated / replaced hookscheck-byte-order-marker: instead use fix-byte-order-markerAs a standalone packageIf you'd like to use these hooks, they're also available as a standalone package.Simplypip install pre-commit-hooks