Skip to content

YAML language support, including JSON Schema validation, for Visual Studio Code

License

Notifications You must be signed in to change notification settings

adamvoss/vscode-yaml

Repository files navigation

YAML for Visual Studio Code

Features

  • JSON Schema validation
  • Quick Navigation (Ctrl + Shift + O)
  • Document formatting
  • Hover data descriptions (when provided by active schemas)

How to associate schemas

Schemas are handled exactly same way they are with JSON in Visual Studio Code and your schema file must still be written in JSON. This means you can:

Known Issues

  • No support has been implemented for include references. (relevant code)
  • Formatter strips comments and --- yaml marker. see issues/#9
  • Formatter renames anchors/references in the style &ref12/*ref12

Acknowledgments

This extension would not have been possible without numerous open source projects. Please see ACKNOWLEDGMENTS.md.

Contributing

Contributions are welcome! To install dependencies and begin work, run:

npm install

This was forked from https://github.com/Microsoft/vscode/tree/master/extensions/json, to prepare the latest commits from upstream, use:

git clone https://github.com/Microsoft/vscode.git
cd vscode
git checkout -b vscode-json
git filter-branch --prune-empty --subdirectory-filter extensions/json/ vscode-json