2016-01-21 14:48:57 -06:00
|
|
|
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
|
|
|
|
|
---
|
|
|
|
|
|
2017-02-28 03:29:08 -06:00
|
|
|
Assuming that the `ALE <https://github.com/w0rp/ale>`_ plugin is
|
|
|
|
|
installed, yamllint is supported by default. It is automatically enabled when
|
|
|
|
|
editing YAML files.
|
|
|
|
|
|
|
|
|
|
If you instead use the `syntastic <https://github.com/scrooloose/syntastic>`_
|
|
|
|
|
plugin, add this to your ``.vimrc``:
|
2016-01-21 14:48:57 -06:00
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
2016-01-26 10:20:22 -06:00
|
|
|
let g:syntastic_yaml_checkers = ['yamllint']
|
2016-01-21 14:48:57 -06:00
|
|
|
|
|
|
|
|
Neovim
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
Assuming that the `neomake <https://github.com/benekastah/neomake>`_ plugin is
|
2016-03-10 01:59:31 -06:00
|
|
|
installed, yamllint is supported by default. It is automatically enabled when
|
|
|
|
|
editing YAML files.
|
2016-01-21 14:48:57 -06:00
|
|
|
|
2017-03-25 12:53:09 -05:00
|
|
|
Emacs
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
If you are `flycheck <https://github.com/flycheck/flycheck>`_ user, you can use
|
|
|
|
|
`flycheck-yamllint <https://github.com/krzysztof-magosa/flycheck-yamllint>`_ integration.
|
|
|
|
|
|
2016-01-21 14:48:57 -06:00
|
|
|
Other text editors
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
.. rubric:: 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).
|
