RustaceanVim 项目技术文档

RustaceanVim 项目技术文档

rustaceanvim Supercharge your Rust experience in Neovim! A heavily modified fork of rust-tools.nvim rustaceanvim 项目地址: https://gitcode.com/gh_mirrors/ru/rustaceanvim

1. 安装指南

1.1 前提条件

必需
可选
  • dot from graphviz,用于 crate 图。
  • cargo,对于 Cargo 项目是必需的。
  • 调试适配器(例如 lldbcodelldb)和 nvim-dap,用于调试。
  • Rust 的 tree-sitter 解析器,用于 :Rustc unpretty 命令。可以通过 nvim-treesitter 安装。

1.2 安装方法

使用 rocks.nvim
:Rocks install rustaceanvim
使用 lazy.nvim
{
  'mrcjkb/rustaceanvim',
  version = '^5', -- 推荐
  lazy = false, -- 该插件已经是懒加载的
}
使用 Nix

对于启用了 flakes 的 Nix 用户,该项目提供了一个包和一个 overlay。也可以在 nixpkgs 中找到。

2. 项目使用说明

2.1 快速设置

该插件会自动配置 rust-analyzer 内置的 LSP 客户端,并与其他 Rust 工具集成。无需手动调用 setup 函数或进行任何配置。

2.2 功能与使用

调试
  • debuggables:打开一个提示,从中选择可用的目标。
  • debug:在当前光标位置搜索目标。
:RustLsp[!] debuggables {args[]}?
:RustLsp[!] debug {args[]}?
vim.cmd.RustLsp('debug')
vim.cmd.RustLsp('debuggables')
Runnables
  • runnables:打开一个提示,从中选择可用的目标。
  • run:在当前光标位置搜索目标。
:RustLsp[!] runnables {args[]}?
:RustLsp[!] run {args[]}?
vim.cmd.RustLsp('run') 
vim.cmd.RustLsp('runnables')
Testables 和失败测试诊断
  • testables:打开一个提示,从中选择可用的目标。
:RustLsp[!] testables {args[]}?
vim.cmd.RustLsp('testables')
Neotest 集成

该插件提供了一个 neotest 适配器,可以按如下方式添加到 neotest 中:

require('neotest').setup {
    adapters = {
        require('rustaceanvim.neotest')
    },
}

3. 项目API使用文档

3.1 主要API

  • RustLsp:用于执行与 rust-analyzer 相关的命令。
    • debuggables:列出可调试的目标。
    • debug:调试当前光标位置的目标。
    • runnables:列出可运行的目标。
    • run:运行当前光标位置的目标。
    • testables:列出可测试的目标。

3.2 配置选项

  • vim.g.rustaceanvim.dap.autoload_configurations:是否自动加载调试配置。
  • vim.g.rustaceanvim.tools.test_executor:测试执行器类型。

4. 项目安装方式

4.1 使用 rocks.nvim

:Rocks install rustaceanvim

4.2 使用 lazy.nvim

{
  'mrcjkb/rustaceanvim',
  version = '^5', -- 推荐
  lazy = false, -- 该插件已经是懒加载的
}

4.3 使用 Nix

对于启用了 flakes 的 Nix 用户,该项目提供了一个包和一个 overlay。也可以在 nixpkgs 中找到。

rustaceanvim Supercharge your Rust experience in Neovim! A heavily modified fork of rust-tools.nvim rustaceanvim 项目地址: https://gitcode.com/gh_mirrors/ru/rustaceanvim

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

谢敏栋

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值