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 2K
  • Win 556
  • OS X 655
  • Linux 697
Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10
Windows 0 2 1 0 2 0 1 0 0 1 0 1 1 0 1 0 0 1 0 1 0 2 1 0 3 2 2 0 1 0 1 2 1 3 0 1 2 0 1 0 1 0 1 4 1 0
OS X 0 1 2 2 3 0 5 0 1 1 1 1 2 1 6 2 1 1 1 8 3 2 1 2 0 2 1 1 1 1 1 4 5 4 2 5 1 1 2 1 2 2 2 3 9 1
Linux 0 6 4 4 3 1 0 2 2 0 2 1 0 3 0 1 3 3 2 0 0 0 1 0 1 3 0 2 2 4 3 1 2 1 2 1 1 1 2 3 1 3 0 4 2 2

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). Install it with Cargo:

cargo install 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 save. You can trigger it manually with the Ctrl+Super+k hotkey or 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 my MacOS system, the path looks like this:

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

executable also accepts a list of command line arguments:

Error: language “sublime-settings” is not supported
"executable": ["rustup", "run", "nightly", "rustfmt"]

Settings

See RustFmt.sublime-settings for all available settings. To see and override the settings in Sublime, 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

Open the command palette with Shift+Super+P or Shift+Ctrl+P.

  • RustFmt: Format Buffer (Ctrl+Super+k)