Setup Your Editor

There can be a few extra steps required to get code completion and syntax highlighting setup with your editor.

Note

Can't find your editor here? Open an issue here! The rustc Development Guide may be a useful starting point, though several points won't apply to bevy_lint.

VSCode

bevy_lint works out-of-the-box with VSCode's rust-analyzer extension. The settings are specified in .vscode/settings.json:

{
    // Enables Rust-Analyzer support for `rustc` crates.
    "rust-analyzer.rustc.source": "discover",
    // Show dependency types while fuzzy searching, including types from `rustc` crates.
    "rust-analyzer.workspace.symbol.search.scope": "workspace_and_dependencies",
}

Neovim

First, setup rust-analyzer by following the instructions here. Next, install the neoconf.nvim plugin, which will automatically import the settings from .vscode/settings.json.

RustRover

As of December 2024, RustRover and the JetBrains Rust plugin do not work with rustc's internal crates. If you manage to get it working, make sure to submit an issue!