spacemacs/layers/+lang/yaml
Arif Er 00f9ab19ac chore: update copyright headers to 2022
The script used to identify and update the change is added into the GitHub
workflows script directory. A workflow action can be created to trigger the
script to update the headers on the first of every new year. Possibly a task for
a consequent PR.
2022-06-03 17:32:20 +02:00
..
README.org documentation formatting: Sun Dec 15 21:56:35 UTC 2019 2019-12-15 22:03:17 +00:00
config.el chore: update copyright headers to 2022 2022-06-03 17:32:20 +02:00
layers.el chore: update copyright headers to 2022 2022-06-03 17:32:20 +02:00
packages.el chore: update copyright headers to 2022 2022-06-03 17:32:20 +02:00

README.org

YAML layer

Description

This layer provides support for the YAML file format.

Features:

  • Syntax highlighting
  • Syntax checking via flycheck

Install

Layer

To use this configuration layer, add it to your ~/.spacemacs. You will need to add yaml to the existing dotspacemacs-configuration-layers list in this file.

LSP

To enable LSP, install yaml-language-server:

  npm i -g yaml-language-server

And set the layer variable yaml-enable-lsp to t like shown below:

  (setq-default dotspacemacs-configuration-layers
                '((yaml :variables yaml-enable-lsp t)))

Syntax checking with flycheck

Flycheck checks YAML files with either:

  • yaml-yamllint (requires yamllint)
  • yaml-jsyaml (requires the node-js package js-yaml)
  • or yaml-ruby (requires that ruby is installed on your system)

The flycheck YAML documentation can be found at the flycheck website.