sanel / lein-codeindex

Index code using etags, ctags or gtags.

lein-codeindex

Index your Clojure and Java project code with all dependencies using etags, ctags or gtags.

In short, this Leiningen plugin allows you to easily index the code and find any function, variable or namespace definition used through the code from editors like Emacs, Vim, Sublime Text and many more.

Prerequisites

Make sure you have installed etags (comes with Emacs), ctags (distributed usually with Vim) or gtags (comes with GNU Global).

Usage

To enable lein-codeindex for your project, put

into the :plugins vector of your project.clj. If you'd like to enable it globally for every project, put it in $HOME/.lein/profiles.clj.

To run it, use:

$ lein codeindex

This will generate Emacs compatible tags using etags.

If you'd like to use ctags and generate Vi/Vim compatible tags, use:

$ lein codeindex --vim

or

$ lein codeindex --ctags --vim

To generate Emacs tags using ctags, use:

$ lein codeindex --ctags

To see other options, run:

$ lein help codeindex

License

Copyright © 2018 Sanel Zukan

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.

lein-codeindex's Issues

Support for custom ctags/etags path

Currently lein-codeindex is expecting ctags and etags to be present in $PATH. Add option (via environment variable) to specify full path to tags binary.

Properly resolve namespace/function

As mentioned here, resolving namespace/function isn't supported yet, since both ctags and etags aren't aware of Clojure code structure.

Remove unnecessary files from extracted dependencies folder

Right now, folder with external dependencies (.lein-codeindex in project root) will contain anything what is stored inside .jar files. Some of these files aren't necessary for indexing, like .class files, and they are just taking space. Remove them.

Auto-update support

Right now, lein-codeindex has to be run manually to update tags index. Add command line option to monitor for file changes and update index automatically.