README.md

Vista.vim

View and search LSP symbols, tags in Vim/NeoVim.

⚠️Currently vista.vim is mostly usable, yet not stable. All the public APIs and global options can be changed or even be removed in the future.

• Introduction
• Features
• Requirement
• Installation
  • Plugin Manager
  • Package management
    • Vim 8
    • NeoVim
• Usage
  • Commands
  • Options
• Contributing
• License

Introduction

I initially started vista.vim with an intention of replacing tagbar as it seemingly doesn't have a plan to support the promising Language Server Protocol and async processing.

In terms of viewer for ctags-generated tags, vista.vim is sort of the poor version of tagbar, for some details has not been worked out. Nonetheless, it's more than a tags viewer.

Vista.vim can also be a symbol navigator similar to ctrlp-funky. Last but not least, one important goal of vista.vim is to support LSP symbols, which understands the semantics instead of the regex only.

Features

• View tags and LSP symbols in a sidebar.
  • ctags
  • coc.nvim
  • vim-lsp
  • LanguageClient-neovim
• Finder for tags and LSP symbols.
  • fzf
• Display decent detailed symbol info in cmdline.
• Jump to the tag/symbol from vista sidebar with a blink.
• Update automatically when switching between buffers.
• Update asynchonously in the background when +job avaliable.
• Supports all of the languages that ctags does.
• Highlight current tag/symbol.
• Show the visibility (public/private) of tags.
• Tree viewer for hierarchy data.

Notes:

• The feature of finder in vista.vim :Vista finder [EXECUTIVE] is a bit like :BTags or :Tags in fzf.vim, :CocList in coc.nvim, :LeaderfBufTag in leaderf.vim, etc. You can choose whichever you like.

• I personally don't use all the features I have listed. Hence some of them may be on the TODOs forever :(.

Requirement

I don't know the mimimal supported version. But if you only care about the ctags related feature, vim 7.4+ should be enough.

Otherwise, if you want to try any LSP related features, then you certainly need some plugins to retrive the LSP symbols, e.g., coc.nvim. When you have these LSP plugins set up, vista.vim should be ok to go as well.

In addition, if you want to search the symbols via fzf, you will have to install it first.

Installation

Plugin Manager

• vim-plug

  Plug 'liuchengxu/vista.vim'

For other plugin managers please follow their instructions accordingly.

Package management

Vim 8

$ mkdir -p ~/.vim/pack/git-plugins/start
$ git clone https://github.com/liuchengxu/vista.vim.git --depth=1 ~/.vim/pack/git-plugins/start/vista.vim

NeoVim

$ mkdir -p ~/.local/share/nvim/site/pack/git-plugins/start
$ git clone https://github.com/liuchengxu/vista.vim.git --depth=1 ~/.local/share/nvim/site/pack/git-plugins/start/vista.vim

Usage

The following instructions are not complete, please see help via :help vista for more detailed usage.

Commands

:Vista [EXECUTIVE]: open vista window for ctags/coc.

:Vista finder [EXECUTIVE]: search tags/symbols generated from ctags/coc.

Options

" Position to open the vista sidebar. On the right by default.
" Change to 'vertical topleft' to open on the left.
let g:vista_sidebar_position = 'vertical botright'

" Width of vista sidebar.
let g:vista_sidebar_width = 30

" Set this flag to 0 to disable echoing when the cursor moves.
let g:vista_echo_cursor = 1

" Time delay for showing detailed symbol info at current cursor.
let g:vista_cursor_delay = 400

" Close the vista window automatically close when you jump to a symbol.
let g:vista_close_on_jump = 0

" Move to the vista window when it is opened.
let g:vista_stay_on_open = 1

" Blinking cursor 2 times with 100ms interval after jumping to the tag.
let g:vista_blink = [2, 100]

" How each level is indented and what to prepend.
" This could make the display more compact or more spacious.
" e.g., more compact: ["▸ ", ""]
let g:vista_icon_indent = ["╰─▸ ", "├─▸ "]

" Executive used when opening vista sidebar without specifying it.
" Avaliable: 'coc', 'ctags'. 'ctags' by default.
let g:vista_default_executive = 'ctags'

" Declare the command including the executable and options used to generate ctags output
" for some certain filetypes.The file path will be appened to your custom command.
" For example:
let g:vista_ctags_cmd = {
      \ 'haskell': 'hasktags -o - -c',
      \ }

" To enable fzf's preview window set g:vista_fzf_preview.
" The elements of g:vista_fzf_preview will be passed as arguments to fzf#vim#with_preview()
" For example:
let g:vista_fzf_preview = ['right:50%']

" Fall back to other executives if the specified one gives empty data.
" By default it's all the provided executives excluding the tried one.
" let g:vista_finder_alternative_executives = ['coc']

Contributing

Vista.vim is still in beta, please file an issue if you run into any trouble or have any sugguestions.

License

MIT

Copyright (c) 2019 Liu-Cheng Xu