add canonical rustfmt - Githubissues

BiagioFesta / wtransport

Async-friendly WebTransport implementation in Rust

Apache License 2.0

402 stars 27 forks source link

add canonical rustfmt #189

Open TheButlah opened 3 months ago

TheButlah commented 3 months ago

Its nice to have a vendored rustfmt.toml. because when people use settings that differ from the defaults, the rustfmt.toml will take precedence.

BiagioFesta commented 3 months ago

I use a specific rustfmt.toml locally, I'd like to vendor it, but many useful option are nightly at the moment.

My local:

imports_granularity = "Item"
format_code_in_doc_comments = true

and that's why I ignored it for now.

It is good to vendor a +nightly configuration?
I'd prefer to vendor with filename .rustfmt.toml (hidden file); that should help keeping root directly a little bit "cleaner"

TheButlah commented 3 months ago

It is good to vendor a +nightly configuration?

I know some people do this, but since it eliminates the ability to use standard toolchain pinning via rust-toolchain (if you also want to build with stable), I don't personally advocate for nightly rustfmt.

MOZGIII commented 2 months ago

I think I know a good setup for this:

set rust-toolchain.toml to use nightly
vendor the nightly rustfmt settings
at CI run tests and clippy against stable and the rest targets
check rustfmt against nightly (version specified via the toml)