README.md

   1 # rustfmt [![Build Status](https://travis-ci.org/rust-lang-nursery/rustfmt.svg)](https://travis-ci.org/rust-lang-nursery/rustfmt) [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rustfmt?svg=true)](https://ci.appveyor.com/project/nrc/rustfmt) [![crates.io](https://img.shields.io/crates/v/rustfmt-nightly.svg)](https://crates.io/crates/rustfmt-nightly) [![Travis Configuration Status](https://img.shields.io/travis/davidalber/rustfmt-travis.svg?label=travis%20example)](https://travis-ci.org/davidalber/rustfmt-travis)
   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 We are changing the default style used by rustfmt. There is an ongoing [RFC
   9 process][fmt rfcs]. The last version using the old style was 0.8.6. From 0.9
  10 onwards, the RFC style is the default. If you want the old style back, you can
  11 use [legacy-rustfmt.toml](legacy-rustfmt.toml) as your rustfmt.toml.
  12
  13 The current `master` branch uses libsyntax (part of the compiler). It is
  14 published as `rustfmt-nightly`. The `syntex` branch uses Syntex instead of
  15 libsyntax, it is published (for now) as `rustfmt`. Most development happens on
  16 the `master` branch, however, this only supports nightly toolchains. If you use
  17 stable or beta Rust toolchains, you must use the Syntex version (which is likely
  18 to be a bit out of date). Version 0.1 of rustfmt-nightly is forked from version
  19 0.9 of the syntex branch.
  20
  21 You can use rustfmt in Travis CI builds. We provide a minimal Travis CI
  22 configuration (see [here](#checking-style-on-a-ci-server)) and verify its status
  23 using another repository. The status of that repository's build is reported by
  24 the "travis example" badge above.
  25
  26
  27 ## Quick start
  28
  29 Currently, you can use `rustfmt` on nightly and beta. Rust 1.24 stable will work,
  30 but we're not quite there yet!
  31
  32 To install:
  33
  34 ```
  35 rustup component add rustfmt-preview --toolchain=nightly
  36 ```
  37
  38 If `nightly` is your default toolchain, you can leave the `--toolchain` off.
  39
  40 to run on a cargo project in the current working directory:
  41
  42 ```
  43 cargo +nightly fmt
  44 ```
  45
  46 If `nightly` is your default toolchain, you can leave off the `+nightly`.
  47
  48 ## Installation
  49
  50 ```
  51 rustup component add rustfmt-preview --toolchain=nightly
  52 ```
  53
  54 If you don't have a nightly toolchain, you can add it using rustup:
  55
  56 ```
  57 rustup install nightly
  58 ```
  59
  60 You can make the nightly toolchain the default by running:
  61
  62 ```
  63 rustup default nightly
  64 ```
  65
  66 If you choose not to do that you'll have to run rustfmt using `rustup run ...`
  67 or by adding `+nightly` to the cargo invocation.
  68
  69 ## Installing from source
  70
  71 To install from source, first checkout to the tag or branch you want to install, then issue
  72 ```
  73 cargo install --path  .
  74 ```
  75
  76 This will install `rustfmt` in your `~/.cargo/bin`. Make sure to add `~/.cargo/bin` directory to
  77 your PATH variable.
  78
  79
  80 ## Running
  81
  82 You can run Rustfmt by just typing `rustfmt filename` if you used `cargo
  83 install`. This runs rustfmt on the given file, if the file includes out of line
  84 modules, then we reformat those too. So to run on a whole module or crate, you
  85 just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also
  86 read data from stdin. Alternatively, you can use `cargo fmt` to format all
  87 binary and library targets of your crate.
  88
  89 You'll probably want to specify the write mode. Currently, there are modes for
  90 `diff`, `replace`, `overwrite`, `display`, `coverage`, `checkstyle`, and `plain`.
  91
  92 * `overwrite` Is the default and overwrites the original files _without_ creating backups.
  93 * `replace` Overwrites the original files after creating backups of the files.
  94 * `display` Will print the formatted files to stdout.
  95 * `plain` Also writes to stdout, but with no metadata.
  96 * `diff` Will print a diff between the original files and formatted files to stdout.
  97          Will also exit with an error code if there are any differences.
  98 * `checkstyle` Will output the lines that need to be corrected as a checkstyle XML file,
  99   that can be used by tools like Jenkins.
 100
 101 The write mode can be set by passing the `--write-mode` flag on
 102 the command line. For example `rustfmt --write-mode=display src/filename.rs`
 103
 104 `cargo fmt` uses `--write-mode=overwrite` by default.
 105
 106 If you want to restrict reformatting to specific sets of lines, you can
 107 use the `--file-lines` option. Its argument is a JSON array of objects
 108 with `file` and `range` properties, where `file` is a file name, and
 109 `range` is an array representing a range of lines like `[7,13]`. Ranges
 110 are 1-based and inclusive of both end points. Specifying an empty array
 111 will result in no files being formatted. For example,
 112
 113 ```
 114 rustfmt --file-lines '[
 115     {"file":"src/lib.rs","range":[7,13]},
 116     {"file":"src/lib.rs","range":[21,29]},
 117     {"file":"src/foo.rs","range":[10,11]},
 118     {"file":"src/foo.rs","range":[15,15]}]'
 119 ```
 120
 121 would format lines `7-13` and `21-29` of `src/lib.rs`, and lines `10-11`,
 122 and `15` of `src/foo.rs`. No other files would be formatted, even if they
 123 are included as out of line modules from `src/lib.rs`.
 124
 125 If `rustfmt` successfully reformatted the code it will exit with `0` exit
 126 status. Exit status `1` signals some unexpected error, like an unknown option or
 127 a failure to read a file. Exit status `2` is returned if there are syntax errors
 128 in the input files. `rustfmt` can't format syntactically invalid code. Finally,
 129 exit status `3` is returned if there are some issues which can't be resolved
 130 automatically. For example, if you have a very long comment line `rustfmt`
 131 doesn't split it. Instead it prints a warning and exits with `3`.
 132
 133 You can run `rustfmt --help` for more information.
 134
 135
 136 ## Running Rustfmt from your editor
 137
 138 * [Vim](https://github.com/rust-lang/rust.vim#formatting-with-rustfmt)
 139 * [Emacs](https://github.com/rust-lang/rust-mode)
 140 * [Sublime Text 3](https://packagecontrol.io/packages/RustFmt)
 141 * [Atom](atom.md)
 142 * Visual Studio Code using [vscode-rust](https://github.com/editor-rs/vscode-rust), [vsc-rustfmt](https://github.com/Connorcpu/vsc-rustfmt) or [rls_vscode](https://github.com/jonathandturner/rls_vscode) through RLS.
 143
 144 ## Checking style on a CI server
 145
 146 To keep your code base consistently formatted, it can be helpful to fail the CI build
 147 when a pull request contains unformatted code. Using `--write-mode=diff` instructs
 148 rustfmt to exit with an error code if the input is not formatted correctly.
 149 It will also print any found differences.
 150
 151 A minimal Travis setup could look like this:
 152
 153 ```yaml
 154 language: rust
 155 before_script:
 156 - rustup toolchain install nightly
 157 - rustup component add --toolchain nightly rustfmt-preview
 158 - which rustfmt || cargo install --force rustfmt-nightly
 159 script:
 160 - cargo +nightly fmt --all -- --write-mode=diff
 161 - cargo build
 162 - cargo test
 163 ```
 164
 165 ## How to build and test
 166
 167 `cargo build` to build.
 168
 169 `cargo test` to run all tests.
 170
 171 To run rustfmt after this, use `cargo run --bin rustfmt -- filename`. See the
 172 notes above on running rustfmt.
 173
 174
 175 ## Configuring Rustfmt
 176
 177 Rustfmt is designed to be very configurable. You can create a TOML file called
 178 `rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent
 179 directory and it will apply the options in that file. See `rustfmt
 180 --config-help` for the options which are available, or if you prefer to see
 181 visual style previews, [Configurations.md](Configurations.md).
 182
 183 By default, Rustfmt uses a style which conforms to the [Rust style guide][style
 184 guide] that has been formalized through the [style RFC
 185 process][fmt rfcs].
 186
 187 Configuration options are either stable or unstable. Stable options can always
 188 be used, while unstable ones are only available on a nightly toolchain, and opt-in.
 189 See [Configurations.md](Configurations.md) for details.
 190
 191
 192 ## Tips
 193
 194 * For things you do not want rustfmt to mangle, use one of
 195
 196     ```rust
 197     #[rustfmt_skip]  // requires nightly and #![feature(custom_attribute)] in crate root
 198     #[cfg_attr(rustfmt, rustfmt_skip)]  // works in stable
 199     ```
 200 * When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
 201   target file directory or its parents to override the default settings of
 202   rustfmt. You can generate a file containing the default configuration with
 203   `rustfmt --dump-default-config rustfmt.toml` and customize as needed.
 204 * After successful compilation, a `rustfmt` executable can be found in the
 205   target directory.
 206 * If you're having issues compiling Rustfmt (or compile errors when trying to
 207   install), make sure you have the most recent version of Rust installed.
 208
 209 * If you get an error like `error while loading shared libraries` while starting
 210   up rustfmt you should try the following:
 211
 212   On Linux:
 213
 214   ```
 215   export LD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$LD_LIBRARY_PATH
 216   ```
 217
 218   On MacOS:
 219
 220   ```
 221   export DYLD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$DYLD_LIBRARY_PATH
 222   ```
 223
 224   On Windows (Git Bash/Mingw):
 225
 226   ```
 227   export PATH=$(rustc --print sysroot)/lib/rustlib/x86_64-pc-windows-gnu/lib/:$PATH
 228   ```
 229
 230   (Substitute `x86_64` by `i686` and `gnu` by `msvc` depending on which version of rustc was used to install rustfmt).
 231
 232 ## License
 233
 234 Rustfmt is distributed under the terms of both the MIT license and the
 235 Apache License (Version 2.0).
 236
 237 See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
 238
 239 [rust]: https://github.com/rust-lang/rust
 240 [fmt rfcs]: https://github.com/rust-lang-nursery/fmt-rfcs
 241 [style guide]: https://github.com/rust-lang-nursery/fmt-rfcs/blob/master/guide/guide.md