Skip to content

Latest commit

 

History

History
83 lines (43 loc) · 3.63 KB

README.md

File metadata and controls

83 lines (43 loc) · 3.63 KB
Raw

Racer - code completion for Rust

Build Status

racer completion screenshot

racer eldoc screenshot

RACER = Rust Auto-Complete-er. A utility intended to provide Rust code completion for editors and IDEs. Maybe one day the 'er' bit will be exploring + refactoring or something.

Installation

With cargo install

This method requires Rust 1.5. Simply run:

cargo install racer

As mentioned in the command output, don't forget to add the installation directory to your PATH.

From sources

  1. Clone the repository: git clone https://github.com/phildawes/racer.git

  2. cd racer; cargo build --release. The binary will now be in ./target/release/racer

  3. Add the binary to your PATH. This can be done by moving it to a directory already in your PATH (i.e. /usr/local/bin) or by adding the ./target/release/ directory to your PATH

Configuration

  1. Fetch the Rust sourcecode

a) manually from git, or download from https://www.rust-lang.org/install.html (the 'rustc' source download behind the 'source' link is the right one).

b) automatically via rustup and run rustup component add rust-src in order to install the source to ~/.multirust/toolchains/[your-toolchain]/lib/rustlib/src/rust/src. Rustup will keep the sources in sync with the toolchain if you run rustup update.

  1. Set the RUST_SRC_PATH environment variable to point to the 'src' dir in the Rust source installation

    (e.g. % export RUST_SRC_PATH=/usr/local/src/rust/src or % export RUST_SRC_PATH=~/.multirust/toolchains/[your-toolchain]/lib/rustlib/src/rust/src )

  2. Test on the command line:

    racer complete std::io::B (should show some completions)

Editors/IDEs Supported

Eclipse integration

Racer can be used with Eclipse through the use of RustDT. (User guide is linked in repo description)

Emacs integration

Emacs integration has been moved to a separate project: emacs-racer.

Gedit integration

Gedit integration can be found here.

Kate integration

The Kate community maintains a plugin. It is bundled with recent releases of Kate (tested with 16.08 - read more here).

  1. Enable 'Rust code completion' in the plugin list in the Kate config dialog;

  2. On the new 'Rust code completion' dialog page, make sure 'Racer command' and 'Rust source tree location' are set correctly.

Sublime Text integration

The Sublime Text community maintains some packages that integrates Racer

  • RustAutoComplete that offers auto completion and goto definition.
  • AnacondaRUST from the anaconda plugins family that offers auto completion, goto definition and show documentation

Vim integration

Vim integration has been moved to a separate project: vim-racer.

Visual Studio Code extension

You can find more info about Visual Studio Code extension here.

Atom integration

You can find the racer package for Atom here