Yaml Revealer

Yaml Revealer is a vim plugin which allows you to handle the full tree structure of a Yaml key.

If you often use Yaml files, you know they are very readable at the beginning, but also that they can become a bit harder to read when becoming longer and longer… Yaml Revealer is here to guide you when you're lost.

Features

Reveal the full tree structure of a key

myRoot:
    firstChild:
        myVar: "foo"
    secondChild:
        myVar:
           foo: "foo"
        myVar2:
           foo: "foo"
           bar: "bar"
>          specialKey: "Hi"

Moving to the indicated line will automatically make vim echo

myRoot > secondChild > myVar2

Search for a specific key

Typing :call SearchYamlKey() will display a prompt to search a specific key.

Search for a Yaml key:

Searching for

myVar2>specialKey

or

myvar2 > specialKey

will find the concerned line.

Requirements

This plugin requires vim version superior to 8.0.1630 or neovim.

Configuration

• You can configure the separator between the keys by setting the variable g:yaml_revealer_separator. Default is >

• By default, a list indicator ([]) is added to the path. This can be removed by setting g:yaml_revealer_list_indicator to 0

Installation

Vundle Installation

Add Plugin 'Einenlum/yaml-revealer' to your .vimrc, reload your config and run a Plugin:Install.

vim-plug Installation

Add Plug 'Einenlum/yaml-revealer' to your .vimrc, reload your config and run a :PlugInstall.

Credits

• Thanks to @PedroTroller for his useful help :).
• Thanks to @ezpuzz for improving performance.
• Thanks to @mosheavni for adding lists support.