Skip to content

Latest commit

 

History

History
58 lines (31 loc) · 2.76 KB

README.md

File metadata and controls

58 lines (31 loc) · 2.76 KB
Raw

vim-tagbar-ctags-elm

Support for Elm in Vim Tagbar with Universal Ctags (doesn't work with Exuberant Ctags or any earlier stuff)

elm-tagbar-ctags

Features

  • Universal Ctags options for Elm supporting:

    • modules

    • type definitions

    • type aliases

    • functions

    • nested functions

      **Note**: Uses the [scope tracking](http://docs.ctags.io/en/latest/optlib.html#scope-tracking-in-a-regex-parser) features of Universal Ctags, so won't work with Exuberant Ctags. If you want to use Exuberant Ctags, you need [ctags-elm](https://github.com/kbsymanz/ctags-elm).

    • ports

    • imports

  • Vim Tagbar extension showing the checked kinds.

Install

It's a Pathogen-friendly Vim plugin. Install it with a package manager.

Bugs and limitations

  • Only top level function definitions (with no white space before the function name) define scopes for nesting. E.g. in the screen shot above the _ binding is defined in a let expression in one of the cases further down in the updateField function.
  • Doesn't respect block comments (u-ctags doesn't currently support them with regex parsers)
  • The regexps assumes your source is laid out according to elm-format.
  • Does not set the module as a scope, becase it's hard to parse significant whitespace with regular expressions. We don't know when functions end (to pop the scope) so instead we set the scope at the start of each new top-level function. If the module were a containing scope, the first top level function would clear it out.
  • Doesn't distinguish functions by airity. We talked about this; it doesn't seem like a good idea.

Relationship to other projects

This is an experimental project; when it's a bit more mature, and Universal Ctags a bit more common it will probably end up as one or more of the following:

  • an entry on the Tagbar Wiki

  • a Universal Ctags optlib

  • merged into ctags-elm

    Ctags-elm got me started (thanks Kurt!). It works with Exuberant Ctags, but doesn't support scoped tags.

  • a pull request to elm-vim

    Elm-vim already provides tagbar support for ctags-elm. In order for this project to live nicely alongside that we overwrite g:tagbar_type_elm. (There might be a more polite way of going about this?)

Thanks to the excellent regular expressions 101 for helping me figure out how to match and capture what I needed. And to the excellent work of Universal Ctags.