A simple tool for generating CoffeeScript tags (Ctags compatible).
CoffeeTags was created for use with Vim and TagBar plugin, however it accepts most common ctags arguments, therefore the following:
coffeetags -R -f TAGS
will generate standard TAGS file which later can be used with Vim (standard :tag command works as expected)
- ruby 1.8.7 and up
- NeoVim with TagBar
- Vim with TagBar
- Sublime Text and CTags plugin
Just use coffeetags --help
gem install CoffeeTags (or sudo gem install CoffeeTags)
$ coffeetags --help
This can also be used as a vim plugin that will update tag files on save, and support visualization with TagBar. You will still need to install the gem as described above as well as install the plugin to vim. You can install it via:
- Pathogen
git clone https://github.com/lukaszkorecki/CoffeeTags ~/.vim/bundle/CoffeeTags- NeoBundle
NeoBundle 'lukaszkorecki/CoffeeTags'- Vundle
Bundle 'lukaszkorecki/CoffeeTags'- manual
- copy all of the files into your
~/.vimdirectory
In you ~/.vimrc you can configure the plugin with:
let g:CoffeeAutoTagDisabled=<0 or 1> " Disables autotaging on save (Default: 0 [false])
let g:CoffeeAutoTagFile=<filename> " Name of the generated tag file (Default: ./tags)
let g:CoffeeAutoTagIncludeVars=<0 or 1> " Includes variables (Default: 0 [false])
let g:CoffeeAutoTagTagRelative=<0 or 1> " Sets file names to the relative path from the tag file location to the tag file location (Default: 1 [true])
See this issue on SublimeText/Ctags
CoffeeTags can work in 2 modes:
- tags only for functions (default)
- tags for functions and objects containing them
Second mode is activated by:
- Adding
--include-varsto command line arguments - Setting
let g:CoffeeAutoTagIncludeVars=1in your~/.vimrcfor vim
- squash all bugs
MIT
