Skip to content

text_editors.rst

Latest commit

 

History

History
68 lines (43 loc) · 1.57 KB

text_editors.rst

File metadata and controls

68 lines (43 loc) · 1.57 KB

Integration with text editors

Most text editors support syntax checking and highlighting, to visually report syntax errors and warnings to the user. yamllint can be used to syntax-check YAML source, but a bit of configuration is required depending on your favorite text editor.

Vim

Assuming that the ALE plugin is installed, yamllint is supported by default. It is automatically enabled when editing YAML files.

If you instead use the syntastic plugin, add this to your .vimrc:

let g:syntastic_yaml_checkers = ['yamllint']

Note that Vim >9.0 includes a so-called "compiler script" for yamllint.

  • Enable the compiler:

    :compiler yamllint

  • Use it on the current buffer:

    :make %

See :help quickfix.

Neovim

Assuming that the neomake plugin is installed, yamllint is supported by default. It is automatically enabled when editing YAML files.

Emacs

If you are flycheck user, you can use flycheck-yamllint integration.

Visual Studio Code

https://marketplace.visualstudio.com/items?itemName=fnando.linter

IntelliJ

https://plugins.jetbrains.com/plugin/15349-yamllint

Other text editors

Help wanted!

Your favorite text editor is not listed here? Help us improve by adding a section (by opening a pull-request or issue on GitHub).