Enforce consistent and correct toml formatting

[liamaharon]

Using taplo, fixes all our broken and inconsistent toml formatting and adds CI to keep them tidy.

If people want we can customise the format rules as described here https://taplo.tamasfe.dev/configuration/formatter-options.html

@ggwpez, I suggest zepter is used only for checking features are propagated, and leave formatting for taplo to avoid duplicate work and conflicts.

TODO

• Use exclude = [...] syntax in taplo file to ignore zombienet tests instead of deleting the dir

[bkchr]

As @ggwpez we should switch to tabs, as we use them everywhere.

This will also require that the CI job and the contribution guide mention this tool and how to fix potential issues.

[liamaharon]

@ggwpez @bkchr I noticed we have an existing style guide for toml here https://github.com/paritytech/polkadot-sdk/blob/master/docs/STYLE_GUIDE.md#manifest-formatting

It states

All entries need to be alphabetically sorted.

and

The feature is written as a single line if it fits within 80 chars:

[features]
default = [ "std" ]

Otherwise the feature is broken down into multiple lines with one entry per line. Each line is padded with one tab and no trailing spaces but a trailing comma.

[features]
default = [
	"loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong",
	# Comments go here as well ;)
	"std",
]

Should I update our taplo rules to adhere to these two rules, or update the markdown just say to refer to the taplo config for toml formatting rules?

[ggwpez]

@liamaharon how does the taplo config currently differ from this? AFAIK these are good rules. I programmed Zepter to do it exactly like this.
But linking to the taplo config file for more information is a good idea either way 😄

[liamaharon]

@ggwpez I don't think Zepter did this

• We have lots of Cargo.toml files with unsorted deps
• Arrays (usually feature arrays) not currently wrapped over multiple lines if the len exceeds 80 chars

[ggwpez]

• We have lots of Cargo.toml files with unsorted deps

Yea it only does that for features, not deps.

• Arrays (usually feature arrays) not currently wrapped over multiple lines if the len exceeds 80 chars

Can you show me an example? I want to fix it then. But we should not use Zepter for formatting anyway, its not really suitable for that.

[liamaharon]

Yea it only does that for features, not deps.

Seem unclear in STYLE_GUIDE.md if it is referring to features or deps. Do you think we should also sort deps?

Can you show me an example? I want to fix it then. But we should not use Zepter for formatting anyway, its not really suitable for that.

I mean auto-wrapping features for deps too, like

parity-scale-codec = { version = "3.2.2", default-features = false, features = [
  "derive",
] }

[liamaharon]

TODO before merge: check if this is safe to order alphabetically

maybe disable ordering for select files using https://taplo.tamasfe.dev/configuration/file.html#rules

[ggwpez]

Yea looks like this could be order dependant, or @mrcnski?

[liamaharon]

It's order dependent https://github.com/kornelski/cargo-deb. Will add a role to ignore ordering for just this file.

[ggwpez]

Looks good now, thanks!