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 ## Installing from source
  44
  45 To install from source, first checkout to the tag or branch you want to install, then issue
  46 ```
  47 cargo install --path  .
  48 ```
  49 This will install `rustfmt` in your `~/.cargo/bin`. Make sure to add `~/cargo/bin` directory to
  50 your PATH variable.
  51
  52 ## Running
  53
  54 You can run Rustfmt by just typing `rustfmt filename` if you used `cargo
  55 install`. This runs rustfmt on the given file, if the file includes out of line
  56 modules, then we reformat those too. So to run on a whole module or crate, you
  57 just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also
  58 read data from stdin. Alternatively, you can use `cargo fmt` to format all
  59 binary and library targets of your crate.
  60
  61 You'll probably want to specify the write mode. Currently, there are modes for
  62 diff, replace, overwrite, display, coverage, and checkstyle.
  63
  64 * `replace` Is the default and overwrites the original files after creating backups of the files.
  65 * `overwrite` Overwrites the original files _without_ creating backups.
  66 * `display` Will print the formatted files to stdout.
  67 * `diff` Will print a diff between the original files and formatted files to stdout.
  68 * `checkstyle` Will output the lines that need to be corrected as a checkstyle XML file,
  69   that can be used by tools like Jenkins.
  70
  71 The write mode can be set by passing the `--write-mode` flag on
  72 the command line. For example `rustfmt --write-mode=display src/filename.rs`
  73
  74 `cargo fmt` uses `--write-mode=replace` by default.
  75
  76 If `rustfmt` successfully reformatted the code it will exit with `0` exit
  77 status. Exit status `1` signals some unexpected error, like an unknown option or
  78 a failure to read a file. Exit status `2` is returned if there are syntax errors
  79 in the input files. `rustfmt` can't format syntatically invalid code. Finally,
  80 exit status `3` is returned if there are some issues which can't be resolved
  81 automatically. For example, if you have a very long comment line `rustfmt`
  82 doesn't split it. Instead it prints a warning and exits with `3`.
  83
  84 You can run `rustfmt --help` for more information.
  85
  86
  87 ## Running Rustfmt from your editor
  88
  89 * [Vim](http://johannh.me/blog/rustfmt-vim.html)
  90 * [Emacs](https://github.com/fbergroth/emacs-rustfmt)
  91 * [Sublime Text 3](https://packagecontrol.io/packages/BeautifyRust)
  92 * [Atom](atom.md)
  93 * Visual Studio Code using [RustyCode](https://github.com/saviorisdead/RustyCode) or [vsc-rustfmt](https://github.com/Connorcpu/vsc-rustfmt)
  94
  95 ## How to build and test
  96
  97 `cargo build` to build.
  98
  99 `cargo test` to run all tests.
 100
 101 To run rustfmt after this, use `cargo run --bin rustfmt -- filename`. See the
 102 notes above on running rustfmt.
 103
 104
 105 ## Configuring Rustfmt
 106
 107 Rustfmt is designed to be very configurable. You can create a TOML file called
 108 rustfmt.toml, place it in the project directory and it will apply the options
 109 in that file. See `rustfmt --config-help` for the options which are available,
 110 or if you prefer to see source code, [src/config.rs](src/config.rs).
 111
 112 By default, Rustfmt uses a style which (mostly) conforms to the
 113 [Rust style guidelines](https://github.com/rust-lang/rust/tree/master/src/doc/style).
 114 There are many details which the style guidelines do not cover, and in these
 115 cases we try to adhere to a style similar to that used in the
 116 [Rust repo](https://github.com/rust-lang/rust). Once Rustfmt is more complete, and
 117 able to re-format large repositories like Rust, we intend to go through the Rust
 118 RFC process to nail down the default style in detail.
 119
 120 If there are styling choices you don't agree with, we are usually happy to add
 121 options covering different styles. File an issue, or even better, submit a PR.
 122
 123
 124 ## Tips
 125
 126 * For things you do not want rustfmt to mangle, use one of
 127
 128     ```rust
 129     #[rustfmt_skip]  // requires nightly and #![feature(custom_attribute)] in crate root
 130     #[cfg_attr(rustfmt, rustfmt_skip)]  // works in stable
 131     ```
 132 * When you run rustfmt, place a file named rustfmt.toml in target file
 133   directory or its parents to override the default settings of rustfmt.
 134 * After successful compilation, a `rustfmt` executable can be found in the
 135   target directory.
 136 * If you're having issues compiling Rustfmt (or compile errors when trying to
 137   install), make sure you have the most recent version of Rust installed.
 138
 139
 140 ## License
 141
 142 Rustfmt is distributed under the terms of both the MIT license and the
 143 Apache License (Version 2.0).
 144
 145 See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.