sponsor Vim development Vim logo Vim Book Ad

vim-indexer : Vim plugin that provides async tags generation with project management.

 script karma  Rating 13/8, Downloaded by 559  Comments, bugs, improvements  Vim wiki

created by
script type
# Indexer

Vim Indexer plugin that provides async tags generation with project management.

Usage: `:Indexer [module] [action] [params ...]`

Install this plugin and everything will be DONE!

Use <kbd>CTRL-]</kbd> to jump anywhere.

## Options

    " Project root folders, used to identify ancestor path of project root directory.
    let g:indexer_root_folders = [$HOME]

    " Project root markers, used to identify project root directory.
    let g:indexer_root_markers = ['.git']

    " JSON formatted configuration file which located in the project root directory,
    " makes you could specify different options for each project.
    let g:indexer_root_setting = 'indexer.json'

    " Enabled user modules.
    let g:indexer_user_modules = ['log', 'tag']

## Modules

### log
Module that provides logging, usually used for debugging modules themselves.

Usage: `:Indexer log`

### tag
Module that provides painless transparent tags generation (Vim8 with +job feature required).

Usage: `:Indexer tag [locate|reload|status|update]`

## Options (module)

    " Module: log
    let g:indexer_logs_maxsize = 100

    " Module: tag
    " This module can also read the configuration of the current project.
    " For example you can have a JSON formatted file in the project directory:
    " > indexer.json:
    " {
    "    "tags_watches": ["*.php"],
    "    "tags_command": "ctags",
    "    "tags_options": "-R --sort=yes --languages=php",
    "    "tags_savedir": "~/.vim_indexer_tags/",
    "    "tags_handler_locate": ["locate"],
    "    "tags_handler_reload": ["reload", "-1"],
    "    "tags_handler_update": ["update"],
    " }
    " And/Or settings in global:
    let g:indexer_tags_watches = ["*.c", "*.h", "*.c++", "*.cpp", "*.php", "*.py"]
    let g:indexer_tags_command = "ctags"
    let g:indexer_tags_options = "-R --sort=yes --c++-kinds=+p+l --fields=+iaS --extra=+q --languages=c,c++,php,python"
    let g:indexer_tags_savedir = "~/.vim_indexer_tags/"
    let g:indexer_tags_handler_locate = ["locate"]
    let g:indexer_tags_handler_reload = ["reload", "-1"]
    let g:indexer_tags_handler_update = ["update"]

install details
Just put the files into ~/.vim/ or <HOMEDIR>\vimfiles\ (for Windows).

Use plugin installer:

  Plugin 'alvan/vim-indexer'

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
vim-indexer-master.zip 0.9.3 2019-04-05 8.0 A L update version
ip used for rating:

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.