Skip to content
Ctags-like tag generator for CoffeeScript
Ruby VimL Shell
Latest commit 380b9d5 Apr 12, 2016 @BabbaFresh BabbaFresh committed with Add support for NeoVim (#57)
* Add support for NeoVim

Simply added another check to `!has("ruby")` which reads `!has("nvim")`.
NeoVim comes with ruby support by default, so it should be no problem to assume
that ruby is available.

* Add NeoVim support to README

* Change NeoVim support in README 

Removed separate section about NeoVim support and instead added it to the supported editors section (as requested by the package maintainer Lukasz).
Failed to load latest commit information.
bin
lib
plugin
script
spec
.coveralls.yml Initial coveralls setup Aug 15, 2014
.gitignore
.rspec
.rvmrc
.travis.yml
CoffeeTags.gemspec
Gemfile
Guardfile
README.md
Rakefile
tagbar-info.markdown
test.rb

README.md

CoffeeTags

Latest version: Gem version

A simple tool for generating CoffeeScript tags (Ctags compatible).

Build Status Coverage Status

Watch a quick demo

Huh?

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)

Requirements

  • ruby 1.8.7 and up

Windows support

Yup, we got it!

Editors supported

Halp!

Just use coffeetags --help

Ruby Gem

Installation

gem install CoffeeTags (or sudo gem install CoffeeTags)

Usage

$ coffeetags --help

Vim

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:

Install

  • 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 ~/.vim directory

Configuration

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])

Sublime Text

See this issue on SublimeText/Ctags

Config types

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-vars to command line arguments
  • Setting let g:CoffeeAutoTagIncludeVars=1 in your ~/.vimrc for vim

TODO

  • squash all bugs

License

MIT

Bitdeli Badge

Something went wrong with that request. Please try again.