YAML Sort
This VS Code extension exposes the possibility to sort, format and validate YAML files.
Preview
Commands
This extension contributes the following commands:
| Command |
Description |
Custom Sort 1 |
This command will sort a given YAML with custom order. If some of the keys of customSortKeywords_1 will be found at the top level of the YAML, these will be put at the beginning of the YAML file (in the given order). You can use this e. g. to sort Kubernetes configmaps. |
Custom Sort 2 |
Same as Custom Sort 1 |
Custom Sort 3 |
Same as Custom Sort 1 |
Format Document |
Formats a yaml document without sorting it. Also possible using the shortcut (e. g. SHIFT + OPTION + F on Mac). |
Recursively sort YAML files |
Sorts all .yaml and .yml files in a directory and all its subdirectories |
Sort YAML |
Sorts a given YAML. You can either sort the whole YAML document or sort only a selection of the text. |
Validate YAML |
Validates a given YAML. |
Configuration
This extension contributes the following settings:
| Setting |
Description |
Default |
emptyLinesUntilLevel |
When bigger than 0, will add a new line before each keyword on level n. |
0 |
customSortKeywords_1 |
List of keywords for Custom Sort 1 |
["apiVersion", "kind", "metadata", "spec", "data"] |
customSortKeywords_2 |
List of keywords for Custom Sort 2 |
- |
customSortKeywords_3 |
List of keywords for Custom Sort 3 |
- |
forceQuotes |
When true, all non-key strings will be quoted even if they normally don't need to. |
false |
indent |
Indentation width in spaces |
2 |
lineWidth |
Maximum line width for YAML files |
500 |
locale |
Language whose sort order should be used |
en |
noArrayIndent |
When true, will not add an indentation level to array elements |
false |
noCompatMode |
if true don't try to be compatible with older yaml versions. Currently: don't quote "yes", "no" and so on, as required for YAML 1.1 |
false |
quotingType |
Strings will be quoted using this quoting style. If you specify single quotes, double quotes will still be used for non-printable characters. |
' |
schema |
Schema to use |
DEFAULT_SCHEMA |
useCustomSortRecursively |
When true, will use the custom sort keywords recursively on a file, when using custom sort |
false |
useLeadingDashes |
When true, sorted YAML files begin with leading dashes |
true |
Enjoy!
If you like this extension, please feel free to rate it on the marketplace.
Issues
If you miss something or found a bug, please let me know and open an issue on this project on GitHub. I am very happy about every issue which makes this project better. Do not hesitate to open a pull request with your changes.
Check open issues on GitHub.
Known problems
Be careful with anchors and references, these don't work very well in this extension.
Donation
I am working as a full time server administrator and developer. Besides my job I have a kid and a wife which stresses me, when I am coding after my regular work - for free. Since this is an open source project, some issues can stay untouched for weeks or months. Even though I try to work on every issue as soon as possible.
For developing this extension I really do not charge anything. If you would like to support my work or want to give your issue a small boost feel free to donate any amount through PayPal or Bitcoin.
| PayPal |
Bitcoin |
 |
3GtecXv9MWcQcp3uLZg4s35iiSj5knCNZn |
