changelog for 1.0.1

[rust.git] / README.md

diff --git a/README.md b/README.md
index 1c2dbed37a0a0e978be4bac75fc6f60b6d3373a5..381dc73209e5b4b5ee3de3a21f1b3b9d5caf4e6e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# 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)
+# 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)

 
 A tool for formatting Rust code according to style guidelines.
 
 
 A tool for formatting Rust code according to style guidelines.
 


@@ -6,54 +6,43 @@ If you'd like to help out (and you should, it's a fun project!), see
 [Contributing.md](Contributing.md) and our [Code of
 Conduct](CODE_OF_CONDUCT.md).
 
 [Contributing.md](Contributing.md) and our [Code of
 Conduct](CODE_OF_CONDUCT.md).
 

-We are changing the default style used by rustfmt. There is an ongoing [RFC
-process][fmt rfcs]. The last version using the old style was 0.8.6. From 0.9
-onwards, the RFC style is the default. If you want the old style back, you can
-use [legacy-rustfmt.toml](legacy-rustfmt.toml) as your rustfmt.toml.
-
-The current `master` branch uses libsyntax (part of the compiler). It is
-published as `rustfmt-nightly`. The `syntex` branch uses Syntex instead of
-libsyntax, it is published (for now) as `rustfmt`. Most development happens on
-the `master` branch, however, this only supports nightly toolchains. If you use
-stable or beta Rust toolchains, you must use the Syntex version (which is likely
-to be a bit out of date). Version 0.1 of rustfmt-nightly is forked from version
-0.9 of the syntex branch.
-

 You can use rustfmt in Travis CI builds. We provide a minimal Travis CI
 configuration (see [here](#checking-style-on-a-ci-server)) and verify its status
 using another repository. The status of that repository's build is reported by
 the "travis example" badge above.
 
 You can use rustfmt in Travis CI builds. We provide a minimal Travis CI
 configuration (see [here](#checking-style-on-a-ci-server)) and verify its status
 using another repository. The status of that repository's build is reported by
 the "travis example" badge above.
 

-

 ## Quick start
 
 ## Quick start
 

-You can use `rustfmt` on Rust 1.24 and above.
+You can run `rustfmt` with Rust 1.24 and above.
+
+### On the Stable toolchain

 
 To install:
 
 
 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
 ```
 
 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 = "Edition2018"
+```sh
+cargo +nightly fmt

 ```
 
 ## Limitations
 ```
 
 ## Limitations


@@ -87,14 +76,15 @@ because in the future Rustfmt might work on code where it currently does not):
 
 ## Installation
 
 
 ## 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
 ```
 
 ## 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 .
 ```
 
 cargo install --path .
 ```
 


@@ -111,7 +101,7 @@ just need to run on the root file (usually mod.rs or lib.rs). Rustfmt can also
 read data from stdin. Alternatively, you can use `cargo fmt` to format all
 binary and library targets of your crate.
 
 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.
 
 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.


@@ -128,6 +118,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.
 * [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
 
 
 ## Checking style on a CI server


@@ -142,10 +133,8 @@ A minimal Travis setup could look like this (requires Rust 1.24.0 or greater):
 
 ```yaml
 language: rust
 
 ```yaml
 language: rust

-rust:
-- nightly

 before_script:
 before_script:

-- rustup component add rustfmt-preview
+- rustup component add rustfmt

 script:
 - cargo fmt --all -- --check
 - cargo build
 script:
 - cargo fmt --all -- --check
 - cargo build


@@ -170,8 +159,8 @@ notes above on running rustfmt.
 Rustfmt is designed to be very configurable. You can create a TOML file called
 `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
 Rustfmt is designed to be very configurable. You can create a TOML file called
 `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

---config-help` for the options which are available, or if you prefer to see
-visual style previews, [Configurations.md](Configurations.md).
+--help=config` for the options which are available, or if you prefer to see
+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
 
 By default, Rustfmt uses a style which conforms to the [Rust style guide][style
 guide] that has been formalized through the [style RFC


@@ -179,16 +168,28 @@ process][fmt rfcs].
 
 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.
 
 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
 
 
 ## 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,
+  use `#[rustfmt::skip::macros(target_macro_name)]`
+
+  Example:

 
     ```rust
 
     ```rust

-    #[rustfmt::skip]  // requires nightly Rust and #![feature(tool_attributes)] in crate root
-    #[cfg_attr(rustfmt, rustfmt_skip)]  // works in stable
+    #[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
     ```
 * 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


@@ -199,35 +200,12 @@ See [Configurations.md](Configurations.md) for details.
 * If you're having issues compiling Rustfmt (or compile errors when trying to
   install), make sure you have the most recent version of Rust installed.
 
 * If you're having issues compiling Rustfmt (or compile errors when trying to
   install), make sure you have the most recent version of Rust installed.
 

-* If you get an error like `error while loading shared libraries` while starting
-  up rustfmt you should try the following:
-
-  On Linux:
-
-  ```
-  export LD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$LD_LIBRARY_PATH
-  ```
-
-  On MacOS:
-
-  ```
-  export DYLD_LIBRARY_PATH=$(rustc --print sysroot)/lib:$DYLD_LIBRARY_PATH
-  ```
-
-  On Windows (Git Bash/Mingw):
-
-  ```
-  export PATH=$(rustc --print sysroot)/lib/rustlib/x86_64-pc-windows-gnu/lib/:$PATH
-  ```
-
-  (Substitute `x86_64` by `i686` and `gnu` by `msvc` depending on which version of rustc was used to install rustfmt).
-

 * You can change the way rustfmt emits the changes with the --emit flag:
 
   Example:
 
 * You can change the way rustfmt emits the changes with the --emit flag:
 
   Example:
 

-  ```
-  cargo fmt --emit files
+  ```sh
+  cargo fmt -- --emit files

   ```
 
   Options:
   ```
 
   Options:


@@ -235,7 +213,7 @@ See [Configurations.md](Configurations.md) for details.
   | Flag |Description| Nightly Only |
   |:---:|:---:|:---:|
   | files | overwrites output to files | No |
   | 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 |
 
   | coverage | displays how much of the input file was processed | Yes |
   | checkstyle | emits in a checkstyle format | Yes |