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 635
  • OS X 774
  • Linux 837
Dec 10 Dec 9 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
Windows 2 1 2 1 5 3 2 1 1 3 1 2 0 3 0 2 0 1 0 1 0 1 3 0 1 1 1 1 2 2 0 1 4 0 3 1 1 0 0 1 1 0 1 1 1 0
OS X 1 1 3 5 3 3 0 3 5 3 1 2 0 1 2 1 0 0 1 5 1 0 2 1 5 1 1 2 2 4 1 1 2 2 6 0 1 2 0 5 1 0 1 3 0 5
Linux 4 4 1 3 5 2 3 3 4 2 3 1 2 1 0 0 0 1 1 9 4 2 0 2 4 1 1 1 4 3 3 3 2 4 2 0 3 1 0 2 2 2 2 2 5 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 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

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

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

License

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