ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Rust​Fmt

by Nelo Mitranim ST3

Sublime Text plugin that formats Rust code with rustfmt

Labels rust, fmt, format, beautify

Details

Installs

  • Total 10K
  • Win 3K
  • Mac 3K
  • Linux 4K
Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24
Windows 0 1 3 3 2 0 5 3 3 1 4 0 0 6 1 2 2 2 0 1 1 2 1 1 5 0 3 2 1 0 1 3 2 2 1 2 0 2 1 0 2 1 0 0 1 1
Mac 0 3 1 3 2 2 2 2 1 1 5 2 2 1 0 2 1 0 1 3 4 0 1 1 4 0 1 1 1 1 2 1 4 3 2 0 1 2 2 0 3 1 2 2 1 3
Linux 0 1 3 1 3 1 1 6 2 2 0 0 3 1 5 1 0 1 1 1 3 5 2 2 2 3 3 1 3 1 0 4 3 4 5 1 1 3 3 3 1 1 2 3 1 5

Readme

Source
raw.​githubusercontent.​com

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

Clone the repo:

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

Then symlink it to your Sublime packages directory. Example for MacOS:

mv sublime-rust-fmt RustFmt
cd RustFmt
ln -sf "$(pwd)" "$HOME/Library/Application Support/Sublime Text 3/Packages/"

To find the packages directory, use Sublime Text menu → Preferences → Browse Packages.

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:

Error: language “sublime-settings” is not supported
"executable": ["/Users/username/.cargo/bin/rustfmt"]

Can pass additional arguments:

Error: language “sublime-settings” is not supported
"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:

Error: language “sublime-settings” is not supported
"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:

Error: language “sublime-keymap” is not supported
{
  "keys": ["ctrl+super+k"],
  "command": "rust_fmt_format_buffer",
  "context": [{"key": "selector", "operator": "equal", "operand": "source.rust"}]
}

License

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