yaml-language-server

What is yaml-language-server?

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.

What are yaml-language-server's main functionalities?

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);

Other packages similar to yaml-language-server

vscode-yaml

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.

yaml-lint

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.

yaml-js

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.

README

YAML Language Server

Supports JSON Schema 7 and below. Starting from 1.0.0 the language server uses eemeli/yaml as the new YAML parser, which strictly enforces the specified YAML spec version. Default YAML spec version is 1.2, it can be changed with yaml.yamlVersion setting.

Features

1. YAML validation:
   • Detects whether the entire file is valid yaml
2. Validation:
   • Detects errors such as:
     • Node is not found
     • Node has an invalid key node type
     • Node has an invalid type
     • Node is not a valid child node
   • Detects warnings such as:
     • Node is an additional property of parent
3. Auto completion:
   • Auto completes on all commands
   • Scalar nodes autocomplete to schema's defaults if they exist
4. Hover support:
   • Hovering over a node shows description if available
5. Document outlining:
   • Shows a complete document outline of all nodes in the document

Language Server Settings

The following settings are supported:

• yaml.yamlVersion: Set default YAML spec version (1.2 or 1.1)
• yaml.format.enable: Enable/disable default YAML formatter (requires restart)
• yaml.format.singleQuote: Use single quotes instead of double quotes
• yaml.format.bracketSpacing: Print spaces between brackets in objects
• yaml.format.proseWrap: Always: wrap prose if it exceeds the print width, Never: never wrap the prose, Preserve: wrap prose as-is
• yaml.format.printWidth: Specify the line length that the printer will wrap on
• yaml.validate: Enable/disable validation feature
• yaml.hover: Enable/disable hover
• yaml.completion: Enable/disable autocompletion
• yaml.schemas: Helps you associate schemas with files in a glob pattern
• yaml.schemaStore.enable: When set to true the YAML language server will pull in all available schemas from JSON Schema Store
• yaml.schemaStore.url: URL of a schema store catalog to use when downloading schemas.
• yaml.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).
• yaml.maxItemsComputed: The maximum number of outline symbols and folding regions computed (limited for performance reasons).
• [yaml].editor.tabSize: the number of spaces to use when autocompleting. Takes priority over editor.tabSize.
• editor.tabSize: the number of spaces to use when autocompleting. Default is 2.
• http.proxy: The URL of the proxy server that will be used when attempting to download a schema. If it is not set or it is undefined no proxy server will be used.
• http.proxyStrictSSL: If true the proxy server certificate should be verified against the list of supplied CAs. Default is false.
• [yaml].editor.formatOnType: Enable/disable on type indent and auto formatting array
• yaml.disableDefaultProperties: Disable adding not required properties with default values into completion text
• yaml.suggest.parentSkeletonSelectedFirst: If true, the user must select some parent skeleton first before autocompletion starts to suggest the rest of the properties.\nWhen yaml object is not empty, autocompletion ignores this setting and returns all properties and skeletons.
• yaml.style.flowMapping : Forbids flow style mappings if set to forbid
• yaml.style.flowSequence : Forbids flow style sequences if set to forbid
• yaml.keyOrdering : Enforces alphabetical ordering of keys in mappings when set to true. Default is false

Adding custom tags

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

Associating a schema to a glob pattern via yaml.schemas:

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.

More examples of schema association:

Using yaml.schemas settings

Single root schema association:

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"
}

On Windows with full path:

yaml.schemas: {
    "C:\\Users\\user\\Documents\\custom_schema.json": "someFilePattern.yaml",
}

On Mac/Linux with full path:

yaml.schemas: {
    "/home/user/custom_schema.json": "someFilePattern.yaml",
}

Since 0.11.0 YAML Schemas can be used for validation:

 "/home/user/custom_schema.yaml": "someFilePattern.yaml"

A schema can be associated with multiple globs using a json array, e.g.

yaml.schemas: {
    "kubernetes": ["filePattern1.yaml", "filePattern2.yaml"]
}

e.g.

"yaml.schemas": {
    "http://json.schemastore.org/composer": ["/*"],
    "file:///home/johnd/some-schema.json": ["some.yaml"],
    "../relative/path/schema.json": ["/config*.yaml"],
    "/Users/johnd/some-schema.json": ["some.yaml"],
}

e.g.

"yaml.schemas": {
    "kubernetes": ["/myYamlFile.yaml"]
}

e.g.

"yaml.schemas": {
    "http://json.schemastore.org/composer": ["/*"],
    "kubernetes": ["/myYamlFile.yaml"]
}

Multi root schema association:

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.

Nested Schema References

Suppose a file is meant to be a component of an existing schema (like a job.yaml file in a circleci orb), but there isn't a standalone schema that you can reference. If there is a nested schema definition for this subcomponent, you can reference it using a url fragment, e.g.:

yaml.schemas: {
    "https://json.schemastore.org/circleciconfig#/definitions/jobs/additionalProperties": "/src/jobs/*.yaml",
}

