X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=0af1a94080d9f1dff098c75f5fa9b5ddf4b2813a;hb=dd7add784b166d9d5e6e28588e8e1b494701ba04;hp=37fdad5b9756f1ce7b030bd14a2870e7f2ece4bc;hpb=b1da2a53b489f86c17771a2b77acabdd236a115d;p=rust.git diff --git a/README.md b/README.md index 37fdad5b975..0af1a94080d 100644 --- a/README.md +++ b/README.md @@ -36,12 +36,6 @@ To run: cargo +nightly fmt ``` -To format code that requires edition 2018, create a `rustfmt.toml` [configuration](#configuring-rustfmt) file containing: - -```toml -edition = "Edition2018" -``` - ## Limitations Rustfmt tries to work on as much Rust code as possible, sometimes, the code @@ -115,6 +109,7 @@ completed without error (whether or not changes were made). * [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 @@ -169,12 +164,7 @@ See [Configurations.md](Configurations.md) for details. ## Tips -* For things you do not want rustfmt to mangle, use one of - - ```rust - #[rustfmt::skip] // requires nightly Rust and #![feature(tool_attributes)] in crate root - #[cfg_attr(rustfmt, rustfmt_skip)] // works in stable - ``` +* For things you do not want rustfmt to mangle, use `#[rustfmt::skip]` * 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 rustfmt. You can generate a file containing the default configuration with @@ -189,7 +179,7 @@ See [Configurations.md](Configurations.md) for details. Example: ``` - cargo fmt --emit files + cargo fmt -- --emit files ``` Options: @@ -197,7 +187,7 @@ See [Configurations.md](Configurations.md) for details. | 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 |