Merge pull request #673 from revolter/fix/inconsistent-descriptions

Fix inconsistent descriptions
This commit is contained in:
Anthony Sottile 2021-10-20 07:06:54 -07:00 committed by GitHub
commit 8559bc5936
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,29 +1,29 @@
- 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: prevents 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 checks 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: forbids 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]
- id: check-builtin-literals - id: check-builtin-literals
name: check builtin type constructor use name: check builtin type constructor use
description: require literal syntax when initializing empty or zero python builtin types. description: requires literal syntax when initializing empty or zero python builtin types.
entry: check-builtin-literals entry: check-builtin-literals
language: python language: python
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: checks 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: checks json files for parseable syntax.
entry: check-json entry: check-json
language: python language: python
types: [json] types: [json]
@ -54,13 +54,13 @@
stages: [commit, push, manual] stages: [commit, push, manual]
- id: pretty-format-json - id: pretty-format-json
name: pretty format json name: pretty format json
description: this hook sets a standard for formatting json files. description: sets a standard for formatting json files.
entry: pretty-format-json entry: pretty-format-json
language: python language: python
types: [json] types: [json]
- id: check-merge-conflict - id: check-merge-conflict
name: check for merge conflicts name: check for merge conflicts
description: check for files that contain merge conflict strings. description: checks for files that contain merge conflict strings.
entry: check-merge-conflict entry: check-merge-conflict
language: python language: python
types: [text] types: [text]
@ -72,7 +72,7 @@
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: checks toml files for parseable syntax.
entry: check-toml entry: check-toml
language: python language: python
types: [toml] types: [toml]
@ -84,19 +84,19 @@
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: 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: 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: checks 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]
@ -108,19 +108,19 @@
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: 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]
@ -133,37 +133,37 @@
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: sorts 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: 'adds # -*- 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: prevents addition of new git submodules.
language: python language: python
entry: forbid-new-submodules entry: forbid-new-submodules
description: prevent addition of new git submodules
types: [directory] types: [directory]
- 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$
@ -175,19 +175,19 @@
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: trims trailing whitespace.
entry: trailing-whitespace-fixer entry: trailing-whitespace-fixer
language: python language: python
types: [text] types: [text]