README.md

   1 # rustfmt [![Build Status](https://travis-ci.org/rust-lang-nursery/rustfmt.svg)](https://travis-ci.org/rust-lang-nursery/rustfmt)
   2
   3 A tool for formatting Rust code according to style guidelines.
   4
   5 If you'd like to help out (and you should, it's a fun project!), see
   6 [Contributing.md](Contributing.md).
   7
   8 ## Quick start
   9
  10 To install:
  11
  12 ```
  13 cargo install rustfmt
  14 ```
  15
  16 to run on a cargo project in the current working directory:
  17
  18 ```
  19 cargo fmt
  20 ```
  21
  22 ## Installation
  23
  24 > **Note:** this method currently requires you to be running cargo 0.6.0 or
  25 > newer.
  26
  27 ```
  28 cargo install rustfmt
  29 ```
  30
  31 or if you're using [`multirust`](https://github.com/brson/multirust)
  32
  33 ```
  34 multirust run nightly cargo install rustfmt
  35 ```
  36
  37 Usually cargo-fmt, which enables usage of Cargo subcommand `cargo fmt`, is
  38 installed alongside rustfmt. To only install rustfmt run
  39
  40 ```
  41 cargo install --no-default-features rustfmt
  42 ```
  43
  44 ## Running
  45
  46 You can run Rustfmt by just typing `rustfmt filename` if you used `cargo
  47 install`. This runs rustfmt on the given file, if the file includes out of line
  48 modules, then we reformat those too. So to run on a whole module or crate, you
  49 just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also
  50 read data from stdin. Alternatively, you can use `cargo fmt` to format all
  51 binary and library targets of your crate.
  52
  53 You'll probably want to specify the write mode. Currently, there are modes for
  54 diff, replace, overwrite, display, coverage, and checkstyle.
  55
  56 * `replace` Is the default and overwrites the original files after creating backups of the files.
  57 * `overwrite` Overwrites the original files _without_ creating backups.
  58 * `display` Will print the formatted files to stdout.
  59 * `diff` Will print a diff between the original files and formatted files to stdout.
  60 * `checkstyle` Will output the lines that need to be corrected as a checkstyle XML file,
  61   that can be used by tools like Jenkins.
  62
  63 The write mode can be set by passing the `--write-mode` flag on
  64 the command line. For example `rustfmt --write-mode=display src/filename.rs`
  65
  66 `cargo fmt` uses `--write-mode=replace` by default.
  67
  68 If `rustfmt` successfully reformatted the code it will exit with `0` exit
  69 status. Exit status `1` signals some unexpected error, like an unknown option or
  70 a failure to read a file. Exit status `2` is returned if there are syntax errors
  71 in the input files. `rustfmt` can't format syntatically invalid code. Finally,
  72 exit status `3` is returned if there are some issues which can't be resolved
  73 automatically. For example, if you have a very long comment line `rustfmt`
  74 doesn't split it. Instead it prints a warning and exits with `3`.
  75
  76 You can run `rustfmt --help` for more information.
  77
  78
  79 ## Running Rustfmt from your editor
  80
  81 * [Vim](http://johannh.me/blog/rustfmt-vim.html)
  82 * [Emacs](https://github.com/fbergroth/emacs-rustfmt)
  83 * [Sublime Text 3](https://packagecontrol.io/packages/BeautifyRust)
  84 * [Atom](atom.md)
  85 * Visual Studio Code using [RustyCode](https://github.com/saviorisdead/RustyCode) or [vsc-rustfmt](https://github.com/Connorcpu/vsc-rustfmt)
  86
  87 ## How to build and test
  88
  89 `cargo build` to build.
  90
  91 `cargo test` to run all tests.
  92
  93 To run rustfmt after this, use `cargo run --bin rustfmt -- filename`. See the
  94 notes above on running rustfmt.
  95
  96
  97 ## Configuring Rustfmt
  98
  99 Rustfmt is designed to be very configurable. You can create a TOML file called
 100 rustfmt.toml, place it in the project directory and it will apply the options
 101 in that file. See `rustfmt --config-help` for the options which are available,
 102 or if you prefer to see source code, [src/config.rs](src/config.rs).
 103
 104 By default, Rustfmt uses a style which (mostly) conforms to the
 105 [Rust style guidelines](https://github.com/rust-lang/rust/tree/master/src/doc/style).
 106 There are many details which the style guidelines do not cover, and in these
 107 cases we try to adhere to a style similar to that used in the
 108 [Rust repo](https://github.com/rust-lang/rust). Once Rustfmt is more complete, and
 109 able to re-format large repositories like Rust, we intend to go through the Rust
 110 RFC process to nail down the default style in detail.
 111
 112 If there are styling choices you don't agree with, we are usually happy to add
 113 options covering different styles. File an issue, or even better, submit a PR.
 114
 115
 116 ## Gotchas
 117
 118 * For things you do not want rustfmt to mangle, use one of
 119
 120     ```rust
 121     #[rustfmt_skip]  // requires nightly and #![feature(custom_attribute)] in crate root
 122     #[cfg_attr(rustfmt, rustfmt_skip)]  // works in stable
 123     ```
 124 * When you run rustfmt, place a file named rustfmt.toml in target file
 125   directory or its parents to override the default settings of rustfmt.
 126 * After successful compilation, a `rustfmt` executable can be found in the
 127   target directory.