https://github.com/einenlum/yaml-revealer

A vim plugin to easily navigate through Yaml files
https://github.com/einenlum/yaml-revealer

Last synced: about 11 hours ago
JSON representation

A vim plugin to easily navigate through Yaml files

• Host: GitHub
• URL: https://github.com/einenlum/yaml-revealer
• Owner: Einenlum
• License: mit
• Created: 2014-11-08T19:18:16.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-01-03T17:19:36.000Z (almost 3 years ago)
• Last Synced: 2023-08-16T10:26:34.921Z (about 1 year ago)
• Language: Vim script
• Homepage:
• Size: 14.6 KB
• Stars: 60
• Watchers: 3
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.

![demo gif](https://user-images.githubusercontent.com/5675200/40068961-32d58f2a-586a-11e8-8db4-4da212f2f3b1.gif)

## 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](https://github.com/PedroTroller) for his useful help :).

- Thanks to [@ezpuzz](https://github.com/ezpuzz) for improving performance.

- Thanks to [@mosheavni](https://github.com/mosheavni) for adding lists support.