X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=9c7a1c4bc341bed77ce3ee362a8eea5d01ad7974;hb=17cb2b147e11c9ad274b316026b1001fbd7007d4;hp=94878d0bba082f4fef691dfed6fb8375132a09a1;hpb=558a2c351266dc78e73963d2303221a60a0d5c85;p=rust.git diff --git a/README.md b/README.md index 94878d0bba0..9c7a1c4bc34 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# rustfmt [![Build Status](https://travis-ci.org/rust-lang/rustfmt.svg)](https://travis-ci.org/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) +# 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. @@ -136,9 +136,9 @@ language: rust before_script: - rustup component add rustfmt script: -- cargo fmt --all -- --check - cargo build - cargo test +- cargo fmt --all -- --check ``` See [this blog post](https://medium.com/@ag_dubs/enforcing-style-in-ci-for-rust-projects-18f6b09ec69d) @@ -160,7 +160,7 @@ 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 --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 @@ -168,7 +168,7 @@ 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. -See [Configurations.md](Configurations.md) for details. +See [GitHub page](https://rust-lang.github.io/rustfmt/) for details. ### Rust's Editions @@ -179,6 +179,22 @@ needs to be specified in `rustfmt.toml`, e.g., with `edition = "2018"`. ## Tips * 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::attributes(custom_attribute)] + + #[custom_attribute(formatting , here , should , be , Skipped)] + #[rustfmt::skip::macros(html)] + fn main() { + let macro_result1 = html! {