Fix inconsistent name and description values

This commit is contained in:
Iulian Onofrei 2021-07-27 09:14:50 +03:00 committed by GitHub
parent 4742cdf346
commit 5918791f4d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,17 +1,17 @@
- id: check-added-large-files - id: check-added-large-files
name: Check for added large files name: Check for added large files
description: Prevent giant files from being committed description: Prevent giant files from being committed.
entry: check-added-large-files entry: check-added-large-files
language: python language: python
- id: check-ast - id: check-ast
name: Check python ast name: Check Python AST
description: Simply check whether the files parse as valid python. description: Simply check whether the files parse as valid python.
entry: check-ast entry: check-ast
language: python language: python
types: [python] types: [python]
- id: check-byte-order-marker - id: check-byte-order-marker
name: 'check BOM - deprecated: use fix-byte-order-marker' name: 'Check BOM - deprecated: use fix-byte-order-marker'
description: forbid files which have a UTF-8 byte-order marker description: Forbid files which have a UTF-8 byte-order marker.
entry: check-byte-order-marker entry: check-byte-order-marker
language: python language: python
types: [text] types: [text]
@ -23,7 +23,7 @@
types: [python] types: [python]
- id: check-case-conflict - id: check-case-conflict
name: Check for case conflicts name: Check for case conflicts
description: Check for files that would conflict in case-insensitive filesystems description: Check for files that would conflict in case-insensitive filesystems.
entry: check-case-conflict entry: check-case-conflict
language: python language: python
- id: check-docstring-first - id: check-docstring-first
@ -41,7 +41,7 @@
stages: [commit, push, manual] stages: [commit, push, manual]
- id: check-json - id: check-json
name: Check JSON name: Check JSON
description: This hook checks json files for parseable syntax. description: This hook checks JSON files for parseable syntax.
entry: check-json entry: check-json
language: python language: python
types: [json] types: [json]
@ -71,98 +71,98 @@
language: python language: python
types: [symlink] types: [symlink]
- id: check-toml - id: check-toml
name: Check Toml name: Check TOML
description: This hook checks toml files for parseable syntax. description: This hook checks TOML files for parseable syntax.
entry: check-toml entry: check-toml
language: python language: python
types: [toml] types: [toml]
- id: check-vcs-permalinks - id: check-vcs-permalinks
name: Check vcs permalinks name: Check VCS permalinks
description: Ensures that links to vcs websites are permalinks. description: Ensures that links to VCS websites are permalinks.
entry: check-vcs-permalinks entry: check-vcs-permalinks
language: python language: python
types: [text] types: [text]
- id: check-xml - id: check-xml
name: Check Xml name: Check XML
description: This hook checks xml files for parseable syntax. description: This hook checks XML files for parseable syntax.
entry: check-xml entry: check-xml
language: python language: python
types: [xml] types: [xml]
- id: check-yaml - id: check-yaml
name: Check Yaml name: Check YAML
description: This hook checks yaml files for parseable syntax. description: This hook checks YAML files for parseable syntax.
entry: check-yaml entry: check-yaml
language: python language: python
types: [yaml] types: [yaml]
- id: debug-statements - id: debug-statements
name: Debug Statements (Python) name: Debug statements (Python)
description: Check for debugger imports and py37+ `breakpoint()` calls in python source. description: Check for debugger imports and py37+ `breakpoint()` calls in python source.
entry: debug-statement-hook entry: debug-statement-hook
language: python language: python
types: [python] types: [python]
- id: destroyed-symlinks - id: destroyed-symlinks
name: Detect Destroyed Symlinks name: Detect destroyed symlinks
description: Detects symlinks which are changed to regular files with a content of a path which that symlink was pointing to. description: Detects symlinks which are changed to regular files with a content of a path which that symlink was pointing to.
entry: destroyed-symlinks entry: destroyed-symlinks
language: python language: python
types: [file] types: [file]
- id: detect-aws-credentials - id: detect-aws-credentials
name: Detect AWS Credentials name: Detect AWS credentials
description: Detects *your* aws credentials from the aws cli credentials file description: Detects *your* AWS credentials from the AWS CLI credentials file.
entry: detect-aws-credentials entry: detect-aws-credentials
language: python language: python
types: [text] types: [text]
- id: detect-private-key - id: detect-private-key
name: Detect Private Key name: Detect private key
description: Detects the presence of private keys description: Detects the presence of private keys.
entry: detect-private-key entry: detect-private-key
language: python language: python
types: [text] types: [text]
- id: double-quote-string-fixer - id: double-quote-string-fixer
name: Fix double quoted strings name: Fix double quoted strings
description: This hook replaces double quoted strings with single quoted strings description: This hook replaces double quoted strings with single quoted strings.
entry: double-quote-string-fixer entry: double-quote-string-fixer
language: python language: python
types: [python] types: [python]
- id: end-of-file-fixer - id: end-of-file-fixer
name: Fix End of Files name: Fix end of files
description: Ensures that a file is either empty, or ends with one newline. description: Ensures that a file is either empty, or ends with one newline.
entry: end-of-file-fixer entry: end-of-file-fixer
language: python language: python
types: [text] types: [text]
stages: [commit, push, manual] stages: [commit, push, manual]
- id: file-contents-sorter - id: file-contents-sorter
name: File Contents Sorter name: File contents sorter
description: Sort the lines in specified files (defaults to alphabetical). You must provide list of target files as input in your .pre-commit-config.yaml file. description: Sort the lines in specified files (defaults to alphabetical). You must provide list of target files as input in your .pre-commit-config.yaml file.
entry: file-contents-sorter entry: file-contents-sorter
language: python language: python
files: '^$' files: '^$'
- id: fix-byte-order-marker - id: fix-byte-order-marker
name: fix UTF-8 byte order marker name: Fix UTF-8 byte order marker
description: removes UTF-8 byte order marker description: Removes UTF-8 byte order marker.
entry: fix-byte-order-marker entry: fix-byte-order-marker
language: python language: python
types: [text] types: [text]
- id: fix-encoding-pragma - id: fix-encoding-pragma
name: Fix python encoding pragma name: Fix python encoding pragma
description: 'Add # -*- coding: utf-8 -*- to the top of python files.'
language: python language: python
entry: fix-encoding-pragma entry: fix-encoding-pragma
description: 'Add # -*- coding: utf-8 -*- to the top of python files'
types: [python] types: [python]
- id: forbid-new-submodules - id: forbid-new-submodules
name: Forbid new submodules name: Forbid new submodules
description: Prevent addition of new git submodules.
language: python language: python
entry: forbid-new-submodules entry: forbid-new-submodules
description: Prevent addition of new git submodules
- id: mixed-line-ending - id: mixed-line-ending
name: Mixed line ending name: Mixed line ending
description: Replaces or checks mixed line ending description: Replaces or checks mixed line ending.
entry: mixed-line-ending entry: mixed-line-ending
language: python language: python
types: [text] types: [text]
- id: name-tests-test - id: name-tests-test
name: Tests should end in _test.py name: Tests should end in _test.py
description: This verifies that test files are named correctly description: This verifies that test files are named correctly.
entry: name-tests-test entry: name-tests-test
language: python language: python
files: (^|/)tests/.+\.py$ files: (^|/)tests/.+\.py$
@ -174,18 +174,18 @@
always_run: true always_run: true
- id: requirements-txt-fixer - id: requirements-txt-fixer
name: Fix requirements.txt name: Fix requirements.txt
description: Sorts entries in requirements.txt description: Sorts entries in requirements.txt.
entry: requirements-txt-fixer entry: requirements-txt-fixer
language: python language: python
files: requirements.*\.txt$ files: requirements.*\.txt$
- id: sort-simple-yaml - id: sort-simple-yaml
name: Sort simple YAML files name: Sort simple YAML files
description: Sorts simple YAML files which consist only of top-level keys, preserving comments and blocks.
language: python language: python
entry: sort-simple-yaml entry: sort-simple-yaml
description: Sorts simple YAML files which consist only of top-level keys, preserving comments and blocks.
files: '^$' files: '^$'
- id: trailing-whitespace - id: trailing-whitespace
name: Trim Trailing Whitespace name: Trim trailing whitespace
description: This hook trims trailing whitespace. description: This hook trims trailing whitespace.
entry: trailing-whitespace-fixer entry: trailing-whitespace-fixer
language: python language: python