Enforce formatting of TOML files

[sagudev]

Formatting is enforced by CI rather than requiring users to install taplo as I suggested in #26728 (comment)

---

• ./mach build -d does not report any errors
• ./mach test-tidy does not report any errors
• These changes fix Enforcing formatting of TOML files #26728

• These changes do not require tests because they are helper scripts

[mrobinson]

I think this will make things tricky for developers because bootstrap isn't installing taplo, so the changes will fail on CI but not locally with test-tidy. Can we install a toml formater via pip or cargo dependencies that does the right thing?

[sagudev]

Can we install a toml formater via pip or cargo dependencies that does the right thing

Is there any place where I can put cargo install taplo-cli --locked without doing separately for every platform?

[mrobinson]

Can we install a toml formater via pip or cargo dependencies that does the right thing

Is there any place where I can put cargo install taplo-cli --locked without doing separately for every platform?

Could this be made a dev dependency of the winit port?

[sagudev]

Can we install a toml formater via pip or cargo dependencies that does the right thing

Is there any place where I can put cargo install taplo-cli --locked without doing separately for every platform?

Could this be made a dev dependency of the winit port?

Could we run cli from dev-dependencies? I think that is not possible: rust-lang/cargo#2267

[mrobinson]

It seems a tool like toml-sort could be installed by pip and then run unconditionally. What do you think?

[sagudev]

It seems a tool like toml-sort could be installed by pip and then run unconditionally. What do you think?

Hm, it certainly is more convenient to install via mach. I will see if I can make config for it.

[mrobinson]

Great. That sounds like a plan. I can help out with the integration into "./mach fmt" as well.

[sagudev]

After reading toml-sort usage manual I am not so sure it was meant to be used this way. In taplo you can just do taplo fmt and it would automatically search for config and formatted all files. In toml-sort you need to do toml-sort --in-place **.toml if you have bash glob enabled. There is also no way to really exclude some toml files. While we could write wrappers in mach that would do all this stuff, I do not think that is the way to go.

I think Taplo is more oriented towards users like us, that want to enforce formatting in their project and is easier to be used as standalone, while toml-sort is just utility that works for files being piped rather than on projects.

[mrobinson]

Hrm. Maybe we can build taplo into the target directory or install it for the user with cargo during bootstrapping?

[sagudev]

I am working on user installation with cargo during bootstrapping.

Wow how mach has changed since the last time I touched it (well bootstrapping to be exact).

[mrobinson]

Thanks so much for iterating on this. This is looking really good. I have a suggestion for a few minor changes.

[mrobinson]

Will this be installed by ./mach bootstrap below now?

[sagudev]

It would be, but this way it's faster as this action will cache it. Using cargo install takes 4-5min.

[mrobinson]

Ditto.

[mrobinson]

Looks good! Just a couple little nits before landing. Thanks!

[mrobinson]

Thank you!