X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=9c7a1c4bc341bed77ce3ee362a8eea5d01ad7974;hb=2323cbc2311d2b907b62d5dc58970756bfb3cbc0;hp=aa02905c45c7330b414ff1b28e99378bef971c40;hpb=378b28b06e550bf7fb1c01e9efa1f3ef0d2aceb6;p=rust.git diff --git a/README.md b/README.md index aa02905c45c..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) @@ -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,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