The lushtags package

[Tags:mit, program]
Create ctags compatible tags files for Haskell programs

Similar programs are [hasktags][1], [gasbag][2], [hothasktags][3], and GHC's
builtin ctags generation.

lushtags differs from these by being designed to have smooth integration with
the [Vim Tagbar][4] plugin.

Tagbar is nice because it deals with creating tags automatically. There is no
need to manually run commands or keep track of tag files. Just open any Haskell
file in Vim and the Tagbar window will instantly show an interactive browsable
list of all the functions and declarations in the file. This window also
updates automatically as you edit the file.

The tags created by lushtags are marked with several extensions, so that when
used with Tagbar you get these features:

- Type signatures are displayed for functions.
- Tags are properly scoped so that, for example, data declarations appear as a
  tree with their constructors scoped as children.
- Definitions that are exported from the module are marked as "public" and
  appear emphasized in Tagbar.
- Tag locations are internally stored as patterns, not line numbers, so that
  you can correctly jump to tags even if they have moved in the source code
  during editing.

![screenshot](https://github.com/bitc/lushtags/raw/master/doc/screenshot-tagbar-2011-09-19.png)

[1]: http://hackage.haskell.org/package/hasktags
[2]: http://kingfisher.nfshost.com/sw/gasbag/
[3]: http://hackage.haskell.org/package/hothasktags
[4]: http://majutsushi.github.com/tagbar/

[Skip to Readme]

Properties

Versions 0.0.1
Dependencies base (==4.*), haskell-src-exts (==1.11.*), text (==0.11.*), vector (==0.9.*) [details]
License MIT
Author Bit Connor
Maintainer bit@mutantlemon.com
Category Development
Home page https://github.com/bitc/lushtags
Source repository head: git clone git://github.com/bitc/lushtags.git
Uploaded Tue Sep 20 10:09:05 UTC 2011 by BitConnor
Distributions NixOS:0.0.1
Downloads 778 total (7 in the last 30 days)
Votes
0 []
Status Docs not available [build log]
Successful builds reported [all 8 reports]
Hackage Matrix CI

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for lushtags

Readme for lushtags-0.0.1

lushtags

Create ctags compatible tags files for Haskell programs

Similar programs are hasktags, gasbag, hothasktags, and GHC's builtin ctags generation.

lushtags differs from these by being designed to have smooth integration with the Vim Tagbar plugin.

Tagbar is nice because it deals with creating tags automatically. There is no need to manually run commands or keep track of tag files. Just open any Haskell file in Vim and the Tagbar window will instantly show an interactive browsable list of all the functions and declarations in the file. This window also updates automatically as you edit the file.

The tags created by lushtags are marked with several extensions, so that when used with Tagbar you get these features:

  • Type signatures are displayed for functions.
  • Tags are properly scoped so that, for example, data declarations appear as a tree with their constructors scoped as children.
  • Definitions that are exported from the module are marked as "public" and appear emphasized in Tagbar.
  • Tag locations are internally stored as patterns, not line numbers, so that you can correctly jump to tags even if they have moved in the source code during editing.

screenshot

Using lushtags with Vim and the Tagbar plugin

  1. Build and install the lushtags executable

    $ cabal configure $ cabal build $ cabal install

  2. Install the Tagbar plugin. Tagbar can be found at

    http://www.vim.org/scripts/script.php?script_id=3465
    http://majutsushi.github.com/tagbar/

  3. Install the included Haskell Tagbar configuration:

    $ cp util/tagbar-haskell.vim ~/.vim/plugin/

  4. Try it out:

    $ vim Hello.hs

Now open the Tagbar with the command :TagbarOpen. An interactive sidebar will appear with all of the tags in your Haskell source file.