X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=9c7a1c4bc341bed77ce3ee362a8eea5d01ad7974;hb=17cb2b147e11c9ad274b316026b1001fbd7007d4;hp=381dc73209e5b4b5ee3de3a21f1b3b9d5caf4e6e;hpb=896394a7a5fdec00851f4034cff98574456d23aa;p=rust.git diff --git a/README.md b/README.md index 381dc73209e..9c7a1c4bc34 100644 --- a/README.md +++ b/README.md @@ -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) @@ -179,12 +179,16 @@ 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, - use `#[rustfmt::skip::macros(target_macro_name)]` +* 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! {
@@ -216,6 +220,7 @@ needs to be specified in `rustfmt.toml`, e.g., with `edition = "2018"`. | stdout | writes output to stdout | No | | coverage | displays how much of the input file was processed | Yes | | checkstyle | emits in a checkstyle format | Yes | + | json | emits diffs in a json format | Yes | ## License @@ -225,5 +230,5 @@ Apache License (Version 2.0). See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details. [rust]: https://github.com/rust-lang/rust -[fmt rfcs]: https://github.com/rust-lang-nursery/fmt-rfcs -[style guide]: https://github.com/rust-lang-nursery/fmt-rfcs/blob/master/guide/guide.md +[fmt rfcs]: https://github.com/rust-dev-tools/fmt-rfcs +[style guide]: https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md