-# rustfmt [](https://travis-ci.org/rust-lang-nursery/rustfmt) [](https://ci.appveyor.com/project/nrc/rustfmt) [](https://crates.io/crates/rustfmt-nightly) [](https://travis-ci.org/davidalber/rustfmt-travis)
+# rustfmt [](https://travis-ci.com/rust-lang/rustfmt) [](https://ci.appveyor.com/project/rust-lang-libs/rustfmt) [](https://crates.io/crates/rustfmt-nightly) [](https://travis-ci.org/davidalber/rustfmt-travis)
A tool for formatting Rust code according to style guidelines.
You can run `rustfmt` with Rust 1.24 and above.
+### On the Stable toolchain
+
To install:
-```
-rustup component add rustfmt-preview
+```sh
+rustup component add rustfmt
```
-to run on a cargo project in the current working directory:
+To run on a cargo project in the current working directory:
-```
+```sh
cargo fmt
```
-For the latest and greatest `rustfmt` (nightly required):
-```
-rustup component add rustfmt-preview --toolchain nightly
-```
-To run:
-```
-cargo +nightly fmt
+### On the Nightly toolchain
+
+For the latest and greatest `rustfmt`, nightly is required.
+
+To install:
+
+```sh
+rustup component add rustfmt --toolchain nightly
```
-To format code that requires edition 2018, create a `rustfmt.toml` [configuration](#configuring-rustfmt) file containing:
+To run on a cargo project in the current working directory:
-```toml
-edition = "2018"
+```sh
+cargo +nightly fmt
```
## Limitations
## Installation
-```
-rustup component add rustfmt-preview
+```sh
+rustup component add rustfmt
```
## Installing from source
To install from source (nightly required), first checkout to the tag or branch you want to install, then issue
-```
+```sh
cargo install --path .
```
read data from stdin. Alternatively, you can use `cargo fmt` to format all
binary and library targets of your crate.
-You can run `rustfmt --help` for information about argument.
+You can run `rustfmt --help` for information about available arguments.
When running with `--check`, Rustfmt will exit with `0` if Rustfmt would not
make any formatting changes to the input, and `1` if Rustfmt would make changes.
* [Sublime Text 3](https://packagecontrol.io/packages/RustFmt)
* [Atom](atom.md)
* 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.
+* [IntelliJ or CLion](intellij.md)
## Checking style on a CI server
```yaml
language: rust
before_script:
-- rustup component add rustfmt-preview
+- rustup component add rustfmt
script:
- cargo fmt --all -- --check
- cargo build
`rustfmt.toml` or `.rustfmt.toml`, place it in the project or any other parent
directory and it will apply the options in that file. See `rustfmt
--help=config` for the options which are available, or if you prefer to see
-visual style previews, [Configurations.md](Configurations.md).
+visual style previews, [GitHub page](https://rust-lang.github.io/rustfmt/).
By default, Rustfmt uses a style which conforms to the [Rust style guide][style
guide] that has been formalized through the [style RFC
Configuration options are either stable or unstable. Stable options can always
be used, while unstable ones are only available on a nightly toolchain, and opt-in.
-See [Configurations.md](Configurations.md) for details.
+See [GitHub page](https://rust-lang.github.io/rustfmt/) for details.
+### Rust's Editions
+
+Rustfmt is able to pick up the edition used by reading the `Cargo.toml` file if
+executed through the Cargo's formatting tool `cargo fmt`. Otherwise, the edition
+needs to be specified in `rustfmt.toml`, e.g., with `edition = "2018"`.
## Tips
-* For things you do not want rustfmt to mangle, use one of
+* For things you do not want rustfmt to mangle, use `#[rustfmt::skip]`
+* To prevent rustfmt from formatting a macro or an attribute,
+ use `#[rustfmt::skip::macros(target_macro_name)]` or
+ `#[rustfmt::skip::attributes(target_attribute_name)]`
+
+ Example:
```rust
- #[rustfmt::skip] // requires nightly Rust and #![feature(tool_attributes)] in crate root
- #[cfg_attr(rustfmt, rustfmt_skip)] // works in stable
+ #![rustfmt::skip::attributes(custom_attribute)]
+
+ #[custom_attribute(formatting , here , should , be , Skipped)]
+ #[rustfmt::skip::macros(html)]
+ fn main() {
+ let macro_result1 = html! { <div>
+ Hello</div>
+ }.to_string();
```
* When you run rustfmt, place a file named `rustfmt.toml` or `.rustfmt.toml` in
target file directory or its parents to override the default settings of
Example:
- ```
- cargo fmt --emit files
+ ```sh
+ cargo fmt -- --emit files
```
Options:
| Flag |Description| Nightly Only |
|:---:|:---:|:---:|
| files | overwrites output to files | No |
- | stdout | writes output to stdout | No |
+ | stdout | writes output to stdout | No |
| coverage | displays how much of the input file was processed | Yes |
| checkstyle | emits in a checkstyle format | Yes |
projects / rust.git / blobdiff