Description

Pivotal ctags-tmbundle is a fork of tm-ctags-tmbundle.

It re-assigns the keyboard shortcuts, polishes the help/readme documentation, and (aims to) augment tagging to better suit the needs of developers at Pivotal Labs.

Getting Started

To start with, you'll want to run the Update Project Tags command for your project. This will generate a .tmtags configuration file for your project.

Also, be sure you have ctags installed. Exuberant Ctags is recommended (there's a MacPort, if you like).

Commands

All commands in the bundle only work within a project or directory open in TextMate. Note: when running the bundle's "Help" in TextMate, the 'shortcuts' herein will display the current keyboard shortcuts associated with the command.

• "Complete Tag (tooltip)"
  shortcut: #{SHORTCUT[Complete Tag (tooltip)]}
  In a tooltip, provides completion suggestions for the current fragment.
  
• "Complete Tag (modal)"
  shortcut: #{SHORTCUT[Complete Tag (modal)]}
  In a modal window, provides completion suggestions for the current fragment.
  
• "Jump to Tag (current)":
  shortcut: #{SHORTCUT[Jump to Tag (current)]}
  Jumps to the file and line where the tag under the cursor is declared.

• "Jump to Tag...":
  shortcut: #{SHORTCUT[Jump to Tag...]}
  Prompts for a tag (or the start of a tag) and jumps to the file and line where that tag is declared.

  ---

• "Update Project Tags":
  shortcut: #{SHORTCUT[Update Project Tags]}
  Builds/rebuilds the .tmtags file in the root directory of your project. This is a prerequisite for any of the other Ctags commands and needs to be periodically re-run as your project changes.

  ---

• Help
  shortcut: #{SHORTCUT[Help]}
  Displays this help/readme.

• Update Bundle
  shortcut: #{SHORTCUT[Update Bundle]}
  Updates the bundle from the source repository and reloads it in TextMate.

Environment Variables

• TM_CTAGS_EXCLUDES
  A space-delimited list of files or directories you do not want tagged. Shell wildcards work (.git, .svn, and .cvs are already excluded).
• TM_CTAGS_INCLUDES
  A space-delimited list of files you do want tagged. These take extended regex format (i.e., .*\\\\.rb). Excludes are ignored if you use includes.
• TM_CTAGS_OPTIONS
  Have your own ctags configuration? Save it to a file and point this variable at it (maps to --options). Excludes and includes are ignored if you specify your own options. There are a few options required for proper bundle functionality which will be added to the argument list you provide.
• TM_CTAGS_EXTRA_LIB
  Used to load the tags defined in .tmtags for another project by referencing the root of that project.

Credits

• Selah Ben-Haim for the original bundle.
• Sean Farley for the TM_CTAGS_EXTRA_LIB addition.