Add an --unsafe option to check-yaml

This commit is contained in:
Anthony Sottile 2018-03-19 09:28:18 -07:00
parent e80813e7e9
commit a21def36e3
3 changed files with 59 additions and 6 deletions

View file

@ -52,6 +52,11 @@ Add this to your `.pre-commit-config.yaml`
- `check-yaml` - Attempts to load all yaml files to verify syntax.
- `--allow-multiple-documents` - allow yaml files which use the
[multi-document syntax](http://www.yaml.org/spec/1.2/spec.html#YAML)
- `--unsafe` - Instaed of loading the files, simply parse them for syntax.
A syntax-only check enables extensions and unsafe constructs which would
otherwise be forbidden. Using this option removes all guarantees of
portability to other yaml implementations.
Implies `--allow-multiple-documents`.
- `debug-statements` - Check for pdb / ipdb / pudb statements in code.
- `detect-aws-credentials` - Checks for the existence of AWS secrets that you
have set up with the AWS CLI.