rustaceanvim

<!-- markdownlint-disable -->
<br />
<div align="center">
  <a href="https://github.com/mrcjkb/rustaceanvim">
    <img src="./rustaceanvim.svg" alt="rustaceanvim">
  </a>
  <p align="center">
    <br />
    <a href="./doc/rustaceanvim.txt"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/mrcjkb/rustaceanvim/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml">Report Bug</a>
    ·
    <a href="https://github.com/mrcjkb/rustaceanvim/discussions/new?category=ideas">Request Feature</a>
    ·
    <a href="https://github.com/mrcjkb/rustaceanvim/discussions/new?category=q-a">Ask Question</a>
  </p>
  <p>
    <strong>
      Supercharge your Rust experience in <a href="https://neovim.io/">Neovim</a>!<br />
      A heavily modified fork of <a href="https://github.com/simrat39/rust-tools.nvim">rust-tools.nvim</a><br />
    </strong>
  </p>
  <p>🦀</p>

[![Neovim][neovim-shield]][neovim-url]
[![Lua][lua-shield]][lua-url]
[![Rust][rust-shield]][rust-url]
[![Nix][nix-shield]][nix-url]

[![GPL2 License][license-shield]][license-url]
[![Issues][issues-shield]][issues-url]
[![Build Status][ci-shield]][ci-url]
[![LuaRocks][luarocks-shield]][luarocks-url]
</div>
<!-- markdownlint-restore -->

> [!NOTE]
>
> - Just works. [No need to call `setup`!](https://mrcjkb.dev/posts/2023-08-22-setup.html)
> - No dependency on `lspconfig`.
> - Lazy initialization by design.

## :link: Quick Links

- [:pencil: Prerequisites](#pencil-prerequisites)
- [:inbox_tray: Installation](#inbox_tray-installation)
- [:zap: Quick setup](#zap-quick-setup)
- [:books: Usage / Features](#books-usage--features)
- [:gear: Advanced configuration](#gear-advanced-configuration)
- [:stethoscope: Troubleshooting](#stethoscope-troubleshooting)
- [:left_speech_bubble: FAQ](#left_speech_bubble-faq)
- [:rowboat: Migrating from rust-tools](https://github.com/mrcjkb/rustaceanvim/discussions/122)

## :grey_question: Do I need rustaceanvim

If you are starting out with Rust, Neovim's built-in LSP client API
(see [`:h lsp`](https://neovim.io/doc/user/lsp.html)) or
[`nvim-lspconfig.rust_analyzer`](https://github.com/neovim/nvim-lspconfig)
is probably enough for you.
It provides the lowest common denominator of LSP support.
This plugin is for those who would like [additional non-standard features](#books-usage--features)
that are specific to rust-analyzer.

## :pencil: Prerequisites

### Required

- `neovim >= 0.12`
- [`rust-analyzer`](https://rust-analyzer.github.io/)

> [!NOTE]
>
> For versions that are compatible with older Neovim versions,
> see previous major version bumps in [the changelog](./CHANGELOG.md).

### Optional

- [`dot` from `graphviz`](https://graphviz.org/doc/info/lang.html),
  for crate graphs.
- [`cargo`](https://doc.rust-lang.org/cargo/),
  required for Cargo projects.
- A debug adapter (e.g. [`lldb`](https://lldb.llvm.org/)
  or [`codelldb`](https://github.com/vadimcn/codelldb))
  and [`nvim-dap`](https://github.com/mfussenegger/nvi