Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pascalre/vscode-yaml-sort

This VS Code extension exposes the possibility to sort, format and validate yaml files.
https://github.com/pascalre/vscode-yaml-sort

sort visual-studio-code vscode yaml yaml-format yaml-sort yaml-sorting yaml-validator

Last synced: 3 months ago
JSON representation

This VS Code extension exposes the possibility to sort, format and validate yaml files.

Host: GitHub
URL: https://github.com/pascalre/vscode-yaml-sort
Owner: pascalre
License: mit
Created: 2019-04-25T16:19:45.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-10-23T20:18:36.000Z (3 months ago)
Last Synced: 2024-10-24T17:37:24.025Z (3 months ago)
Topics: sort, visual-studio-code, vscode, yaml, yaml-format, yaml-sort, yaml-sorting, yaml-validator
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=PascalReitermann93.vscode-yaml-sort
Size: 5.43 MB
Stars: 41
Watchers: 0
Forks: 3
Open Issues: 44
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# YAML Sort
YAML Sort extends VS Code to sort, format and validate YAML files.

[![Coverage Status](https://coveralls.io/repos/github/pascalre/vscode-yaml-sort/badge.svg?branch=master)](https://coveralls.io/github/pascalre/vscode-yaml-sort?branch=master)
[![GitHub issues open](https://img.shields.io/github/issues/pascalre/vscode-yaml-sort.svg)](https://github.com/pascalre/vscode-yaml-sort/issues)

## Preview
![Preview](images/preview.gif)

# 💬 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 (⇧⌥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
|--------------------
| `emptyLinesUntilLevel`
| `customSortKeywords_1`
| `customSortKeywords_2`
| `customSortKeywords_3`
| `extensions`
| `forceQuotes`
| `indent`
| `lineWidth`
| `locale`
| `noArrayIndent`
| `noCompatMode`
| `notifySuccess`
| `quotingType`
| `schema`
| `sortArrays`
| `sortOnSave`
| `useAsFormatter`
| `useCustomSortRecursively`
| `useLeadingDashes`
| `useArrayProcessor`
| `useBlockProcessor`
| `useCommentProcessor`
| `useHelmProcessor`
| `useOctalProcessor` | Description | Default | --------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| ---------------- | | When bigger than `0`, will add a new line before each keyword on level n. | `0` | | List of keywords for `Custom Sort 1` | `["apiVersion", "kind", "metadata", "spec", "data"]`| | List of keywords for `Custom Sort 2` | - | | List of keywords for `Custom Sort 3` | - | | Extensions to be processed with command `Recursively sort YAML files` | `["yaml", "yml"]` | | When `true`, all non-key strings will be quoted even if they normally don't need to. | `false` | | Indentation width in spaces | `2` | | Maximum line width for YAML files | `500` | | Language whose sort order should be used | `en` | | When `true`, will not add an indentation level to array elements. | `false` | | When `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` | | When `true`, will notify on successfully performed tasks. | `true` | | Strings will be quoted using this quoting style. If you specify single quotes, double quotes will still be used for non-printable characters. | `'` | | Schema to use. Possible values are `HOMEASSISTANT_SCHEMA`, `CLOUDFORMATION_SCHEMA`, `CORE_SCHEMA`, `DEFAULT_SCHEMA`, `FAILSAFE_SCHEMA`, `JSON_SCHEMA`. | `DEFAULT_SCHEMA` | | When `true`, will sort arrays | `false` | | When `0`, will sort files when saving document. When `1`, `2` or `3`, will use customSortKeywords. Set to negative value to disable sortOnSave. Only works in combination with `editor.formatOnSave` set to `true`. | `0` | | When `true`, will enable default YAML formatter (requires restart). | `false` | | When `true`, will use the custom sort keywords recursively on a file, when using custom sort. | `false` | | When `true`, sorted YAML files begin with leading dashes. | `true` | | When `true`, will activate ArrayProcessor. | `true` | | When `true`, will activate BlockProcessor. | `true` | | When `true`, will activate CommentProcessor. | `true` | | When `true`, will activate HelmProcessor. | `true` | | When `true`, will activate OctalProcessor. | `true` |

# ❓ FAQ
## How to sort on save?
Register this extension as VS Code formatter. Also configure VS Code to format files on save. Caution: This setting will apply for all files. Changes will require a restart of VS Code. If you wish to also sort (not only format) the file on saving, set `sortOnSave` to `0`. Use `1`, `2` or `3` for custom sort.

#### **`.vscode/settings.json`**
```json
{
"editor.formatOnSave": true,
"vscode-yaml-sort.sortOnSave": 0
}
```

## What are the processors doing and how do I use them?
There are different types of processors. If you experience any issues with them, or just don't want to use them, you can turn them off.

### ArrayProcessor
The ArrayProcessor will not add linebreaks to single-line array structures.

Original Document
Sorted with
useArrayProcessor: true
Sorted with
useArrayProcessor: false

test: [ "CMD", "pg_isready"]
test: [ "CMD", "pg_isready"]
test: - "CMD" - "pg_isready"

### BlockProcessor
The BlockProcessor will keep block sequences.

Original Document
Sorted with
useBlockProcessor: true
Sorted with
useBlockProcessor: false

hello: |- World
hello: |- World
hello: World

### Comment Processor
An activated Comment Processor will keep comments while sorting.

Original Document
Sorted with
useCommentProcessor: true
Sorted with
useCommentProcessor: false

# comment foo: bar
# comment foo: bar
foo: bar

### Helm Processor
The Helm Processor makes the extension compatible with Helm charts.

Original Document
Sorted with
useHelmProcessor: true
Sorted with
useHelmProcessor: false

foo: {{ .value }}
foo: {{ .value }}
foo: '[object Object]': null

### Spacing Processor
The Spacing Processor will add spacing between keywords.

Original Document
Sorted with
emptyLinesUntilLevel: 0
Sorted with
emptyLinesUntilLevel: 1

foo: bar baz: bar
foo: bar baz: bar
foo: bar baz: bar

### Octal Processor
The Octal Processor makes the extension keeping octal value like 0744.

Original Document
Sorted with
useOctalProcessor: true
Sorted with
useOctalProcessor: false

foo: 0744
foo: 0744
foo: 484

# 🎉 Support

If you like YAML Sort, please feel free to [rate it](https://marketplace.visualstudio.com/items?itemName=PascalReitermann93.vscode-yaml-sort&ssr=false#review-details) on the marketplace.

If you miss something or found a bug, please let me know and [open an issue](https://github.com/pascalre/vscode-yaml-sort/issues/new) on this project on GitHub. Do not hesitate to open a pull request with your changes.

Check [open issues](https://github.com/pascalre/vscode-yaml-sort/issues) on GitHub.

## Known problems

Be careful with anchors and references, these don't work very well in this extension.

# 📝 License

YAML Sort is licensed under the [MIT License](https://raw.githubusercontent.com/pascalre/vscode-yaml-sort/master/LICENSE).