Giter Site home page Giter Site logo

coffeetags's Introduction

CoffeeTags

Latest version: 0.1.3

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

Build Status

Example + Screenshot

Showing only functions (right) or with variables included (left)

<img src="http://img.skitch.com/20111012-8cjesum8ru8usqusra4yppj5cc.preview.png" alt="1. CoffeeTags:1:vim - "unicorn.local" (tmux)" />
Uploaded with Skitch!

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, 1.9.2 or 1.9.3)

Editors supported

Halp!

Just use coffeetags --help

Installation

  • get coffeetags

    gem install CoffeeTags

Vim installation

  • add TagBar config to your .vimrc

coffeetags --vim-conf >> ~/.vimrc

Sublime Text

TODO - I don't use ST myself, but PRs with HOWTO are welcomed

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

CoffeeTags + TagBar + Vim

Config in vimrc

You can add the config to your .vimrc (making sure that the old one is removed) by:

coffeetags --vim-conf >> ~/.vimrc

or (for 2nd mode)

coffeetags --include-vars --vim-conf >> ~/.vimrc

Config as a filetype plugin

You can generate a special filetype plugin and tagbar will use that automatically.

This option is preferable if you want to keep your vimrc short.

coffeetags --vim-conf > ~/.vim/ftplugin/coffee/tagbar-coffee.vim
coffeetags [--include-vars] --vim-conf > ~/.vim/ftplugin/coffee/tagbar-coffee.vim

or if you're using pathogen

coffeetags [--include-vars] --vim-conf > ~/.vim/bundle/coffeetags/ftplugin/coffee/tagbar-coffee.vim
coffeetags --vim-conf > ~/.vim/bundle/coffeetags/ftplugin/coffee/tagbar-coffee.vim
  • open your coffeescript file and open TagBar.

Done!

TODO

  • squash all bugs

License

MIT

Bitdeli Badge

coffeetags's People

Contributors

bitdeli-chef avatar gingerhendrix avatar gonzih avatar louisrli avatar lukaszkorecki avatar rkachowski avatar shirosaki avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.