mirror of
https://github.com/pre-commit/pre-commit-hooks.git
synced 2026-04-06 20:16:53 +00:00
Update readme.
This commit is contained in:
parent
a751eb58f9
commit
24609dea4a
2 changed files with 31 additions and 2 deletions
|
|
@ -1,5 +1,5 @@
|
||||||
- repo: git@github.com:pre-commit/pre-commit-hooks
|
- repo: git@github.com:pre-commit/pre-commit-hooks
|
||||||
sha: 7c003425b35fff516c0ee88f4040c8c208d474bd
|
sha: a751eb58f91d8fa70e8b87c9c95777c5a743a932
|
||||||
hooks:
|
hooks:
|
||||||
- id: trailing-whitespace
|
- id: trailing-whitespace
|
||||||
- id: end-of-file-fixer
|
- id: end-of-file-fixer
|
||||||
|
|
@ -8,7 +8,7 @@
|
||||||
- id: name-tests-test
|
- id: name-tests-test
|
||||||
- id: flake8
|
- id: flake8
|
||||||
- repo: git@github.com:pre-commit/pre-commit
|
- repo: git@github.com:pre-commit/pre-commit
|
||||||
sha: 96174deac671b451ee2a3fbdc647ad9606415e15
|
sha: bcb1283267c0a041c77150a80a58f1bc2a3252d6
|
||||||
hooks:
|
hooks:
|
||||||
- id: validate_config
|
- id: validate_config
|
||||||
- id: validate_manifest
|
- id: validate_manifest
|
||||||
|
|
|
||||||
29
README.md
29
README.md
|
|
@ -7,3 +7,32 @@ pre-commit-hooks
|
||||||
Some out-of-the-box hooks for pre-commit.
|
Some out-of-the-box hooks for pre-commit.
|
||||||
|
|
||||||
See also: https://github.com/pre-commit/pre-commit
|
See also: https://github.com/pre-commit/pre-commit
|
||||||
|
|
||||||
|
|
||||||
|
### Using pre-commit-hooks with pre-commit
|
||||||
|
|
||||||
|
Add this to your `.pre-commit-config.yaml`
|
||||||
|
|
||||||
|
- repo: git://github.com/pre-commit/pre-commit-hooks
|
||||||
|
sha: '' # Use the sha you want to point at
|
||||||
|
hooks:
|
||||||
|
- id: trailing-whitespace
|
||||||
|
# - id: ...
|
||||||
|
|
||||||
|
|
||||||
|
### Hooks available
|
||||||
|
|
||||||
|
- `check-yaml` - Attempts to load all yaml files to verify syntax.
|
||||||
|
- `debug-statements` - Check for pdb / ipdb / pudb statements in code.
|
||||||
|
- `end-of-file-fixer` - Makes sure files end in a newline and only a newline.
|
||||||
|
- `flake8` - Run flake8 on your python files
|
||||||
|
- `name-tests-test` - Assert that files in tests/ end in _test.py
|
||||||
|
- `pyflakes` - Run pyflakes on your python files
|
||||||
|
- `trailing-whitespace` - Trims trailing whitespace.
|
||||||
|
|
||||||
|
### As a standalone package
|
||||||
|
|
||||||
|
If you'd like to use these hooks, they're also available as a standalone
|
||||||
|
package.
|
||||||
|
|
||||||
|
Simply `pip install pre-commit-hooks`
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue