# RustFormat

A simple plugin to format Rust code.

## Prerequisites

This package relies on the amazing [rustfmt](https://github.com/rust-lang-nursery/rustfmt) to format Rust source code files.

Install with [Cargo](https://crates.io/) using `cargo install rustfmt` or via instructions on the [website](https://github.com/rust-lang-nursery/rustfmt#installation).

## Installation

#### Package Control

1. Install [Package Control](https://packagecontrol.io/)
2. Run `Package Control: Install Package` in the Command Palette (<kbd>Super+Shift+P</kbd>)
3. Install `RustFormat`

#### Manual

1. Navigate to the Sublime Text package directory
2. Clone the repository

        $ git clone https://github.com/Rypac/sublime-rust-format.git RustFormat

## Commands

- `RustFormat: Format Selection`
    + Format the current selection
- `RustFormat: Format File` (<kbd>Ctrl+k</kbd>, <kbd>Ctrl+f</kbd>)
    + Format the current file
- `RustFormat: Enable Format on Save`
    + Enable automatic formatting of Rust source files on save
- `RustFormat: Disable Format on Save`
    + Disable automatic formatting of Rust source files on save

## Configuration

- `rust_format_on_save`
    + Automatically format files on save
- `rust_format_binary`
    + Full path to `rustfmt` binary (if not on `PATH`)