yaml-language-server
Advanced tools
The yaml-language-server npm package provides a language server for YAML files, enabling features like validation, autocompletion, hover information, and more within editors that support the Language Server Protocol (LSP). This enhances the development experience by providing real-time feedback and assistance when working with YAML files.
Validation
This feature validates YAML content against a schema or general YAML syntax rules, providing error messages and warnings for any issues found.
const { validate } = require('yaml-language-server');
const yamlContent = 'key: value';
const validationResults = validate(yamlContent);
console.log(validationResults);Autocompletion
This feature provides autocompletion suggestions based on the current context within the YAML file, helping users to write correct and complete YAML configurations more efficiently.
const { getCompletions } = require('yaml-language-server');
const yamlContent = 'key: ';
const completions = getCompletions(yamlContent, { line: 0, character: 5 });
console.log(completions);Hover Information
This feature provides hover information for YAML keys and values, offering additional context and documentation to help users understand the purpose and usage of different parts of the YAML file.
const { getHover } = require('yaml-language-server');
const yamlContent = 'key: value';
const hoverInfo = getHover(yamlContent, { line: 0, character: 1 });
console.log(hoverInfo);The vscode-yaml extension provides YAML support for Visual Studio Code, including features like validation, autocompletion, and hover information. It is specifically designed for use within the VS Code editor and integrates seamlessly with its ecosystem.
The yaml-lint package is a simple YAML linter that checks for syntax errors in YAML files. While it does not provide the full range of features offered by yaml-language-server, it is useful for quickly identifying and fixing syntax issues.
The yaml-js package is a YAML parser and stringifier for JavaScript. It focuses on parsing and generating YAML content rather than providing language server features like validation and autocompletion.
Supports JSON Schema 7 and below.
The following settings are supported:
yaml.format.enable: Enable/disable default YAML formatter (requires restart)yaml.format.singleQuote: Use single quotes instead of double quotesyaml.format.bracketSpacing: Print spaces between brackets in objectsyaml.format.proseWrap: Always: wrap prose if it exeeds the print width, Never: never wrap the prose, Preserve: wrap prose as-isyaml.format.printWidth: Specify the line length that the printer will wrap onyaml.validate: Enable/disable validation featureyaml.hover: Enable/disable hoveryaml.completion: Enable/disable autocompletionyaml.schemas: Helps you associate schemas with files in a glob patternyaml.schemaStore.enable: When set to true the YAML language server will pull in all available schemas from JSON Schema Storeyaml.customTags: Array of custom tags that the parser will validate against. It has two ways to be used. Either an item in the array is a custom tag such as "!Ref" and it will automatically map !Ref to scalar or you can specify the type of the object !Ref should be e.g. "!Ref sequence". The type of object can be either scalar (for strings and booleans), sequence (for arrays), map (for objects).In order to use the custom tags in your YAML file you need to first specify the custom tags in the setting of your code editor. For example, we can have the following custom tags:
"yaml.customTags": [
"!Scalar-example scalar",
"!Seq-example sequence",
"!Mapping-example mapping"
]
The !Scalar-example would map to a scalar custom tag, the !Seq-example would map to a sequence custom tag, the !Mapping-example would map to a mapping custom tag.
We can then use the newly defined custom tags inside our YAML file:
some_key: !Scalar-example some_value
some_sequence: !Seq-example
- some_seq_key_1: some_seq_value_1
- some_seq_key_2: some_seq_value_2
some_mapping: !Mapping-example
some_mapping_key_1: some_mapping_value_1
some_mapping_key_2: some_mapping_value_2
yaml.schemas applies a schema to a file. In other words, the schema (placed on the left) is applied to the glob pattern on the right. Your schema can be local or online. Your schema path must be relative to the project root and not an absolute path to the schema.
For example: If you have project structure
myProject
> myYamlFile.yaml
you can do
yaml.schemas: {
"https://json.schemastore.org/composer": "/myYamlFile.yaml"
}
and that will associate the composer schema with myYamlFile.yaml.
When associating a schema it should follow the format below
yaml.schemas: {
"url": "globPattern",
"Kubernetes": "globPattern"
}
e.g.
yaml.schemas: {
"https://json.schemastore.org/composer": "/*"
}
e.g.
yaml.schemas: {
"kubernetes": "/myYamlFile.yaml"
}
e.g.
yaml.schemas: {
"https://json.schemastore.org/composer": "/*",
"kubernetes": "/myYamlFile.yaml"
}
You can also use relative paths when working with multi root workspaces.
Suppose you have a multi root workspace that is laid out like:
My_first_project:
test.yaml
my_schema.json
My_second_project:
test2.yaml
my_schema2.json
You must then associate schemas relative to the root of the multi root workspace project.
yaml.schemas: {
"My_first_project/my_schema.json": "test.yaml",
"My_second_project/my_schema2.json": "test2.yaml"
}
yaml.schemas allows you to specify json schemas that you want to validate against the yaml that you write. Kubernetes is an optional field. It does not require a url as the language server will provide that. You just need the keyword kubernetes and a glob pattern.
It is possible to specify a yaml schema using a modeline.
# yaml-language-server: $schema=<urlToTheSchema>
This repository only contains the server implementation. Here are some known clients consuming this server:
cd yaml-language-server
$ yarn install
$ yarn run build
node (Yaml Language Server Location)/out/server/src/server.js [--stdio]
We have included the option to connect to the language server via stdio to help with intergrating the language server into different clients.
0.10.0
# yaml-language-server: $schema=<urlOfTheSchema> #280FAQs
YAML language server
The npm package yaml-language-server receives a total of 143,724 weekly downloads. As such, yaml-language-server popularity was classified as popular.
We found that yaml-language-server demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.