Sublime Text plugin that formats Rust code with rustfmt
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
messages
.gitignore
Main.sublime-menu
RustFmt.py
RustFmt.sublime-commands
RustFmt.sublime-settings
messages.json
readme.md

readme.md

Overview

RustFmt is a Sublime Text 3 plugin that auto-formats Rust code with rustfmt or another executable.

Unlike BeautifyRust, it's fast and works on buffers that have yet not been saved as files. Unlike RustFormat, it preserves the buffer scroll position. It also supports rustfmt.toml.

Dependencies

Requires Sublime Text version 3124 or later.

Requires rustfmt to be on PATH. Installation:

rustup component add rustfmt

Installation

Package Control

  1. Get Package Control
  2. Open command palette: Shift+Super+P or Shift+Ctrl+P
  3. Package Control: Install Package
  4. RustFmt

Manual

  1. Open Sublime Text menu → Preferences → Browse Packages. This should open the packages folder in your OS file manager.

  2. Clone repo:

git clone https://github.com/mitranim/sublime-rust-format.git RustFmt

Usage

By default, RustFmt will autoformat files before saving. You can trigger it manually with the RustFmt: Format Buffer command in the command palette.

If the plugin can't find the executable:

  • run which rustfmt to get the absolute executable path
  • set it as the executable setting, see Settings below

On MacOS, it might end up like this:

  "executable": ["/Users/username/.cargo/bin/rustfmt"]

Can pass additional arguments:

  "executable": ["rustup", "run", "nightly", "rustfmt"]

Settings

See RustFmt.sublime-settings for all available settings. To override them, open:

Preferences → Package Settings → RustFmt → Settings

RustFmt looks for settings in the following places:

  • "RustFmt" dict in general Sublime settings, possibly project-specific
  • RustFmt.sublime-settings, default or user-created

The general Sublime settings take priority. To override them on a per-project basis, create a "RustFmt" entry:

  "RustFmt": {
    "format_on_save": false
  },

Commands

In Sublime's command palette:

  • RustFmt: Format Buffer

Hotkeys

To avoid potential conflicts, this plugin does not come with hotkeys. To hotkey the format command, add something like this to your .sublime-keymap:

{
  "keys": ["ctrl+super+k"],
  "command": "rust_fmt_format_buffer",
  "context": [
    {
      "key": "selector",
      "operator": "equal",
      "operand": "source.rust"
    }
  ]
}

License

https://en.wikipedia.org/wiki/WTFPL