RFC: cargo tidy

[nrc]

I would like to add a cargo tidy command. The purpose is to format Cargo.toml. For the kind of things I'd like to implement, see the PingCAP style guide.

I have an initial implementation at https://github.com/nrc/cargo-edit/tree/tidy Currently it only sorts dependencies. I've used this already to produce this PR.

I know there is already cargo add --sort, but I want to be able to do this without adding a dep, and in the future I would like to extend it to support more formatting and linting.

What do you think? Should I send a PR?

See also: #280

[ordian]

Hey @nrc, I like the idea of the command, but I'm not sure cargo-edit is the right place for it. The reason is it's probably won't reusing much code in cargo-edit and would be specific to PingCAP style guide. Let's see what @killercup thinks.

[nrc]

It does use a fair bit of the Cargo edit code, mostly toml-edit, to be fair, but also the test infra.

I don't think the styling has to be specific to PingCAP, the style guide is meant to be generally useful and I'm happy to discuss the rules here and update the style guide to match.

[jamesmcm]

I think this would be a good addition (and have it format by default maybe?)

[kgv]

I could not find something already implemented, so I decided to write my own Cargo.toml formatter.
cargofmt
Just now work ordering, and table inlining option.
Maybe it will be useful to someone.

[omid]

Any update here? (actually just to bring up the topic! ;) )

[epage]

We should probably coordinate with rustfmt on this. Their issue is rust-lang/rustfmt#4091

[epage]

Closing in favor of rustfmt

[sjackman]

The rustfmt PR has been open since 2022-02-25

• feat: support formatting Cargo.toml rust-lang/rustfmt#5240

Would you be open to accepting a PR that provides cargo tidy to sort dependencies?

[epage]

No. At this point, cargo-edit is focused mostly on work that can be upstreamed and that would be a dead end. I would encourage you to help contribute to the rustfmt effort instead.

[sjackman]

I found cargo-sort to sort dependencies in Cargo.toml files, and it works well! https://crates.io/crates/cargo-sort