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 You can use rustfmt in Travis CI builds. We provide a minimal Travis CI
  10 configuration (see [here](#checking-style-on-a-ci-server)) and verify its status
  11 using another repository. The status of that repository's build is reported by
  12 the "travis example" badge above.
  13
  14 ## Quick start
  15
  16 You can run `rustfmt` with Rust 1.24 and above.
  17
  18 To install:
  19
  20 ```
  21 rustup component add rustfmt-preview
  22 ```
  23
  24 to run on a cargo project in the current working directory:
  25
  26 ```
  27 cargo fmt
  28 ```
  29
  30 For the latest and greatest `rustfmt` (nightly required):
  31 ```
  32 rustup component add rustfmt-preview --toolchain nightly
  33 ```
  34 To run:
  35 ```
  36 cargo +nightly fmt
  37 ```
  38
  39 ## Limitations
  40
  41 Rustfmt tries to work on as much Rust code as possible, sometimes, the code
  42 doesn't even need to compile! As we approach a 1.0 release we are also looking
  43 to limit areas of instability; in particular, post-1.0, the formatting of most
  44 code should not change as Rustfmt improves. However, there are some things that
  45 Rustfmt can't do or can't do well (and thus where formatting might change
  46 significantly, even post-1.0). We would like to reduce the list of limitations
  47 over time.
  48
  49 The following list enumerates areas where Rustfmt does not work or where the
  50 stability guarantees do not apply (we don't make a distinction between the two
  51 because in the future Rustfmt might work on code where it currently does not):
  52
  53 * a program where any part of the program does not parse (parsing is an early
  54   stage of compilation and in Rust includes macro expansion).
  55 * Macro declarations and uses (current status: some macro declarations and uses
  56   are formatted).
  57 * Comments, including any AST node with a comment 'inside' (Rustfmt does not
  58   currently attempt to format comments, it does format code with comments inside, but that formatting may change in the future).
  59 * Rust code in code blocks in comments.
  60 * Any fragment of a program (i.e., stability guarantees only apply to whole
  61   programs, even where fragments of a program can be formatted today).
  62 * Code containing non-ascii unicode characters (we believe Rustfmt mostly works
  63   here, but do not have the test coverage or experience to be 100% sure).
  64 * Bugs in Rustfmt (like any software, Rustfmt has bugs, we do not consider bug
  65   fixes to break our stability guarantees).
  66
  67
  68 ## Installation
  69
  70 ```
  71 rustup component add rustfmt-preview
  72 ```
  73
  74 ## Installing from source
  75
  76 To install from source (nightly required), first checkout to the tag or branch you want to install, then issue
  77
  78 ```
  79 cargo install --path .
  80 ```
  81
  82 This will install `rustfmt` in your `~/.cargo/bin`. Make sure to add `~/.cargo/bin` directory to
  83 your PATH variable.
  84
  85
  86 ## Running
  87
  88 You can run Rustfmt by just typing `rustfmt filename` if you used `cargo
  89 install`. This runs rustfmt on the given file, if the file includes out of line
  90 modules, then we reformat those too. So to run on a whole module or crate, you
  91 just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also
  92 read data from stdin. Alternatively, you can use `cargo fmt` to format all
  93 binary and library targets of your crate.
  94
  95 You can run `rustfmt --help` for information about argument.
  96
  97 When running with `--check`, Rustfmt will exit with `0` if Rustfmt would not
  98 make any formatting changes to the input, and `1` if Rustfmt would make changes.
  99 In other modes, Rustfmt will exit with `1` if there was some error during
 100 formatting (for example a parsing or internal error) and `0` if formatting
 101 completed without error (whether or not changes were made).
 102
 103
 104
 105 ## Running Rustfmt from your editor
 106
 107 * [Vim](https://github.com/rust-lang/rust.vim#formatting-with-rustfmt)
 108 * [Emacs](https://github.com/rust-lang/rust-mode)
 109 * [Sublime Text 3](https://packagecontrol.io/packages/RustFmt)
 110 * [Atom](atom.md)
 111 * 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.
 112 * [IntelliJ or CLion](intellij.md)
 113
 114
 115 ## Checking style on a CI server
 116
 117 To keep your code base consistently formatted, it can be helpful to fail the CI build
 118 when a pull request contains unformatted code. Using `--check` instructs
 119 rustfmt to exit with an error code if the input is not formatted correctly.
 120 It will also print any found differences. (Older versions of Rustfmt don't
 121 support `--check`, use `--write-mode diff`).
 122
 123 A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
 124
 125 ```yaml
 126 language: rust
 127 before_script:
 128 - rustup component add rustfmt-preview
 129 script:
 130 - cargo fmt --all -- --check
 131 - cargo build
 132 - cargo test
 133 ```
 134
 135 See [this blog post](https://medium.com/@ag_dubs/enforcing-style-in-ci-for-rust-projects-18f6b09ec69d)
 136 for more info.
 137
 138 ## How to build and test
 139
 140 `cargo build` to build.
 141
 142 `cargo test` to run all tests.
 143
 144 To run rustfmt after this, use `cargo run --bin rustfmt -- filename`. See the
 145 notes above on running rustfmt.
 146
 147
 148 ## Configuring Rustfmt
 149
 150 Rustfmt is designed to be very configurable. You can create a TOML file called
 151 `rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent
 152 directory and it will apply the options in that file. See `rustfmt
 153 --help=config` for the options which are available, or if you prefer to see
 154 visual style previews, [Configurations.md](Configurations.md).
 155
 156 By default, Rustfmt uses a style which conforms to the [Rust style guide][style
 157 guide] that has been formalized through the [style RFC
 158 process][fmt rfcs].
 159
 160 Configuration options are either stable or unstable. Stable options can always
 161 be used, while unstable ones are only available on a nightly toolchain, and opt-in.
 162 See [Configurations.md](Configurations.md) for details.
 163
 164
 165 ## Tips
 166
 167 * For things you do not want rustfmt to mangle, use one of
 168
 169     ```rust
 170     #[rustfmt::skip]  // requires nightly Rust and #![feature(tool_attributes)] in crate root
 171     #[cfg_attr(rustfmt, rustfmt_skip)]  // works in stable
 172     ```
 173 * When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
 174   target file directory or its parents to override the default settings of
 175   rustfmt. You can generate a file containing the default configuration with
 176   `rustfmt --print-config default rustfmt.toml` and customize as needed.
 177 * After successful compilation, a `rustfmt` executable can be found in the
 178   target directory.
 179 * If you're having issues compiling Rustfmt (or compile errors when trying to
 180   install), make sure you have the most recent version of Rust installed.
 181
 182 * You can change the way rustfmt emits the changes with the --emit flag:
 183
 184   Example:
 185
 186   ```
 187   cargo fmt -- --emit files
 188   ```
 189
 190   Options:
 191
 192   | Flag |Description| Nightly Only |
 193   |:---:|:---:|:---:|
 194   | files | overwrites output to files | No |
 195   | stdout | writes output to stdout | No |
 196   | coverage | displays how much of the input file was processed | Yes |
 197   | checkstyle | emits in a checkstyle format | Yes |
 198
 199 ## License
 200
 201 Rustfmt is distributed under the terms of both the MIT license and the
 202 Apache License (Version 2.0).
 203
 204 See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
 205
 206 [rust]: https://github.com/rust-lang/rust
 207 [fmt rfcs]: https://github.com/rust-lang-nursery/fmt-rfcs
 208 [style guide]: https://github.com/rust-lang-nursery/fmt-rfcs/blob/master/guide/guide.md