rusty-tags
A command line tool that creates tags - for source code navigation by using ctags - for a cargo project and all of its dependencies.
Prerequisites
Installation
- get
rustc
andcargo
from here git clone https://github.com/dan-t/rusty-tags.git
cd rusty-tags
cargo build --release
The build binary will be located at target/release/rusty-tags
.
Usage
cargo build
has to be called at least once, to download the source code of
the dependencies. If a dependency gets added or updated, then most likely
cargo build
has to be called again.
Just calling rusty-tags vi
then anywhere inside of a cargo project should
just work and after its run a rusty-tags.vi
file should be beside
of the Cargo.toml
file.
rusty-tags
will also put a rusty-tags.vi
to the source code of
every dependency, so after jumping to a dependency, you're able
to jump further to its dependencies.
rusty-tags
should also correctly handle the case if a dependency
reexports parts of its own dependencies.
Currently rusty-tags
doesn't support cargo dependency overwrites and
only searches for git dependencies inside of ~/.cargo/git/checkouts/
and for crates.io dependencies inside of ~/.cargo/registry/src/github.com-*
.
Rust Standard Library Support
rusty-tags
can automatically add tags for the standard library to
every tags file it's creating.
Creating tags for the standard library:
$ git clone https://github.com/rust-lang/rust.git
$ cd rust
$ ./configure
$ make TAGS.vi
You might want to modify rust/mk/ctags.mk
to only consider rust files,
otherwise you're also getting tags for all of rustcs c code:
-CTAGS_OPTS=--options="${CFG_SRC_DIR}src/etc/ctags.rust" --languages=-javascript --recurse ${CTAGS_LOCATIONS}
+CTAGS_OPTS=--options="${CFG_SRC_DIR}src/etc/ctags.rust" --languages=Rust --recurse ${CTAGS_LOCATIONS}
Renaming the tags file, that if you've jumped to the standard
library, that you're able to jump further inside of it, and copying a
version of the tags, that rusty-tags
can add it to every tags file it creates:
$ mv TAGS.vi rusty-tags.vi
$ mkdir -p ~/.rusty-tags
$ cp rusty-tags.vi ~/.rusty-tags/rust-std-lib.vi
Vim Configuration
Put this into your ~/.vim/after/ftplugin/rust.vim
file:
set tags=rusty-tags.vi;/
autocmd BufWrite *.rs :silent !rusty-tags vi
The first line (only supported by vim >= 7.4) ensures that vim will
automatically search for a rusty-tags.vi
file upwards the directory hierarchy.
This tags setting is important if you want to jump to dependencies and then further jump to theirs dependencies.
The second line ensures that your projects tag file gets updated if a file is written.
Normally you want to call the rusty-tags
command in the backgroud by adding a &
:
autocmd BufWrite *.rs :silent !rusty-tags vi &
But I had sometimes strange behaviours this way that I couldn't track down
until now. So you can try using it with the &
, and if it doesn't work,
if the tags aren't correctly updated, then you know the reason.
Emacs Support
There's now a first version with emacs support.
Replace every occurrence of vi
with emacs
in the README e.g.:
rusty-tags vi
=>rusty-tags emacs
make TAGS.vi
=>make TAGS.emacs
rusty-tags.vi
=>rusty-tags.emacs
Instead of merging the tags files like in the vi case, an include
line is added to the emacs tags file which includes the tags files
of the dependencies.
I haven't tested the emacs tags, so some feedback would be nice!