README.md

   1 # rustfmt [![Build Status](https://travis-ci.com/rust-lang/rustfmt.svg?branch=master)](https://travis-ci.com/rust-lang/rustfmt) [![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang/rustfmt?svg=true)](https://ci.appveyor.com/project/rust-lang-libs/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 ### On the Stable toolchain
  19
  20 To install:
  21
  22 ```sh
  23 rustup component add rustfmt
  24 ```
  25
  26 To run on a cargo project in the current working directory:
  27
  28 ```sh
  29 cargo fmt
  30 ```
  31
  32 ### On the Nightly toolchain
  33
  34 For the latest and greatest `rustfmt`, nightly is required.
  35
  36 To install:
  37
  38 ```sh
  39 rustup component add rustfmt --toolchain nightly
  40 ```
  41
  42 To run on a cargo project in the current working directory:
  43
  44 ```sh
  45 cargo +nightly fmt
  46 ```
  47
  48 ## Limitations
  49
  50 Rustfmt tries to work on as much Rust code as possible. Sometimes, the code
  51 doesn't even need to compile! In general, we are looking to limit areas of
  52 instability; in particular, post-1.0, the formatting of most code should not
  53 change as Rustfmt improves. However, there are some things that Rustfmt can't
  54 do or can't do well (and thus where formatting might change significantly,
  55 even post-1.0). We would like to reduce the list of limitations over time.
  56
  57 The following list enumerates areas where Rustfmt does not work or where the
  58 stability guarantees do not apply (we don't make a distinction between the two
  59 because in the future Rustfmt might work on code where it currently does not):
  60
  61 * a program where any part of the program does not parse (parsing is an early
  62   stage of compilation and in Rust includes macro expansion).
  63 * Macro declarations and uses (current status: some macro declarations and uses
  64   are formatted).
  65 * Comments, including any AST node with a comment 'inside' (Rustfmt does not
  66   currently attempt to format comments, it does format code with comments inside, but that formatting may change in the future).
  67 * Rust code in code blocks in comments.
  68 * Any fragment of a program (i.e., stability guarantees only apply to whole
  69   programs, even where fragments of a program can be formatted today).
  70 * Code containing non-ascii unicode characters (we believe Rustfmt mostly works
  71   here, but do not have the test coverage or experience to be 100% sure).
  72 * Bugs in Rustfmt (like any software, Rustfmt has bugs, we do not consider bug
  73   fixes to break our stability guarantees).
  74
  75
  76 ## Installation
  77
  78 ```sh
  79 rustup component add rustfmt
  80 ```
  81
  82 ## Installing from source
  83
  84 To install from source (nightly required), first checkout to the tag or branch you want to install, then issue
  85
  86 ```sh
  87 cargo install --path .
  88 ```
  89
  90 This will install `rustfmt` in your `~/.cargo/bin`. Make sure to add `~/.cargo/bin` directory to
  91 your PATH variable.
  92
  93
  94 ## Running
  95
  96 You can run Rustfmt by just typing `rustfmt filename` if you used `cargo
  97 install`. This runs rustfmt on the given file, if the file includes out of line
  98 modules, then we reformat those too. So to run on a whole module or crate, you
  99 just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also
 100 read data from stdin. Alternatively, you can use `cargo fmt` to format all
 101 binary and library targets of your crate.
 102
 103 You can run `rustfmt --help` for information about available arguments.
 104 The easiest way to run rustfmt against a project is with `cargo fmt`. `cargo fmt` works on both
 105 single-crate projects and [cargo workspaces](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html).
 106 Please see `cargo fmt --help` for usage information.
 107
 108 You can specify the path to your own `rustfmt` binary for cargo to use by setting the`RUSTFMT`
 109 environment variable. This was added in v1.4.22, so you must have this version or newer to leverage this feature (`cargo fmt --version`)
 110
 111 ### Running `rustfmt` directly
 112
 113 To format individual files or arbitrary codes from stdin, the `rustfmt` binary should be used. Some
 114 examples follow:
 115
 116 - `rustfmt lib.rs main.rs` will format "lib.rs" and "main.rs" in place
 117 - `rustfmt` will read a code from stdin and write formatting to stdout
 118   - `echo "fn     main() {}" | rustfmt` would emit "fn main() {}".
 119
 120 For more information, including arguments and emit options, see `rustfmt --help`.
 121
 122 ### Verifying code is formatted
 123
 124 When running with `--check`, Rustfmt will exit with `0` if Rustfmt would not
 125 make any formatting changes to the input, and `1` if Rustfmt would make changes.
 126 In other modes, Rustfmt will exit with `1` if there was some error during
 127 formatting (for example a parsing or internal error) and `0` if formatting
 128 completed without error (whether or not changes were made).
 129
 130
 131
 132 ## Running Rustfmt from your editor
 133
 134 * [Vim](https://github.com/rust-lang/rust.vim#formatting-with-rustfmt)
 135 * [Emacs](https://github.com/rust-lang/rust-mode)
 136 * [Sublime Text 3](https://packagecontrol.io/packages/RustFmt)
 137 * [Atom](atom.md)
 138 * 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.
 139 * [IntelliJ or CLion](intellij.md)
 140
 141
 142 ## Checking style on a CI server
 143
 144 To keep your code base consistently formatted, it can be helpful to fail the CI build
 145 when a pull request contains unformatted code. Using `--check` instructs
 146 rustfmt to exit with an error code if the input is not formatted correctly.
 147 It will also print any found differences. (Older versions of Rustfmt don't
 148 support `--check`, use `--write-mode diff`).
 149
 150 A minimal Travis setup could look like this (requires Rust 1.31.0 or greater):
 151
 152 ```yaml
 153 language: rust
 154 before_script:
 155 - rustup component add rustfmt
 156 script:
 157 - cargo build
 158 - cargo test
 159 - cargo fmt --all -- --check
 160 ```
 161
 162 See [this blog post](https://medium.com/@ag_dubs/enforcing-style-in-ci-for-rust-projects-18f6b09ec69d)
 163 for more info.
 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 --help=config` for the options which are available, or if you prefer to see
 181 visual style previews, [GitHub page](https://rust-lang.github.io/rustfmt/).
 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 [GitHub page](https://rust-lang.github.io/rustfmt/) for details.
 190
 191 ### Rust's Editions
 192
 193 Rustfmt is able to pick up the edition used by reading the `Cargo.toml` file if
 194 executed through the Cargo's formatting tool `cargo fmt`. Otherwise, the edition
 195 needs to be specified in `rustfmt.toml`, e.g., with `edition = "2018"`.
 196
 197 ## Tips
 198
 199 * For things you do not want rustfmt to mangle, use `#[rustfmt::skip]`
 200 * To prevent rustfmt from formatting a macro or an attribute,
 201   use `#[rustfmt::skip::macros(target_macro_name)]` or
 202   `#[rustfmt::skip::attributes(target_attribute_name)]`
 203
 204   Example:
 205
 206     ```rust
 207     #![rustfmt::skip::attributes(custom_attribute)]
 208
 209     #[custom_attribute(formatting , here , should , be , Skipped)]
 210     #[rustfmt::skip::macros(html)]
 211     fn main() {
 212         let macro_result1 = html! { <div>
 213     Hello</div>
 214         }.to_string();
 215     ```
 216 * When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
 217   target file directory or its parents to override the default settings of
 218   rustfmt. You can generate a file containing the default configuration with
 219   `rustfmt --print-config default rustfmt.toml` and customize as needed.
 220 * After successful compilation, a `rustfmt` executable can be found in the
 221   target directory.
 222 * If you're having issues compiling Rustfmt (or compile errors when trying to
 223   install), make sure you have the most recent version of Rust installed.
 224
 225 * You can change the way rustfmt emits the changes with the --emit flag:
 226
 227   Example:
 228
 229   ```sh
 230   cargo fmt -- --emit files
 231   ```
 232
 233   Options:
 234
 235   | Flag |Description| Nightly Only |
 236   |:---:|:---:|:---:|
 237   | files | overwrites output to files | No |
 238   | stdout | writes output to stdout | No |
 239   | coverage | displays how much of the input file was processed | Yes |
 240   | checkstyle | emits in a checkstyle format | Yes |
 241   | json | emits diffs in a json format | Yes |
 242
 243 ## License
 244
 245 Rustfmt is distributed under the terms of both the MIT license and the
 246 Apache License (Version 2.0).
 247
 248 See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
 249
 250 [rust]: https://github.com/rust-lang/rust
 251 [fmt rfcs]: https://github.com/rust-dev-tools/fmt-rfcs
 252 [style guide]: https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md