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