Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hilleer/vscode-yaml-plus-json
Vscode extension making conversion between yaml and json fast and simple
https://github.com/hilleer/vscode-yaml-plus-json
conversion json json-converter yaml yaml-convertor yml
Last synced: 4 days ago
JSON representation
Vscode extension making conversion between yaml and json fast and simple
- Host: GitHub
- URL: https://github.com/hilleer/vscode-yaml-plus-json
- Owner: hilleer
- License: mit
- Created: 2020-02-04T15:32:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T11:44:10.000Z (10 days ago)
- Last Synced: 2024-09-25T15:35:45.015Z (8 days ago)
- Topics: conversion, json, json-converter, yaml, yaml-convertor, yml
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=hilleer.yaml-plus-json
- Size: 1000 KB
- Stars: 23
- Watchers: 2
- Forks: 4
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# YAML :heart: JSON
[](https://github.com/hilleer/vscode-yaml-plus-json/actions/workflows/github-code-scanning/codeql)
[](https://github.com/hilleer/vscode-yaml-plus-json/actions/workflows/ci.yaml)
Easily convert YAML to JSON or vice versa. Conversion can be done by each individual file or by all files in a folder.
Any good ideas or feature requests? Please, do not hesitate to open [a new issue](https://github.com/hilleer/vscode-yaml-plus-json/issues/new)!
## Features and usage
* **Convert a single file:**
* Convert a YAML file to JSON by right clicking it and selecting `Convert to JSON`.
* Convert a YAML file to JSON by changing file extension to `.json`.
* Convert a JSON file to YAML by right clicking it and selecting `Convert to YAML`.
* Convert a JSON file to YAML by changing file extension to `.yaml` or `.yml`.
* **Convert selection as preview:**
* Convert YAML selection as preview by using command `YAML+JSON: Preview as JSON (from YAML. Opens in new file)`
* Convert JSON selection as preview by using command `YAML+JSON: Preview as YAML (from JSON. Opens in new file)`
* **Convert text selection:**
* Convert YAML selection by using command `Convert selection to JSON` - _does not_ change file extension.
* Convert JSON selection by using command `Convert selection to YAML` - _does not_ change file extension.
* **Converting multiple files:**
* Convert a selection of JSON files to YAML by right clicking one of the selected files and selecting `Convert selected files to YAML`.
* Convert a selection of YAML files to JSON by right clicking one of the selected files and selecting `Convert selected files to JSON`.
* Convert YAML files in a directory to JSON by right clicking the directory and selecting `Convert YAML files to JSON`.
* Convert JSON files in a directory to YAML by right clicking the directory and selecting `Convert JSON files to YAML`.
* Reverting converted files: When a file has been reverted, a _"revert"_ prompt will be shown to revert it. Using this will return the entirety of the original file, including YAML comments.
* Overwriting existent files: When trying to convert a file into a destination that already exist, you can use the `overwriteExistentFiles` configuration to overwrite such. **Notice** if you use the revert feature after overwriting a file, the extension cannot (currently) revert the overwritten file. Also, due to limitation in vscode of active user prompts, if you set it to `"ask"` you will only be prompted to overwrite N number of files, while others will be skipped.
## Config
All configurations should be defined in `yaml-plus-json` in vscode settings (e.g. `.vscode/settings.json`), like:
```json
{
"yaml-plus-json": {
"convertOnRename": true,
"yamlIndent": 2,
"fileExtensions": {
"yaml": ".yaml",
"json": ".json"
}
}
}
```
| id | description | type | default | example |
|--------------------------|---------------------------------------------------------------------------------------------------------------------------|---------|-----------|------------|
| `convertOnRename` | Convert YAML/JSON files on rename | boolean | `true` | `false` |
| `yamlIndent` | The number of spaces to use when indenting code (yaml) | number | `2` | `4` |
| `yamlSchema` | See [yaml module documentation](https://github.com/eemeli/yaml/blob/master/docs/03_options.md#schema-options) for details | string | `"core"` | `"json"` |
| `fileExtensions` | define what filename extension(s) to use when converting file(s) | object | | |
| `fileExtensions.yaml` | yaml filename extension | string | `".yaml"` | `".yml"` |
| `fileExtensions.json` | json filename extension | string | `".json"` | `".json"` |
| `keepOriginalFiles` | Keep original files when converting. Use `"ask"` to be asked every time or `"always"` to always keep original files | string | | `"always"` |
| `overwriteExistentFiles` | Overwrite existent files when converting. Use `"ask"` to be asked every time or `"always"` to always overwrite | string | | `"always"` |
---
[](https://www.buymeacoffee.com/hilleer)