[{"result":{"data":[{"id":"49a0ed74-f6de-495a-84eb-81f2be847b34","title":"refactor!: rename this plugin to rustaceanvim (#5)","text":"refactor!: rename this plugin to rustaceanvim (#5)\n\n...to avoid clashes with [`vxpm/ferris.nvim`](https://github.com/vxpm/ferris.nvim)","type":"breaking-change","createdAt":"2023-10-24T02:13:51.192Z","breakingChange":{"id":74,"postId":"49a0ed74-f6de-495a-84eb-81f2be847b34","pluginId":233440,"externalUrl":"https://github.com/mrcjkb/rustaceanvim/commit/90977e55d83fb92221b725808508b75e2ffbf625","sha":"90977e55d83fb92221b725808508b75e2ffbf625","plugin":{"id":233440,"owner":"mrcjkb","name":"rustaceanvim","type":"github","source":"awesome-neovim","category":"lsp","link":"https://github.com/mrcjkb/rustaceanvim","shortDescription":"Supercharge your Rust experience in Neovim! A heavily modified fork of rust-tools.nvim","createdAt":"2023-10-24T01:43:09.448Z","readme":"\n
\n

\n \n $\"rustaceanvim\"$ \n \n

\n
\n Explore the docs »\n
\n
\n Report Bug\n ·\n Request Feature\n ·\n Ask Question\n

\n \n Supercharge your Rust experience in Neovim!
\n A heavily modified fork of rust-tools.nvim
\n \n

🦀

\n\n\n[![Neovim][neovim-shield]][neovim-url]\n[![Lua][lua-shield]][lua-url]\n[![Rust][rust-shield]][rust-url]\n[![Nix][nix-shield]][nix-url]\n\n[![GPL2 License][license-shield]][license-url]\n[![Issues][issues-shield]][issues-url]\n[![Build Status][ci-shield]][ci-url]\n[![LuaRocks][luarocks-shield]][luarocks-url]\n\n> [!NOTE]\n>\n> - Just works. [No need to call `setup`!](https://mrcjkb.dev/posts/2023-08-22-setup.html)\n> - No dependency on `lspconfig`.\n> - Lazy initialization by design.\n\n## Quick Links\n\n- [Installation](#installation)\n- [Quick setup](#quick-setup)\n- [Usage](#usage)\n- [Advanced configuration](#advanced-configuration)\n- [Troubleshooting](#troubleshooting)\n- [FAQ](#faq)\n\n## Prerequisites\n\n### Required\n\n- `neovim >= 0.9`\n- [`rust-analyzer`](https://rust-analyzer.github.io/)\n\n### Optional\n\n- [`dot` from `graphviz`](https://graphviz.org/doc/info/lang.html),\n for crate graphs.\n- [`cargo`](https://doc.rust-lang.org/cargo/),\n required for Cargo projects.\n- A debug adapter (e.g. [`lldb`](https://lldb.llvm.org/)\n or [`codelldb`](https://github.com/vadimcn/codelldb))\n and [`nvim-dap`](https://github.com/mfussenegger/nvim-dap),\n required for debugging.\n\n## Installation\n\nThis plugin is [available on LuaRocks][luarocks-url].\n\nExample using [`lazy.nvim`](https://github.com/folke/lazy.nvim):\n\n```lua\n{\n 'mrcjkb/rustaceanvim',\n version = '^3', -- Recommended\n ft = { 'rust' },\n}\n```\n\n>[!NOTE]\n>\n>It is suggested to pin to tagged releases if you would like to avoid breaking changes.\n\nTo manually generate documentation, use `:helptags ALL`.\n\n>[!NOTE]\n>\n> For NixOS users with flakes enabled, this project provides outputs in the\n> form of a package and an overlay; use it as you wish in your NixOS or\n> home-manager configuration.\n> It is also available in `nixpkgs`.\n\nLook at the configuration information below to get started.\n\n## Quick Setup\n\nThis plugin automatically configures the `rust-analyzer` builtin LSP\nclient and integrates with other Rust tools.\nSee the [Usage](#usage) section for more info.\n\n>[!WARNING]\n>\n> Do not call the [`nvim-lspconfig.rust_analyzer`](https://github.com/neovim/nvim-lspconfig)\n> setup or set up the lsp client for `rust-analyzer` manually,\n> as doing so may cause conflicts.\n\nThis is a filetype plugin that works out of the box,\nso there is no need to call a `setup` function or configure anything\nto get this plugin working.\n\nYou will most likely want to add some keymaps.\nMost keymaps are only useful in rust files,\nso I suggest you define them in `~/.config/nvim/after/ftplugin/rust.lua`[^1]\n\n[^1]: See [`:help base-directories`](https://neovim.io/doc/user/starting.html#base-directories)\n\nExample:\n\n```lua\nlocal bufnr = vim.api.nvim_get_current_buf()\nvim.keymap.set(\n \"n\", \n \"a\", \n function()\n vim.cmd.RustLsp('codeAction'), \n end,\n { silent = true, buffer = bufnr }\n)\n```\n\n>[!NOTE]\n>\n> - For more LSP related keymaps, [see the `nvim-lspconfig` suggestions](https://github.com/neovim/nvim-lspconfig#suggested-configuration).\n> - See the [Advanced configuration](#advanced-configuration) section\nfor more configuration options.\n\n## Usage\n\n\n

\n\tDebugging\n

\n \n ```vimscript\n :RustLsp debuggables [last?]\n ```\n ```lua\n vim.cmd.RustLsp {'debuggables', 'last' --[[ optional ]] }\n ```\n\n ![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/ce17d228-ae0a-416a-8159-fe095a85dcb7)\n\n

\n\n

\n\tRunnables\n

\n \n ```vimscript\n :RustLsp runnables [last?]\n ```\n ```lua\n vim.cmd.RustLsp {'runnables', 'last' --[[ optional ]] }\n ```\n\n ![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/95183192-5669-4a07-804b-83f67831be57)\n\n\n

\n\n

\n\tExpand Macros Recursively\n

\n \n ```vimscript\n :RustLsp expandMacro\n ```\n ```lua\n vim.cmd.RustLsp('expandMacro')\n ```\n ![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/477d9e58-74b0-42ff-87ca-2fef34d06db3)\n

\n\n

\n\tRebuild proc macros\n

\n \n ```vimscript\n :RustLsp rebuildProcMacros\n ```\n ```lua\n vim.cmd.RustLsp('rebuildProcMacros')\n ```\n\n

\n\n

\n\tMove Item Up/Down\n

\n \n ```vimscript\n :RustLsp moveItem up\n :RustLsp moveItem down\n ```\n ```lua\n vim.cmd.RustLsp { 'moveItem', 'up' }\n vim.cmd.RustLsp { 'moveItem', 'down' }\n ```\n

\n\n

\n\tHover Actions\n

\n \n Note: To activate hover actions, run the command twice.\n This will move you into the window, then press enter on the selection you want.\n Alternatively, you can set `auto_focus` to `true` in your config and you will \n automatically enter the hover actions window.\n\n ```vimscript\n :RustLsp hover actions\n ```\n ```lua\n vim.cmd.RustLsp { 'hover', 'actions' }\n ```\n\n![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/c7b6c730-4439-47b0-9a75-7ea4e6831f7a)\n\n

\n\n

\n\tHover Range\n

\n\n ```vimscript\n :RustLsp hover range\n ```\n ```lua\n vim.cmd.RustLsp { 'hover', 'range' }\n ```\n

\n\n

\n\tExplain errors\n

\n\n Display a hover window with explanations from the [rust error codes index](https://doc.rust-lang.org/error_codes/error-index.html)\n over error diagnostics (if they have an error code).\n \n ```vimscript\n :RustLsp explainError\n ```\n ```lua\n vim.cmd.RustLsp('explainError')\n ```\n\n![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/bac9b31c-22ca-40c4-bfd3-b8c5ba4cc49a)\n\n

\n\n

\n\tOpen Cargo.toml\n

\n \n ```vimscript\n :RustLsp openCargo\n ```\n ```lua\n vim.cmd.RustLsp('openCargo')\n ```\n

\n\n

\n\tParent Module\n

\n \n ```vimscript\n :RustLsp parentModule\n ```\n ```lua\n vim.cmd.RustLsp('parentModule')\n ```\n

\n\n

\n\tJoin Lines\n

\n \n ```vimscript\n :RustLsp joinLines\n ```\n ```lua\n vim.cmd.RustLsp('joinLines')\n ```\n

\n\n

\n\tStructural Search Replace\n

\n \n ```vimscript\n :RustLsp ssr [query]\n ```\n ```lua\n vim.cmd.RustLsp { 'ssr', 'query' --[[ optional ]] }\n ```\n

\n\n

\n\tView Crate Graph\n

\n \n ```vimscript\n :RustLsp crateGraph [backend [output]]\n ```\n ```lua\n vim.cmd.RustLsp { 'crateGraph', '[backend]', '[output]' }\n ```\n

\n\n

\n\tView Syntax Tree\n

\n \n ```vimscript\n :RustLsp syntaxTree\n ```\n ```lua\n vim.cmd.RustLsp('syntaxTree')\n ```\n\n ![](https://github.com/mrcjkb/rustaceanvim/assets/12857160/c865a263-1568-41c7-a32b-bc4a34b198dc)\n\n

\n\n

\n\tFly check\n

\n\n Run `cargo check` or another compatible command (f.x. `clippy`) \n in a background thread and provide LSP diagnostics based on \n the output of the command.\n\n Useful in large projects where running `cargo check` on each save\n can be costly.\n \n ```vimscript\n :RustLsp flyCheck\n ```\n ```lua\n vim.cmd.RustLsp('flyCheck')\n ```\n

\n\n\n\n## Advanced configuration\n\nTo modify the default configuration, set `vim.g.rustaceanvim`.\n\n- See [`:help rustaceanvim.config`](./doc/rustaceanvim.txt) for a detailed\n documentation of all available configuration options.\n You may need to run `:helptags ALL` if the documentation has not been installed.\n- The default configuration [can be found here (see `RustaceanDefaultConfig`)](./lua/rustaceanvim/config/internal.lua).\n- For detailed descriptions of the language server configs,\n see the [`rust-analyzer` documentation](https://rust-analyzer.github.io/manual.html#configuration).\n\nThe options shown below are the defaults.\nYou only need to pass the keys to the setup function\nthat you want to be changed, because the defaults\nare applied for keys that are not provided.\n\nExample config:\n\n```lua\nvim.g.rustaceanvim = {\n -- Plugin configuration\n tools = {\n },\n -- LSP configuration\n server = {\n on_attach = function(client, bufnr)\n -- you can also put keymaps in here\n end,\n settings = {\n -- rust-analyzer language server configuration\n ['rust-analyzer'] = {\n },\n },\n },\n -- DAP configuration\n dap = {\n },\n}\n```\n\n> [!NOTE]\n>\n> `vim.g.rustaceanvim` can also be a function that returns\n> a table.\n\n### Using `codelldb` for debugging\n\nFor Rust, `codelldb` from the [CodeLLDB VSCode extension](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb)\nprovides a better experience than `lldb`.\nIf you are using a distribution that lets you install the `codelldb`\nexecutable, this plugin will automatically detect it and configure\nitself to use it as a debug adapter.\n\nSome examples:\n\n- NixOS: [`vscode-extensions.vadimcn.vscode-lldb.adapter`](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/applications/editors/vscode/extensions/vadimcn.vscode-lldb/default.nix#L134)\n- Arch Linux: [`codelldb-bin` (AUR)](https://aur.archlinux.org/packages/codelldb-bin)\n\nIf your distribution does not have a `codelldb` package,\nyou can configure it as follows:\n\n1. Install the [CodeLLDB VSCode extension](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb).\n1. Find out where it is installed.\n On Linux, this is typically in `$HOME/.vscode/extensions/`\n1. Update your configuration:\n\n```lua\nvim.g.rustaceanvim = function()\n -- Update this path\n local extension_path = vim.env.HOME .. '/.vscode/extensions/vadimcn.vscode-lldb-1.10.0/'\n local codelldb_path = extension_path .. 'adapter/codelldb'\n local liblldb_path = extension_path .. 'lldb/lib/liblldb'\n local this_os = vim.uv.os_uname().sysname;\n\n -- The path is different on Windows\n if this_os:find \"Windows\" then\n codelldb_path = extension_path .. \"adapter\\\\codelldb.exe\"\n liblldb_path = extension_path .. \"lldb\\\\bin\\\\liblldb.dll\"\n else\n -- The liblldb extension is .so for Linux and .dylib for MacOS\n liblldb_path = liblldb_path .. (this_os == \"Linux\" and \".so\" or \".dylib\")\n end\n\n return {\n dap = {\n adapter = require('rustaceanvim.dap').get_codelldb_adapter(codelldb_path, liblldb_path),\n },\n }\nend\n```\n\n### How to dynamically load different `rust-analyzer` settings per project\n\nBy default, this plugin will look for a `rust-analyzer.json`\nfile in the project root directory, and attempt to load it.\nIf the file does not exist, or it can't be decoded,\nthe default settings will be used.\n\nYou can change this behaviour with the `server.settings` config:\n\n```lua\nvim.g.rustaceanvim = {\n -- ...\n server = {\n ---@param project_root string Path to the project root\n settings = function(project_root)\n local ra = require('rustaceanvim.config.server')\n return ra.load_rust_analyzer_settings(project_root, {\n settings_file_pattern = 'rust-analyzer.json'\n })\n end,\n },\n}\n```\n\n## Troubleshooting\n\n### Health checks\n\nFor a health check, run `:checkhealth rustaceanvim`\n\n### Minimal config\n\nTo troubleshoot this plugin with a minimal config in a temporary directory,\nyou can try [minimal.lua](./troubleshooting/minimal.lua).\n\n```console\nmkdir -p /tmp/minimal/\nNVIM_DATA_MINIMAL=\"/tmp/minimal\" NVIM_APP_NAME=\"nvim-minimal\" nvim -u minimal.lua\n```\n\n> [!NOTE]\n>\n> If you use Nix, you can run\n> `nix run \"github:mrcjkb/rustaceanvim#nvim-minimal-stable\"`.\n> or\n> `nix run \"github:mrcjkb/rustaceanvim#nvim-minimal-nightly\"`.\n\nIf you cannot reproduce your issue with a minimal config,\nit may be caused by another plugin.\nIn this case, add additional plugins and their configurations to `minimal.lua`,\nuntil you can reproduce it.\n\n## FAQ\n\n### Where are inlay hints?\n\nAs Neovim >= 0.10 supports inlay hints natively, I have removed the\ncode from this plugin.\n\nTo enable inlay hints in Neovim < 0.10, see [this discussion](https://github.com/mrcjkb/rustaceanvim/discussions/46#discussioncomment-7620822).\n\n## Related Projects\n\n- [`simrat39/rust-tools.nvim`](https://github.com/simrat39/rust-tools.nvim)\n This plugin is a heavily modified fork of `rust-tools.nvim`.\n- [`Saecki/crates.nvim`](https://github.com/Saecki/crates.nvim)\n- [`vxpm/ferris.nvim`](https://github.com/vxpm/ferris.nvim)\n Geared towards people who prefer manual LSP client configuration.\n\n## Inspiration\n\n`rust-tools.nvim` draws inspiration from [`akinsho/flutter-tools.nvim`](https://github.com/akinsho/flutter-tools.nvim)\n\n\n\n\n\n[neovim-shield]: https://img.shields.io/badge/NeoVim-%2357A143.svg?&style=for-the-badge&logo=neovim&logoColor=white\n[neovim-url]: https://neovim.io/\n[lua-shield]: https://img.shields.io/badge/lua-%232C2D72.svg?style=for-the-badge&logo=lua&logoColor=white\n[lua-url]: https://www.lua.org/\n[nix-shield]: https://img.shields.io/badge/nix-0175C2?style=for-the-badge&logo=NixOS&logoColor=white\n[nix-url]: https://nixos.org/\n[rust-shield]: https://img.shields.io/badge/Rust-000000?style=for-the-badge&logo=rust&logoColor=white\n[rust-url]: https://www.rust-lang.org/\n[issues-shield]: https://img.shields.io/github/issues/mrcjkb/rustaceanvim.svg?style=for-the-badge\n[issues-url]: https://github.com/mrcjkb/rustaceanvim/issues\n[license-shield]: https://img.shields.io/github/license/mrcjkb/rustaceanvim.svg?style=for-the-badge\n[license-url]: https://github.com/mrcjkb/rustaceanvim/blob/master/LICENSE\n[ci-shield]: https://img.shields.io/github/actions/workflow/status/mrcjkb/rustaceanvim/nix-build.yml?style=for-the-badge\n[ci-url]: https://github.com/mrcjkb/rustaceanvim/actions/workflows/nix-build.yml\n[luarocks-shield]: https://img.shields.io/luarocks/v/MrcJkb/rustaceanvim?logo=lua&color=purple&style=for-the-badge\n[luarocks-url]: https://luarocks.org/modules/MrcJkb/rustaceanvim\n","dotfyleShieldAddedAt":null,"stars":142,"lastSyncedAt":"2023-11-28T02:21:11.692Z","addedLastWeek":4}}}]}}]