Rust / 系统课时

配置编辑器

配置编辑器

本课把 Rust 工具链接入编辑器,重点完成 rust-analyzer、自动补全、保存时格式化和 Clippy 检查。配置完成后,项目中的跳转、诊断和格式化会使用同一套 Cargo 环境,减少“编辑器正常、命令行失败”的差异。

学习目标

  • 安装并确认 VS Code 的 rust-analyzer 扩展
  • 配置 Rust 文件保存时格式化和自动检查
  • 用命令行与编辑器现象共同验证配置

安装 rust-analyzer

VS Code 用户可以通过命令行安装官方扩展。前提是 code 命令已经加入 PATH;若命令不可用,也可以在扩展面板中搜索 rust-analyzer,确认发布者和扩展标识为 rust-lang.rust-analyzer。

bash
code --install-extension rust-lang.rust-analyzer
code --list-extensions

预期输出

text
rust-lang.rust-analyzer

列表中可能还有其他扩展,只要能找到这一行即可。安装后应使用 Cargo 项目目录打开编辑器,而不是只打开单个 .rs 文件,否则 rust-analyzer 可能无法获得完整的包、依赖和构建目标信息。

配置项目级设置

在项目根目录创建 .vscode/settings.json。项目级设置会随仓库共享,适合统一格式化器和保存检查;个人主题、字体等偏好不应放入该文件。

json
{
  "[rust]": {
    "editor.defaultFormatter": "rust-lang.rust-analyzer",
    "editor.formatOnSave": true
  },
  "rust-analyzer.checkOnSave": true,
  "rust-analyzer.check.command": "clippy"
}

editor.formatOnSave 会在保存 Rust 文件时调用 rustfmt。rust-analyzer.check.command 设为 clippy 后,保存检查会在普通编译错误之外报告更多惯用法和潜在问题。

该配置依赖当前工具链提供 rustfmt 与 Clippy。若项目没有通过 rust-toolchain.toml 声明组件,可先执行安装命令。

bash
rustup component add rustfmt clippy
rustup component list --installed

预期输出

text
clippy-<HOST>
rustfmt-<HOST>

<HOST> 取决于操作系统和 CPU 架构,组件顺序也可能不同。

验证格式化与保存检查

先在项目根目录执行与编辑器相同的检查,确认工具链本身没有问题。

bash
cargo fmt -- --check
cargo clippy -- -D warnings

预期结果

text
两个命令均以退出码 0 结束;代码格式不一致或存在警告时会返回非 0。

随后打开 src/main.rs,故意打乱缩进并保存。代码应自动恢复为 rustfmt 风格;输入 std:: 时应出现补全候选;制造未使用变量后,问题面板应显示对应诊断。完成验证后删除测试代码,避免把人为警告留在项目中。

调整检查范围

大型工作区中,保存时运行全部目标可能较慢。先保留默认配置,只有确认延迟来自检查范围时,再按项目需要增加 rust-analyzer.check.allTargets、特性开关等设置。

不要同时启用多个 Rust 语言服务器或多个默认格式化器。旧的 RLS 扩展、第三方格式化扩展与 rust-analyzer 并存时,常见现象是重复诊断、保存两次或格式化器冲突。

排查编辑器无响应

没有补全时,先确认当前窗口打开的是含 Cargo.toml 的目录,再查看 rust-analyzer 输出日志。工具链切换后状态未刷新,可从命令面板执行 Rust Analyzer: Restart server。

格式化失败时,在终端运行 cargo fmt -- --check。若终端也失败,问题在工具链或代码;若终端成功而编辑器失败,重点检查默认格式化器、工作区设置覆盖和扩展冲突。这种顺序能避免反复重装扩展却没有触及根因。

本课总结

  • rust-analyzer 应在完整 Cargo 项目中工作,才能正确分析包、依赖和目标
  • 项目级 settings 可以统一保存格式化与 Clippy 检查行为
  • 先用 Cargo 命令验证工具链,再排查编辑器设置,定位效率更高

下一课预告

下一课将进入 Cargo 项目结构与常用命令,学习创建、构建、运行和检查一个标准 Rust 工程。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

配置编辑器

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通