1 # rustfmt [![Build Status](https://travis-ci.org/rust-lang-nursery/rustfmt.svg)](https://travis-ci.org/rust-lang-nursery/rustfmt)
3 A tool for formatting Rust code according to style guidelines.
5 If you'd like to help out (and you should, it's a fun project!), see
6 [Contributing.md](Contributing.md).
11 > **Note:** this method currently requires you to be running cargo 0.6.0 or
15 cargo install --git https://github.com/rust-lang-nursery/rustfmt
18 or if you're using [`multirust`](https://github.com/brson/multirust)
21 multirust run nightly cargo install --git https://github.com/rust-lang-nursery/rustfmt
25 ## Running Rustfmt from your editor
27 * [Vim](http://johannh.me/blog/rustfmt-vim.html)
28 * [Emacs](https://github.com/fbergroth/emacs-rustfmt)
29 * [Sublime Text 3](https://packagecontrol.io/packages/BeautifyRust)
33 ## How to build and test
35 First make sure you've got Rust **1.4.0** or greater available, then:
37 `cargo build` to build.
39 `cargo test` to run all tests.
41 `cargo run -- filename` to run on a file, if the file includes out of line
42 modules, then we reformat those too. So to run on a whole module or crate, you
43 just need to run on the top file.
45 You'll probably want to specify the write mode. Currently, there are the
46 replace, overwrite, display and coverage modes. The replace mode is the default
47 and overwrites the original files after renaming them. In overwrite mode,
48 rustfmt does not backup the source files. To print the output to stdout, use the
49 display mode. The write mode can be set by passing the `--write-mode` flag on
52 `cargo run -- filename --write-mode=display` prints the output of rustfmt to the
56 ## What style does Rustfmt use?
58 Rustfmt is designed to be very configurable. You can create a TOML file called
59 rustfmt.toml, place it in the project directory and it will apply the options
60 in that file. See `cargo run -- --config-help` for the options which are available,
61 or if you prefer to see source code, [src/config.rs].
63 By default, Rustfmt uses a style which (mostly) conforms to the
64 [Rust style guidelines](https://github.com/rust-lang/rust/tree/master/src/doc/style).
65 There are many details which the style guidelines do not cover, and in these
66 cases we try to adhere to a style similar to that used in the
67 [Rust repo](https://github.com/rust-lang/rust). Once Rustfmt is more complete, and
68 able to re-format large repositories like Rust, we intend to go through the Rust
69 RFC process to nail down the default style in detail.
71 If there are styling choices you don't agree with, we are usually happy to add
72 options covering different styles. File an issue, or even better, submit a PR.
77 * For things you do not want rustfmt to mangle, use one of
81 #[cfg_attr(rustfmt, rustfmt_skip)]
83 * When you run rustfmt, place a file named rustfmt.toml in target file
84 directory or its parents to override the default settings of rustfmt.
85 * After successful compilation, a `rustfmt` executable can be found in the