|
1 | 1 | - id: check-added-large-files |
2 | 2 | name: check for added large files |
3 | | - description: prevent giant files from being committed |
| 3 | + description: prevents giant files from being committed. |
4 | 4 | entry: check-added-large-files |
5 | 5 | language: python |
6 | 6 | - id: check-ast |
7 | 7 | name: check python ast |
8 | | - description: simply check whether the files parse as valid python. |
| 8 | + description: simply checks whether the files parse as valid python. |
9 | 9 | entry: check-ast |
10 | 10 | language: python |
11 | 11 | types: [python] |
12 | 12 | - id: check-byte-order-marker |
13 | 13 | name: 'check BOM - deprecated: use fix-byte-order-marker' |
14 | | - description: forbid files which have a utf-8 byte-order marker |
| 14 | + description: forbids files which have a utf-8 byte-order marker. |
15 | 15 | entry: check-byte-order-marker |
16 | 16 | language: python |
17 | 17 | types: [text] |
18 | 18 | - id: check-builtin-literals |
19 | 19 | name: check builtin type constructor use |
20 | | - description: require literal syntax when initializing empty or zero python builtin types. |
| 20 | + description: requires literal syntax when initializing empty or zero python builtin types. |
21 | 21 | entry: check-builtin-literals |
22 | 22 | language: python |
23 | 23 | types: [python] |
24 | 24 | - id: check-case-conflict |
25 | 25 | name: check for case conflicts |
26 | | - description: check for files that would conflict in case-insensitive filesystems |
| 26 | + description: checks for files that would conflict in case-insensitive filesystems. |
27 | 27 | entry: check-case-conflict |
28 | 28 | language: python |
29 | 29 | - id: check-docstring-first |
|
41 | 41 | stages: [commit, push, manual] |
42 | 42 | - id: check-json |
43 | 43 | name: check json |
44 | | - description: this hook checks json files for parseable syntax. |
| 44 | + description: checks json files for parseable syntax. |
45 | 45 | entry: check-json |
46 | 46 | language: python |
47 | 47 | types: [json] |
|
54 | 54 | stages: [commit, push, manual] |
55 | 55 | - id: pretty-format-json |
56 | 56 | name: pretty format json |
57 | | - description: this hook sets a standard for formatting json files. |
| 57 | + description: sets a standard for formatting json files. |
58 | 58 | entry: pretty-format-json |
59 | 59 | language: python |
60 | 60 | types: [json] |
61 | 61 | - id: check-merge-conflict |
62 | 62 | name: check for merge conflicts |
63 | | - description: check for files that contain merge conflict strings. |
| 63 | + description: checks for files that contain merge conflict strings. |
64 | 64 | entry: check-merge-conflict |
65 | 65 | language: python |
66 | 66 | types: [text] |
|
72 | 72 | types: [symlink] |
73 | 73 | - id: check-toml |
74 | 74 | name: check toml |
75 | | - description: this hook checks toml files for parseable syntax. |
| 75 | + description: checks toml files for parseable syntax. |
76 | 76 | entry: check-toml |
77 | 77 | language: python |
78 | 78 | types: [toml] |
|
84 | 84 | types: [text] |
85 | 85 | - id: check-xml |
86 | 86 | name: check xml |
87 | | - description: this hook checks xml files for parseable syntax. |
| 87 | + description: checks xml files for parseable syntax. |
88 | 88 | entry: check-xml |
89 | 89 | language: python |
90 | 90 | types: [xml] |
91 | 91 | - id: check-yaml |
92 | 92 | name: check yaml |
93 | | - description: this hook checks yaml files for parseable syntax. |
| 93 | + description: checks yaml files for parseable syntax. |
94 | 94 | entry: check-yaml |
95 | 95 | language: python |
96 | 96 | types: [yaml] |
97 | 97 | - id: debug-statements |
98 | 98 | name: debug statements (python) |
99 | | - description: check for debugger imports and py37+ `breakpoint()` calls in python source. |
| 99 | + description: checks for debugger imports and py37+ `breakpoint()` calls in python source. |
100 | 100 | entry: debug-statement-hook |
101 | 101 | language: python |
102 | 102 | types: [python] |
|
108 | 108 | types: [file] |
109 | 109 | - id: detect-aws-credentials |
110 | 110 | name: detect aws credentials |
111 | | - description: detects *your* aws credentials from the aws cli credentials file |
| 111 | + description: detects *your* aws credentials from the aws cli credentials file. |
112 | 112 | entry: detect-aws-credentials |
113 | 113 | language: python |
114 | 114 | types: [text] |
115 | 115 | - id: detect-private-key |
116 | 116 | name: detect private key |
117 | | - description: detects the presence of private keys |
| 117 | + description: detects the presence of private keys. |
118 | 118 | entry: detect-private-key |
119 | 119 | language: python |
120 | 120 | types: [text] |
121 | 121 | - id: double-quote-string-fixer |
122 | 122 | name: fix double quoted strings |
123 | | - description: this hook replaces double quoted strings with single quoted strings |
| 123 | + description: replaces double quoted strings with single quoted strings. |
124 | 124 | entry: double-quote-string-fixer |
125 | 125 | language: python |
126 | 126 | types: [python] |
|
133 | 133 | stages: [commit, push, manual] |
134 | 134 | - id: file-contents-sorter |
135 | 135 | name: file contents sorter |
136 | | - 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. |
| 136 | + 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. |
137 | 137 | entry: file-contents-sorter |
138 | 138 | language: python |
139 | 139 | files: '^$' |
140 | 140 | - id: fix-byte-order-marker |
141 | 141 | name: fix utf-8 byte order marker |
142 | | - description: removes utf-8 byte order marker |
| 142 | + description: removes utf-8 byte order marker. |
143 | 143 | entry: fix-byte-order-marker |
144 | 144 | language: python |
145 | 145 | types: [text] |
146 | 146 | - id: fix-encoding-pragma |
147 | 147 | name: fix python encoding pragma |
| 148 | + description: 'adds # -*- coding: utf-8 -*- to the top of python files.' |
148 | 149 | language: python |
149 | 150 | entry: fix-encoding-pragma |
150 | | - description: 'add # -*- coding: utf-8 -*- to the top of python files' |
151 | 151 | types: [python] |
152 | 152 | - id: forbid-new-submodules |
153 | 153 | name: forbid new submodules |
| 154 | + description: prevents addition of new git submodules. |
154 | 155 | language: python |
155 | 156 | entry: forbid-new-submodules |
156 | | - description: prevent addition of new git submodules |
157 | 157 | types: [directory] |
158 | 158 | - id: mixed-line-ending |
159 | 159 | name: mixed line ending |
160 | | - description: replaces or checks mixed line ending |
| 160 | + description: replaces or checks mixed line ending. |
161 | 161 | entry: mixed-line-ending |
162 | 162 | language: python |
163 | 163 | types: [text] |
164 | 164 | - id: name-tests-test |
165 | 165 | name: tests should end in _test.py |
166 | | - description: this verifies that test files are named correctly |
| 166 | + description: this verifies that test files are named correctly. |
167 | 167 | entry: name-tests-test |
168 | 168 | language: python |
169 | 169 | files: (^|/)tests/.+\.py$ |
|
175 | 175 | always_run: true |
176 | 176 | - id: requirements-txt-fixer |
177 | 177 | name: fix requirements.txt |
178 | | - description: sorts entries in requirements.txt |
| 178 | + description: sorts entries in requirements.txt. |
179 | 179 | entry: requirements-txt-fixer |
180 | 180 | language: python |
181 | 181 | files: requirements.*\.txt$ |
182 | 182 | - id: sort-simple-yaml |
183 | 183 | name: sort simple yaml files |
| 184 | + description: sorts simple yaml files which consist only of top-level keys, preserving comments and blocks. |
184 | 185 | language: python |
185 | 186 | entry: sort-simple-yaml |
186 | | - description: sorts simple yaml files which consist only of top-level keys, preserving comments and blocks. |
187 | 187 | files: '^$' |
188 | 188 | - id: trailing-whitespace |
189 | 189 | name: trim trailing whitespace |
190 | | - description: this hook trims trailing whitespace. |
| 190 | + description: trims trailing whitespace. |
191 | 191 | entry: trailing-whitespace-fixer |
192 | 192 | language: python |
193 | 193 | types: [text] |
|
0 commit comments