Format and Sort features in Cargo.toml files (#14803)

* CI: Add feature sorting check Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Sort all features Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add some mistakes Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Revert "Add some mistakes" This reverts commit b2b1099f979f6decb22d09b46689c1554bb72e81. * CI job naming Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Add oneliner formatting Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Explain tool Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use latest version Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Better erorr message Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Format after master merge Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Use --check option Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Messed up the merge commit... Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> --------- Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
2026-06-12 07:41:08 +00:00 · 2023-08-23 16:21:52 +02:00
parent 878c562cd4
commit 8b9455465b
161 changed files with 1093 additions and 1171 deletions
@@ -5,7 +5,7 @@ title: Style Guide for Rust in Substrate
 Where possible these styles are enforced by settings in `rustfmt.toml` so if you run `cargo fmt` 
 then you will adhere to most of these style guidelines automatically.

-# Formatting
+# Code Formatting

 -   Indent using tabs.
 -   Lines should be longer than 100 characters long only in exceptional circumstances and certainly
@@ -147,3 +147,26 @@ let mut target_path =
    -   how likely is it that invariants could be violated,
    -   are issues stemming from the use of unsafe code caught by existing tests/tooling,
    -   what are the consequences if the problems slip into production.
+
+# Manifest Formatting
+
+> **TLDR**
+> You can use the CLI tool [Zepter](https://crates.io/crates/zepter) to format the files: `zepter format features`
+
+Rust `Cargo.toml` files need to respect certain formatting rules. All entries need to be alphabetically sorted. This makes it easier to read them and insert new entries. The exhaustive list of rules is enforced by the CI. The general format looks like this:
+
+- The feature is written as a single line if it fits within 80 chars:
+```toml
+[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.
+```toml
+[features]
+default = [
+	"loooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong",
+	# Comments go here as well ;)
+	"std",
+]
+```