From d2a2cde37a56b87dd9edb91b3801b3f0a15153b5 Mon Sep 17 00:00:00 2001 From: Anthony Sottile Date: Mon, 7 Oct 2019 08:33:23 -0700 Subject: [PATCH] Add note about sort-simple-yaml's opt-in behaviour --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1950fa1..584b53d 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,18 @@ Add this to your `.pre-commit-config.yaml` - `--no-sort-keys` - when autofixing, retain the original key ordering (instead of sorting the keys) - `--top-keys comma,separated,keys` - Keys to keep at the top of mappings. - `requirements-txt-fixer` - Sorts entries in requirements.txt and removes incorrect entry for `pkg-resources==0.0.0` -- `sort-simple-yaml` - Sorts simple YAML files which consist only of top-level keys, preserving comments and blocks. +- `sort-simple-yaml` - Sorts simple YAML files which consist only of top-level + keys, preserving comments and blocks. + + Note that `sort-simple-yaml` by default matches no `files` as it enforces a + very specific format. You must opt in to this by setting `files`, for + example: + + ```yaml + - id: sort-simple-yaml + files: ^config/simple/ + ``` + - `trailing-whitespace` - Trims trailing whitespace. - To preserve Markdown [hard linebreaks](https://github.github.com/gfm/#hard-line-break) use `args: [--markdown-linebreak-ext=md]` (or other extensions used