RustRover 2025.3 Help

Rustfmt

Rustfmt 是一种用于强制执行标准 Rust 社区代码样式的格式化工具。

从 RustRover 2024.3 开始，Rustfmt 成为整个 Rust 文件与项目的默认格式化程序；代码段、文件组和目录仍将使用 内置 IDE 格式化程序 进行格式设置。 您可以 完全禁用 Rustfmt ，此时 RustRover 将对整个 Rust 文件与项目使用内置格式化程序。

启用（或禁用）Rustfmt 以代替内置格式化工具

  1. 按 Ctrl+Alt+S 打开设置并导航到 Rust | Rustfmt。

  2. 要启用 Rustfmt，选中 请使用 Rustfmt 替代内置格式化程序 复选框。 若要禁用 Rustfmt，请清除复选框。

    启用 rustfmt 替代内置格式化程序

  3. 点击 确定 以应用更改。

在保存时自动运行 Rustfmt

您可以配置 RustRover 在 Rust 文件 保存时运行 Rustfmt：

  1. 按 Ctrl+Alt+S 打开设置并导航到 Rust | Rustfmt。 。

  2. 请确保已选中 使用 Rustfmt 代替内置格式化程序 复选框。

  3. 点击 保存时配置操作 链接。

    启用保存时运行 rustfmt

  4. 选中 重新格式化代码 复选框。

    启用保存时重新格式化

  5. 点击 确定 以应用更改。

提交时运行 Rustfmt

如果您的项目在 版本控制下，您可以在提交更改至仓库时使用 Rustfmt 自动重新格式化代码。

  1. 按 Alt+0 打开 提交 工具窗口，然后点击 显示提交选项 设置按钮。

  2. 在 提交检查 菜单下，启用 运行rustfmt 选项。

启用该选项后，RustRover 将对您每次提交的文件运行 Rustfmt。 只要未禁用，该设置将在当前项目中保持启用状态。

高级提交选项弹出窗口

详细了解可在提交时执行的操作，请参阅 提交选项。

配置 Rustfmt 调用方式

按 Ctrl+Alt+S 打开设置并导航到 Rust | Rustfmt。 。

将 Rustfmt 设置为默认格式化程序

  • 如有必要，请为 Rustfmt 指定 附加参数。 所有可用选项列于 Rustfmt 文档 中。 如使用不稳定的选项，请确保添加 --unstable-features。

  • 选择首选的 Rustfmt 渠道 （stable、beta、nightly 或 dev），或允许 IDE 使用默认版本。

  • 如有需要，请设置自定义 环境变量。

点击 确定 以应用更改

使用 Rustfmt 进行格式设置

您可以手动运行 Rustfmt ——针对特定文件或 Cargo 项目。

使用 Rustfmt 重新格式化文件

  1. 打开您希望重新格式化的文件。

  2. 按 Ctrl+Alt+Shift+L 或从主菜单中选择 代码 | 格式化文件...。

  3. 在 文件重新格式化 对话框中，选择必要的作用域。 您还可以选择其他选项：

    • 优化import(O) ：如果您希望删除未使用的导入、添加缺失的导入或整理导入语句，请选择此选项。

    • 代码清理 ：选择此选项以运行代码清理检查。

    • 不保留换行符(B) ：根据代码样式设置重新格式化换行符。 此选项将覆盖 重新设置格式时保持 ｜ 换行符 设置。

    文件重格式化对话框

  4. 单击 运行。

重新格式化当前 Cargo 项目中的所有文件

打开您希望重新格式化的项目。 请执行以下操作之一：

  • 在主菜单中，进入 使用 Rustfmt 重新格式化 Cargo 项目.

  • 在编辑器中打开任意 Rust 文件，右键点击并选择 Rust | 使用 Rustfmt 重新格式化 Cargo 项目 以打开上下文菜单。

  • 打开 Cargo 工具窗口 （查看 | 工具窗口 | Cargo ），然后点击工具栏中的 使用 Rustfmt 重新格式化 Cargo 项目的图标。

最后修改日期： 2025年 12月 5日
内置格式化程序重构