Note This will require reading your existing schema and understanding the schemastore structure a bit. (TODO: link to a documentation or blog post here?)

Using inlined schema

It is possible to specify a yaml schema using a modeline.

# yaml-language-server: $schema=<urlToTheSchema>

Also it is possible to use relative path in a modeline:

# yaml-language-server: $schema=../relative/path/to/schema

or absolute path:

# yaml-language-server: $schema=/absolute/path/to/schema

Schema priority

The following is the priority of schema association in highest to lowest priority:

1. Modeline
2. CustomSchemaProvider API
3. yaml.settings
4. Schema association notification
5. Schema Store

Containerized Language Server

An image is provided for users who would like to use the YAML language server without having to install dependencies locally.

The image is located at quay.io/redhat-developer/yaml-language-server

To run the image you can use:

docker run -it quay.io/redhat-developer/yaml-language-server:latest

Language Server Protocol version

yaml-language-server use vscode-languageserver@7.0.0 which implements LSP 3.16

Language Server Protocol extensions

SchemaSelectionRequests

SupportSchemaSelection Notification

The support schema selection notification is sent from a client to the server to inform server that client supports JSON Schema selection.

Notification:

• method: 'yaml/supportSchemaSelection'
• params: void

SchemaStoreInitialized Notification

The schema store initialized notification is sent from the server to a client to inform client that server has finished initializing/loading schemas from schema store, and client now can ask for schemas.

Notification:

• method: 'yaml/schema/store/initialized'
• params: void

GetAllSchemas Request

The get all schemas request sent from a client to server to get all known schemas.

Request:

• method: 'yaml/get/all/jsonSchemas';
• params: the document uri, server will mark used schema for document

Response:

• result: JSONSchemaDescriptionExt[]

interface JSONSchemaDescriptionExt {
  /**
   * Schema URI
   */
  uri: string;
  /**
   * Schema name, from schema store
   */
  name?: string;
  /**
   * Schema description, from schema store
   */
  description?: string;
  /**
   * Is schema used for current document
   */
  usedForCurrentFile: boolean;
  /**
   * Is schema from schema store
   */
  fromStore: boolean;
}

GetSchemas Request

The request sent from a client to server to get schemas used for current document. Client can use this method to indicate in UI which schemas used for current YAML document.

Request:

• method: 'yaml/get/jsonSchema';
• params: the document uri to get used schemas

Response:

• result: JSONSchemaDescription[]

interface JSONSchemaDescriptionExt {
  /**
   * Schema URI
   */
  uri: string;
  /**
   * Schema name, from schema store
   */
  name?: string;
  /**
   * Schema description, from schema store
   */
  description?: string;
}

Clients

This repository only contains the server implementation. Here are some known clients consuming this server:

• Eclipse Che
• vscode-yaml for VSCode
• coc-yaml for coc.nvim
• Eclipse Wild Web Developer for Eclipse IDE
• lsp-mode for Emacs
• vim-lsp for Vim
• LSP-yaml for Sublime Text
• monaco-yaml for Monaco editor
• Vim-EasyComplete for Vim/NeoVim
• nova-yaml for Nova
• volar-service-yaml for Volar

Developer Support

Getting started

1. Install prerequisites:
   • latest Visual Studio Code
   • Node.js v12.0.0 or higher
2. Fork and clone this repository
3. Install the dependencies

   cd yaml-language-server
   $ yarn install
   

4. Build the language server

   $ yarn run build
   

5. The new built server is now located in ./out/server/src/server.js.

   node (Yaml Language Server Location)/out/server/src/server.js [--stdio]
   

Connecting to the language server via stdio

We have included the option to connect to the language server via stdio to help with integrating the language server into different clients.

ESM and UMD Modules

Building the YAML Language Server produces CommonJS modules in the /out/server/src directory. In addition, a build also produces UMD (Universal Module Definition) modules and ES Modules (ESM) in the /lib directory. That gives you choices in using the YAML Language Server with different module loaders on the server side and in the browser with bundlers like webpack.

CI

We use a GitHub Action to publish each change in the main branch to npm registry with the next tag. You may use the next version to adopt the latest changes into your project.

Changelog

1.15.0

• Fix: some small type issues #918
• Add: volar-service-yaml to clients #920
• Fix: Remove ide-yaml from known clients #921
• Fix: schema loading performance #923
• Fix: undefined error in mergingResult.problemArgs #924
• Add: unify string insert text for array and property #934
• Add: Improve some special cases for selection ranges #939
• Fix: show all enums on hover #942
• Fix: update README syntax highlighting #945
• Fix: render examples as yaml on hover #947
• Fix: snippets in additionalProperties #951
• Fix: crash when url is undefined #954
• Fix: Add null check for customTags #955

Thanks to Remco Haszing, Petr Spacek, Tony, Gustav Eikaas, Skip Baney and Pierre Prinetti for your contributions.