CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[4.13.0] - 2024-03-15

Added

• LSP: More flexibility when overriding default rust-analyzer settings. The server.settings function can now take a default_settings tabe to be merged.

[4.12.2] - 2024-03-11

Fixed

• LSP/Windows: path normalisation preventing lsp from working textDocument/definition to std library [#285]. Thanks @tangtang95!

[4.12.1] - 2024-03-09

Fixed

• UI: Buggy concealing of elements in rendered diagnostics [#280].
• LSP: Use file directory name as cwd when getting cargo metadata. This prevents rustaceanvim from detecting the wrong project root in standalone files if the current cwd is a cargo project.

[4.12.0] - 2024-03-08

Fixed

• DAP: :RustLsp! debuggables not falling back to UI select when no debuggable is found.

Added

• LSP: Support falling back to UI select for :RustLsp! runnables and :RustLsp! testables.

[4.11.1] - 2024-03-04

Fixed

• LSP/Windows: Windows path normalisation preventing LSP client from working [#273].

[4.11.0] - 2024-03-03

Added

• LSP: By default, don't auto-attach to buffers that aren't files [#268].

Fixed

• LSP: Bug preventing reload workspace on save Cargo.toml when opening another Rust buffer [#270].
• LSP: Don't try to delete RustLsp command on client exit if it doesn't exist, and fail silently.

[4.10.2] - 2024-03-01

Fixed

• LSP: Schedule Neovim API calls on on_exit [#267]. Thanks @tomtomjhj!

[4.10.1] - 2024-02-27

Fixed

• UI: Explicitly disable signcolumn for grouped code action and hover action windows [#262].

[4.10.0] - 2024-02-23

Added

• LSP/Grouped code actions: Add <ESC> keymap to close buffer. This is consistent with the behaviour of the hover actions buffer.

[4.9.0] - 2024-02-23

Added

• Nix: codelldb adapter package (without the vscode extension) as a nixpkgs overlay and a flake output.

Reverted

• Don't run ftplugin/rust.lua more than once on the same buffer. This prevented the client from reattaching when running :e on a buffer [#250].

[4.8.0] - 2024-02-20

Added

• Neotest: Expose doctests in :Neotest summary window [#247]. Thanks @bltavares!

Fixed

• Testables: Run doctests when cargo-nextest is present [#246] Thanks @bltavares!
• Windows: Normalize file actions when comparing to root dir [#245]. Thanks @bltavares!

[4.7.5] - 2024-02-20

Fixed

• DAP: Use deep copies of dap configs.
• DAP: Bad config validation: dap.configuration.env should be a table, not a string.

[4.7.4] - 2024-02-19

Fixed

• LSP: Support both top-level rust-analyzer object and object with "rust-analyzer": key when importing settings from rust-analyzer.json. The fix introduced in version 4.6.0 had accidentally broken backward compatibility. The new implementation is backward compatible again.

[4.7.3] - 2024-02-15

Fixed

• LSP: Error when running reloadWorkspace, rebuildMacros or workspaceSymbol from a non-rust buffer [#234].
• Internal: Don't pass client not found error to handler.

[4.7.2] - 2024-02-13

Revert

• DAP(codelldb): Redirect stdio (stdout) to a temp file.

[4.7.1] - 2024-02-12

Fixed

• LSP: checkOnSave = false not respected when clippy is installed (introduced with clippy auto-detection in version 4.6.0).

[4.7.0] - 2024-02-11

Added

• Testables: Add tools.crate_test_executor option for running crate test suites (--all-targets).
• Rustc: Do not require a main function, and support the 2024 edition via unstable-options. Thanks @saying121!

Fixed

• Neotest: Nested modules + position updates when switching buffers [#223]. Thanks @jameshurst!
• Testables: Support neotest executor when using nextest.
• Testables: Support aliases for test_executor and crate_test_executor.

[4.6.0] - 2024-02-07

Added

• LSP: New tools.enable_clippy option (defaults to true). Enable clippy lints on save if a cargo-clippy installation is detected.

Fixed

• testables/neotest: Don't use nextest if disabled in the config.
• LSP: load project-local rust-analyzer.json configs into server['rust-analyzer'], instead of replacing the server config.

[4.5.2] - 2024-02-06

Fixed

• runnables/debuggables/testables: cd into directory with spaces [#212].

Fixed

[4.5.1] - 2024-02-03

Fixed

• LSP: Notify if an LSP request was made but no rust-analyzer client is attached.
• Neotest: Only the current buffer was queried for test positions.

[4.5.0] - 2024-02-02

Added

• Filtered workspace symbol searches with :RustLsp[!] workspaceSymbol [onlyTypes?|allSymbols?] [query?]. Will include dependencies if called with a bang !.
• Neotest: Basic support for require('neotest').run.run { suite = true }. This will run the current crate's test suite, if detected. Note that positions are still only discovered for buffers with an attached LSP client.

[4.4.0] - 2024-02-01

Added

• You can now register a rustaceanvim.neotest adapter with neotest. It will query rust-analyzer for test positions and test commands in any buffer to which the LSP client is attached. If you do so, tools.test_executor will default to a new 'neotest' executor, which will use neotest to run testables or runnables that are tests.
• Support for require('neotest').run.run { strategy = 'dap' }. This will use the same logic as :RustLsp debuggables to set neotest's DAP strategy. No extra configuration needed!
• :RustLsp testables: Prettier selection options.

Fixes

• DAP(codelldb): Redirect stdio (stdout) to a temp file.

[4.3.0] - 2024-01-31

Changed

• LSP: Improved parsing of test result failure messages.

[4.2.1] - 2024-01-30

Fixed

• LSP: Only advertise rust-analyzer.debugSingle command capability if nvim-dap is installed.
• LSP: nil error if running :RustLsp! testables and there is no previous testable.
• LSP: Update previous testables cache if executing a rust-analyzer.runSingle command that is a test.

[4.2.0] - 2024-01-30

Added

• Config: Separate tools.executor and tools.test_executor options. The test_executor is used for test runnables (e.g. cargo test).
• LSP: New test executor, 'background' that runs tests in the background and provides diagnostics for failed tests when complete. Used by default in Neovim >= 0.10.
• LSP: :RustLsp testables command, which is equivalent to :RustLsp runnables, but filters the runnables for tests only,

Important

In Neovim < 0.10, 'background' executor blocks the UI while running tests.

[4.1.0] - 2024-01-29

Added

• :Rustc unpretty command: Use rustc -Z unpretty=[mir|hir|...] to inspect mir and other things, and achieve an experience similar to Rust Playground. (currently requires a nightly compiler). Thanks saying121!
• Config: tools.rustc arguments for rustc.

Changed

• Improved command completions.
  • Filter suggested subcommand arguments based on existing user input.
  • When calling, :RustLsp!, show only subcommands that change behaviour with a bang.

Fixed

• Command completions: Removed completions for runnables/debuggables last.

[4.0.3] - 2024-01-28

Fixed

• renderDiagnostic: Window closes immediately if auto_focus is disabled [#193].
• explainError/renderDiagnostic: Fall back to first detected diagnostic if none is found close to the cursor.

[4.0.2] - 2024-01-27

Fixed

• LSP (standalone): Use bufnr passed into lsp.start function when determining detached file name.

[4.0.1] - 2024-01-27

Fixed

• LSP: Fix resetting client state on :RustAnalyzer stop if only one client is attached.

Performance

• Only setup vim.lsp.commands for rust-analyzer on the first initialization.
• Don't run ftplugin/rust.lua more than once on the same buffer.

[4.0.0] - 2024-01-25

BREAKING CHANGES

• To run the previous runnable/debuggable, you would call :RustLsp runnables last or :RustLsp debuggables last. These two functions now take optional arguments that you can pass to the executables. The new way to run the previous runnable/debuggable is with a bang (!). e.g. :RustLsp! debuggables. In Lua, this is vim.cmd.RustLsp { 'debuggables', bang = true }, and the same for 'runnables'.

Added

• LSP: Option to fall back to vim.ui.select if there are no code action groups when running :RustLsp codeAction.
• LSP/DAP: Allow overriding executable args with :RustLsp runnables args[] and :RustLsp debuggables args[].

Fixed

• LSP: Focus lost when secondary float opens on :RustLsp codeAction [#169].

[3.17.3] - 2024-01-25

Fixed

• DAP: nil safety in standalone files [#182].

[3.17.2] - 2024-01-22

Fixed

• LSP: Properly sanitize hover actions debug command [#179]. Thanks @Tired-Fox!

[3.17.1] - 2024-01-22

Fixed

• Spawn rust-analyzer in detached mode when no project root is found. This adds support for standalone files without a Rust project.

[3.17.0] - 2024-01-20

Added

• Cache runnables and debuggables run with commands/code lenses.

[3.16.3] - 2024-01-20

Changed

• Performance (DAP): Use cached source map, LLDB commands and library path.
• DAP: Set autoload_configurations only for Neovim >= 0.10, as compiling the debug build is not async in Neovim 0.9.

[3.16.2] - 2024-01-19

Fixed

• DAP: nil error when executing rust-analyzer.debugSingle or :RustLsp debuggables last commands (introduced in 3.16.0).

[3.16.1] - 2024-01-17

Fixed

• DAP: Improve reliability of loading Rust debug configurations on LSP attach.
• DAP: Assign lldb and codelldb configurations found in launch.json to dap.configurations.rust.

[3.16.0] - 2024-01-15

Added

• DAP: Better nvim-dap integration: Automatically try to load Rust debug configurations on LSP attach. This lets you use require('dap').continue() instead of :RustLsp debuggables, once the configurations have been loaded. Can be disabled by setting vim.g.rustaceanvim.dap.autoload_configurations = false.

Fixed

• LSP: If inlay hints are enabled for a buffer, force Neovim to redraw them when rust-analyzer has fully initialized. This is a workaround for neovim/26511.
• LSP: On client stop, reset the experimental/serverStatus handler's internal state for the respective client, so that the handler can be rerun on restart.
• LSP/Windows: Normalize case sensitive root_dir [#151]. Thanks @TrungNguyen153!

[3.15.0] - 2024-01-11

Added

• :RustAnalyzer restart command.
• Smarter completions for :RustAnalyzer commands.
  • Only suggest start command if there is no active client for the current buffer
  • Only suggest stop and restart if there is an active client for the current buffer

[3.14.0] - 2024-01-10

Added

• :RustLsp renderDiagnostic command: Render diagnostics as displayed during cargo build.
• Add Open in split action to explainError and renderDiagnostic float preview windows.

[3.13.1] - 2024-01-10

Fixed

• DAP: Use codelldb adapter nvim-dap field when using codelldb.

[3.13.0] - 2024-01-09

Added

• Config: tools.float_win_config for all floating Windows created by this plugin. Moved border, max_width, max_height, auto_focus from hover_actions to float_win_config. The hover_actions window options are still applied if they exist, so as not to break compatibility. Thanks @saying121!

Fixed

• DAP: Don't load lldb_commands when using codelldb.
• DAP: Make sure the client configuration type is 'codelldb' when using a 'codelldb' adapter.

[3.12.2] - 2024-01-07

Fixed

• LSP: Don't set augmentsSyntaxTokens capability. This appears to cause problems for some colorschemes.

[3.12.1] - 2024-01-06

Fixed

• Config: Report error if new validations fail.

[3.12.0] - 2024-01-06

Added

• Config: Some more validations.

[3.11.0] - 2023-12-23

Added

• LSP: view [hir|mir] command [#14], [#15].

Fixed

• SSR: Make query optional.

[3.10.5] - 2023-12-22

Fixed

• Health: Only report error if lspconfig.rust_analyzer has been setup, not other lspconfig configurations.

[3.10.4] - 2023-12-20

Fixed

• SSR: Broken when command contains spaces [#104].
• LSP: Prevent "attempt to index a nil value" error [#105].

[3.10.3] - 2023-12-19

Fixed

• Health: Don't eagerly import modules.

[3.10.2] - 2023-12-18

Fixed

• DAP: Only add sourceMap and lldb commands if the files exist.
• DAP (Windows): Fixed .exe extension in mason.nvim codelldb detection. Thanks @svermeulen!

[3.10.1] - 2023-12-14

Fixed

• DAP: Check if mason dap package is installed [#96]. Thanks @richchurcher!

[3.10.0 - 2023-12-12

Added

Thanks @Andrew Collins:

• DAP: Load the dap.adapter config value into the lldb adapter, but only if the lldb adapter is not already configured.
• DAP: Add dap.configuration entry to config with the default behaviour of loading launch.json, or falling back to a basic configuration of the lldb adapter.
  • Use the dap.configuration config value to configure the debug session, falling back to the rust configuration.
• DAP: Support probe-rs.

[3.9.6] - 2023-12-06

Fixed

• nil checks for when there is no root project. Fixes the error message encountered in #90.

[3.9.5] - 2023-12-05

Fixed

• :RustLsp flyCheck: Typo in LSP client request, causing the command to do nothing [#88].

[3.9.4] - 2023-12-01

Fixed

• DAP: mason.nvim codelldb installation detection - liblldb path.

[3.9.3] - 2023-12-01

Fixed

• DAP: Typo in mason.nvim codelldb installation detection (╯°□°)╯︵ ┻━┻.

[3.9.2] - 2023-12-01

Fixed

• DAP: loop error when auto-detecting mason.nvim codelldb installation.
• DAP: Deprecate require('rustaceanvim.dap').get_codelldb_adapter (replaced with require('rustaceanvim.config').get_codelldb_adapter).

[3.9.1] - 2023-12-01

Fixed

• DAP: Potential bug when loading mason.nvim's codelldb package.
• DAP: Check that mason.nvim's codelldb package isn't nil before using it.

[3.9.0] - 2023-12-01

Added

• DAP: Auto-detect codelldb if it is installed via mason.nvim.

[3.8.0] - 2023-12-01

Added

• :RustLsp logFile command, which opens the rust-analyzer log file.
• :RustLsp flyCheck: Support run, clear and cancel subcommands.
• Executors: Support commands without cwd.

Fixed

• Health: Check if vim.g.rustaceanvim is set, but hasn't been sourced before initialization.

[3.7.1] - 2023-11-28

Fixed

• DAP: Correctly format environment, so that it works with both codelldb and lldb [#74]. Thanks @richchurcher!

[3.7.0] - 2023-11-27

Added

• DAP: Support dynamically compiled executables [[#64]mrcjkb#64). Thanks @richchurcher!
  • Configures dynamic library paths by default (with the ability to disable)
  • Loads Rust type information by default (with the ability to disable).

Fixed

• DAP: Format sourceMap correctly for both codelldb and lldb. codelldb expects a map, while lldb expects a list of tuples.

[3.6.5] - 2023-11-22

Fixed

• Completion for :RustLsp hover actions command suggesting action.

[3.6.4] - 2023-11-19

Fixed

[3.6.3] - 2023-11-18

• DAP: Source map should be a list of tuples, not a map.

Fixed

• DAP: lldb-vscode and lldb-dap executable detection.

[3.6.2] - 2023-11-17

Fixed

• DAP: Add support for lldb-dap, which has been renamed to lldb-vscode, but may still have the old name on some distributions.

[3.6.1] - 2023-11-17

Fixed

• Broken :RustLsp runnables last command [#62].

[3.6.0] - 2023-11-15

Added

• Add tools.open_url option, to allow users to override how to open external docs.

[3.5.1] - 2023-11-13

Fixed

• Config validation fails if server.settings option is a table [#56].

[3.5.0] - 2023-11-11

Added

• Ability to load rust-analyzer settings from project-local JSON files.

[3.4.2] - 2023-11-11

Fixed

• Open external docs broken in Neovim 0.9 [#50].

[3.4.1] - 2023-11-10

Fixed

• Command completion broken in Neovim 0.9 [#47].

[3.4.0] - 2023-11-01

Added

• Auto-create codelldb configurations.

Fixed

• DAP: Support codelldb configurations [#40].
• DAP: Don't pass in an empty source map table if the auto_generate_source_map setting evaluates to false.

[3.3.3] - 2023-10-31

Fixed

• Default rust-analyzer configuration [#37]. Thanks again, @eero-lehtinen!

[3.3.2] - 2023-10-31

Fixed

• Cargo workspace reload using removed command [#36]. Thanks @eero-lehtinen!

[3.3.1] - 2023-10-31

Fixed

• Neovim 0.9 compatibility layer: Missing nil checks [#32].

[3.3.0] - 2023-10-30

Added

• DAP: Auto-generate source map, to allow stepping into std.

[3.2.1] - 2023-10-29

Fixed

• dap/quickfix executor: Fix setting cwd for shell commands.

[3.2.0] - 2023-10-29

Added

• Completions for :RustLsp subcommands' arguments.

Changed

• Removed plenary.nvim dependency (dap and quickfix executor). This plugin now has no plenary.nvim dependencies left. NOTE: As this does not lead to a bump in the minimal requirements, this is not a breaking change.

[3.1.1] - 2023-10-28

Fixed

• Remove accidental use of Neovim nightly API (dap, crateGraph, explainError) [#26].
• Add static type checking for Neovim stable API.

[3.1.0] - 2023-10-28

Added

• :RustLsp explainError command, uses rustc --explain on error diagnostics with an error code.
• :RustLsp rebuildProcMacros command.

Fixed

• Health check got stuck if lldb-vscode was installed.

[3.0.4] - 2023-10-25

Fixed

• Allow :RustLsp hover range to accept a range.
• Fix :RustLsp crateGraph passing arguments as list.

[3.0.3] - 2023-10-25

Fixed

• Potential attempt to index nil upvalue when sending workspace/didChangeWorkspaceFolders to LSP server [#22].

[3.0.2] - 2023-10-23

Fixed

• Hover actions: Tree-sitter syntax highlighting in Neovim 0.9 [#20].

[3.0.1] - 2023-10-23

Fixed

• Add support for workspace/didChangeWorkspaceFolders to prevent more than one rust-analyzer server from spawning per Neovim instance [#7].
• Neovim 0.9 compatibility [#9].

[3.0.0] - 2023-10-22

Changed

• Renamed this plugin to rustaceanvim, to avoid potential clashes with vxpm/ferris.nvim, vxpm/ferris.nvim was created just before I renamed my fork (but after I had checked the web for name clashes (╯°□°)╯︵ ┻━┻).

[2.1.1] - 2023-10-22

Fixed

• Open external docs: Use xdg-open or open (MacOS) by default and fall back to netrw. Remove redundant URL encoding.

[2.1.0] - 2023-10-22

Added

• Add a vim.g.rustaceanvim.server.auto_attach option, which can be a boolean or a fun():boolean that determines whether or not to auto-attach the LSP client when opening a Rust file.

Fixed

• [Internal] Type safety in RustLsp command construction. This fixes a type error in the hover command validation.
• Failure to start on standalone files if cargo is not installed.

[2.0.0] - 2023-10-21

BREAKING CHANGES

• Don't pollute the command space: Use a single command with subcommands and completions.
  • RustAnalyzer [start|stop] (always available in Rust projects)
  • RustLsp [subcommand] (available when the LSP client is running) e.g. RustLsp moveItem [up|down]

[1.0.1] - 2023-10-21

Fixed

• Hover actions + command cache: module requires.

[1.0.0] - 2023-10-21

Added

• Initial release of rustaceanvim.
• :RustSyntaxTree and :RustFlyCheck commands.
• :RustAnalyzerStart and :RustAnalyzerStop commands.
• Config validation.
• Health checks (:checkhealth rustaceanvim).
• Vimdocs (auto-generated from Lua docs - :help rustaceanvim).
• Nix flake.
• Allow tools.executor to be a string.
• LuaRocks releases.
• Minimal config for troubleshooting.

Internal

• Added type annotations.
• Nix CI and linting infrastructure and static type checking.
• Lazy load command modules.

Fixed

• Numerous potential bugs encountered during rewrite.
• Erroneous semantic token highlights.
• Make sure we only send LSP requests to the correct client.

BREAKING CHANGES compared to rust-tools.nvim

• Removed the setup function and revamped the architecture to be less prone to type errors. This plugin is a filetype plugin and works out of the box. The default configuration should work for most people, but it can be configured with a vim.g.rustaceanvim table.
• Removed the lspconfig dependency. This plugin now uses the built-in LSP client API. You can use :RustAnalyzerStart and :RustAnalyzerStop to manually start/stop the LSP client. This plugin auto-starts the client when opening a rust file, if the rust-analyzer binary is found.
• Removed rt = require('rust-tools') table. You can access the commands using Neovim's vim.cmd Lua bridge, for example :lua vim.cmd.RustSSR() or :RustSSR [This has changed! See above.].
• Bumped minimum Neovim version to 0.9.
• Removed inlay hints, as this feature will be built into Neovim 0.10.