{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/451", "result": {"data":{"issuesJson":{"id":"3bf6e5a8-8d5f-5889-bc30-f7f8b3fd012e","title":"pre-commit/pre-commit-hooks: 一些用于代码预提交的开箱即用的前置检测工具","number":451,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Repospre-commit/pre-commit-hooks
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

\"build
\n\"pre-commit.ci

\n

pre-commit-hooks

\n

Some out-of-the-box hooks for pre-commit.

\n

See also: https://github.com/pre-commit/pre-commit

\n

Using pre-commit-hooks with pre-commit

\n

Add this to your .pre-commit-config.yaml

\n
-   repo: https://github.com/pre-commit/pre-commit-hooks\n    rev: v5.0.0  # Use the ref you want to point at\n    hooks:\n    -   id: trailing-whitespace\n    # -   id: ...
\n

Hooks available

\n

check-added-large-files

\n

Prevent giant files from being committed.

\n\n

check-ast

\n

Simply check whether files parse as valid python.

\n

check-builtin-literals

\n

Require literal syntax when initializing empty or zero Python builtin types.

\n\n

check-case-conflict

\n

Check for files with names that would conflict on a case-insensitive filesystem like MacOS HFS+ or Windows FAT.

\n

check-docstring-first

\n

Checks for a common error of placing code before the docstring.

\n

check-executables-have-shebangs

\n

Checks that non-binary executables have a proper shebang.

\n

check-illegal-windows-names

\n

Check for files that cannot be created on Windows.

\n

check-json

\n

Attempts to load all json files to verify syntax.

\n

check-merge-conflict

\n

Check for files that contain merge conflict strings.

\n\n

check-shebang-scripts-are-executable

\n

Checks that scripts with shebangs are executable.

\n

check-symlinks

\n

Checks for symlinks which do not point to anything.

\n

check-toml

\n

Attempts to load all TOML files to verify syntax.

\n

check-vcs-permalinks

\n

Ensures that links to vcs websites are permalinks.

\n\n

check-xml

\n

Attempts to load all xml files to verify syntax.

\n

check-yaml

\n

Attempts to load all yaml files to verify syntax.

\n\n

debug-statements

\n

Check for debugger imports and py37+ breakpoint() calls in python source.

\n

destroyed-symlinks

\n

Detects symlinks which are changed to regular files with a content of a path
\nwhich that symlink was pointing to.
\nThis usually happens on Windows when a user clones a repository that has
\nsymlinks but they do not have the permission to create symlinks.

\n

detect-aws-credentials

\n

Checks for the existence of AWS secrets that you have set up with the AWS CLI.
\nThe following arguments are available:

\n\n

detect-private-key

\n

Checks for the existence of private keys.

\n

double-quote-string-fixer

\n

This hook replaces double quoted strings with single quoted strings.

\n

end-of-file-fixer

\n

Makes sure files end in a newline and only a newline.

\n

file-contents-sorter

\n

Sort the lines in specified files (defaults to alphabetical).
\nYou must provide the target files as input.
\nNote that this hook WILL remove blank lines and does NOT respect any comments.
\nAll newlines will be converted to line feeds (\\n).

\n

The following arguments are available:

\n\n

fix-byte-order-marker

\n

removes UTF-8 byte order marker

\n

fix-encoding-pragma

\n

Deprecated since py2 is EOL - use pyupgrade instead.

\n

Add # -*- coding: utf-8 -*- to the top of python files.

\n\n

forbid-new-submodules

\n

Prevent addition of new git submodules.

\n

This is intended as a helper to migrate away from submodules. If you want to
\nban them entirely use forbid-submodules

\n

forbid-submodules

\n

forbids any submodules in the repository.

\n

mixed-line-ending

\n

Replaces or checks mixed line ending.

\n\n

name-tests-test

\n

verifies that test files are named correctly.

\n\n

no-commit-to-branch

\n

Protect specific branches from direct checkins.

\n\n

Note that no-commit-to-branch is configured by default to always_run.
\nAs a result, it will ignore any setting of files,
\nexclude, types
\nor exclude_types.
\nSet always_run: false to allow this hook to be skipped according to these
\nfile filters. Caveat: In this configuration, empty commits (git commit --allow-empty) would always be allowed by this hook.

\n

pretty-format-json

\n

Checks that all your JSON files are pretty. \"Pretty\"
\nhere means that keys are sorted and indented. You can configure this with
\nthe following commandline options:

\n\n

requirements-txt-fixer

\n

Sorts entries in requirements.txt and constraints.txt and removes incorrect entry for pkg-resources==0.0.0

\n

sort-simple-yaml

\n

Sorts simple YAML files which consist only of top-level
\nkeys, preserving comments and blocks.

\n

Note that sort-simple-yaml by default matches no files as it enforces a
\nvery specific format. You must opt in to this by setting files, for example:

\n
    -   id: sort-simple-yaml\n        files: ^config/simple/
\n

trailing-whitespace

\n

Trims trailing whitespace.

\n\n

Deprecated / replaced hooks

\n\n

As a standalone package

\n

If you'd like to use these hooks, they're also available as a standalone package.

\n

Simply pip install pre-commit-hooks

","updatedAt":"2025-05-21T16:16:46Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"Dev-Tools","color":"48310b"}},{"node":{"name":"pre-commit","color":"e55a8d"}}]},"comments":{"edges":[]}}},"pageContext":{"number":451,"previous":{"title":"Postcatlab/postcat: 一个可扩展的 API 工具平台，支持多平台","number":450},"next":{"title":"denilsonsa/prettyping: prettyping 是标准工具的包装器 ping，目的是使输出更漂亮、更丰富多彩、更紧凑且更易于阅读。","number":452}}}, "staticQueryHashes": ["151096407","2861350382"]}