Format TOML files using Taplo (#2057)

Taplo is a TOML toolkit. It is the default LSP implementation used in
Zed and the popular "Even Better TOML" VS Code extension.

This commit leverages Taplo to ensure uniform TOML formatting in CI and
locally (through precommit hooks), thus removing patch pollution due to
TOML formatting changes.

Note Arrays and keys are ordered alphabetically, but not inline table
keys (otherwise `features` would go before `version` in Cargo Manifest
files.

This is a temporary solution until the question of TOML formatting is
resolved upstream.

Author: fuzzypixelz

.config/nextest.toml

@@ -21,5 +21,5 @@ test(=header_check_memory_concurrent) |
 test(=header_link_concurrent) |
 test(=header_link_failure_concurrent)
 """
-threads-required = 'num-cpus'
 slow-timeout = { period = "60s", terminate-after = 6 }
+threads-required = 'num-cpus'

.github/workflows/ci.yml

@@ -106,6 +106,9 @@ jobs:
 
       - name: Install latest cargo-semver-checks
         uses: taiki-e/install-action@cargo-semver-checks
+        
+      - name: Install latest taplo
+        uses: taiki-e/install-action@taplo
 
       - name: Code format check
         run: rustfmt --check --config "unstable_features=true,imports_granularity=Crate,group_imports=StdExternalCrate,skip_children=true" $(git ls-files '*.rs')
@@ -161,6 +164,10 @@ jobs:
 
       - name: Check SemVer Compatibility
         run: cargo +stable semver-checks --verbose --default-features --package zenoh --release-type ${{ env.CARGO_SEMVER_CHECKS_RELEASE_TYPE }} --baseline-version ${{ env.CARGO_SEMVER_CHECKS_BASELINE_VERSION }}
+        
+      - name: Check TOML formatting
+        if: ${{ !contains(matrix.os, 'windows') }}
+        run: taplo fmt --check --diff
 
   test:
     needs: determine-runner

.pre-commit-config.yaml

@@ -14,8 +14,12 @@
 repos:
   - repo: local
     hooks:
-      - id: fmt
-        name: fmt
+      - id: fmt-rust
+        name: fmt-rust
         entry: bash -c 'rustfmt --config "unstable_features=true,imports_granularity=Crate,group_imports=StdExternalCrate,skip_children=true" $(git ls-files '*.rs')'
         language: system
         types: [rust]
+  - repo: https://github.com/ComPWA/taplo-pre-commit
+    rev: v0.9.3
+    hooks:
+      - id: taplo-format

.taplo.toml

@@ -0,0 +1,7 @@
+exclude = ["target/**"]
+
+[[rule]]
+
+[rule.formatting]
+reorder_arrays = true
+reorder_keys = true

Cargo.toml

@@ -12,66 +12,66 @@
 #   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
 #
 [workspace]
-resolver = "2"
+exclude = ["ci/nostd-check", "ci/valgrind-check"]
 members = [
-    "commons/zenoh-buffers",
-    "commons/zenoh-codec",
-    "commons/zenoh-collections",
-    "commons/zenoh-config",
-    "commons/zenoh-core",
-    "commons/zenoh-crypto",
-    "commons/zenoh-keyexpr",
-    "commons/zenoh-macros",
-    "commons/zenoh-protocol",
-    "commons/zenoh-result",
-    "commons/zenoh-shm",
-    "commons/zenoh-sync",
-    "commons/zenoh-task",
-    "commons/zenoh-util",
-    "commons/zenoh-runtime",
-    "examples",
-    "io/zenoh-link",
-    "io/zenoh-link-commons",
-    "io/zenoh-links/zenoh-link-quic/",
-    "io/zenoh-links/zenoh-link-quic_datagram/",
-    "io/zenoh-links/zenoh-link-serial",
-    "io/zenoh-links/zenoh-link-tcp/",
-    "io/zenoh-links/zenoh-link-tls/",
-    "io/zenoh-links/zenoh-link-udp/",
-    "io/zenoh-links/zenoh-link-unixsock_stream/",
-    "io/zenoh-links/zenoh-link-ws/",
-    "io/zenoh-links/zenoh-link-unixpipe/",
-    "io/zenoh-links/zenoh-link-vsock/",
-    "io/zenoh-transport",
-    "plugins/zenoh-backend-example",
-    "plugins/zenoh-plugin-example",
-    "plugins/zenoh-backend-traits",
-    "plugins/zenoh-plugin-rest",
-    "plugins/zenoh-plugin-storage-manager",
-    "plugins/zenoh-plugin-trait",
-    "zenoh",
-    "zenoh-ext",
-    "zenoh-ext/examples",
-    "zenohd",
+  "commons/zenoh-buffers",
+  "commons/zenoh-codec",
+  "commons/zenoh-collections",
+  "commons/zenoh-config",
+  "commons/zenoh-core",
+  "commons/zenoh-crypto",
+  "commons/zenoh-keyexpr",
+  "commons/zenoh-macros",
+  "commons/zenoh-protocol",
+  "commons/zenoh-result",
+  "commons/zenoh-runtime",
+  "commons/zenoh-shm",
+  "commons/zenoh-sync",
+  "commons/zenoh-task",
+  "commons/zenoh-util",
+  "examples",
+  "io/zenoh-link",
+  "io/zenoh-link-commons",
+  "io/zenoh-links/zenoh-link-quic/",
+  "io/zenoh-links/zenoh-link-quic_datagram/",
+  "io/zenoh-links/zenoh-link-serial",
+  "io/zenoh-links/zenoh-link-tcp/",
+  "io/zenoh-links/zenoh-link-tls/",
+  "io/zenoh-links/zenoh-link-udp/",
+  "io/zenoh-links/zenoh-link-unixpipe/",
+  "io/zenoh-links/zenoh-link-unixsock_stream/",
+  "io/zenoh-links/zenoh-link-vsock/",
+  "io/zenoh-links/zenoh-link-ws/",
+  "io/zenoh-transport",
+  "plugins/zenoh-backend-example",
+  "plugins/zenoh-backend-traits",
+  "plugins/zenoh-plugin-example",
+  "plugins/zenoh-plugin-rest",
+  "plugins/zenoh-plugin-storage-manager",
+  "plugins/zenoh-plugin-trait",
+  "zenoh",
+  "zenoh-ext",
+  "zenoh-ext/examples",
+  "zenohd",
 ]
-exclude = ["ci/nostd-check", "ci/valgrind-check"]
+resolver = "2"
 
 [workspace.package]
-rust-version = "1.75.0"
-version = "1.5.0"
-repository = "https://github.com/eclipse-zenoh/zenoh"
-homepage = "http://zenoh.io"
 authors = [
-    "kydos <angelo@icorsaro.net>",
-    "Julien Enoch <julien@enoch.fr>",
-    "Olivier Hécart <olivier.hecart@zettascale.tech>",
-    "Luca Cominardi <luca.cominardi@zettascale.tech>",
-    "Pierre Avital <pierre.avital@zettascale.tech>",
+  "Julien Enoch <julien@enoch.fr>",
+  "Luca Cominardi <luca.cominardi@zettascale.tech>",
+  "Olivier Hécart <olivier.hecart@zettascale.tech>",
+  "Pierre Avital <pierre.avital@zettascale.tech>",
+  "kydos <angelo@icorsaro.net>",
 ]
-edition = "2021"
-license = "EPL-2.0 OR Apache-2.0"
 categories = ["network-programming"]
 description = "Zenoh: The Zero Overhead Pub/Sub/Query Protocol."
+edition = "2021"
+homepage = "http://zenoh.io"
+license = "EPL-2.0 OR Apache-2.0"
+repository = "https://github.com/eclipse-zenoh/zenoh"
+rust-version = "1.75.0"
+version = "1.5.0"
 
 # DEFAULT-FEATURES NOTE: Be careful with default-features and additivity!
 #                        (https://github.com/rust-lang/cargo/issues/11329)
@@ -93,20 +93,18 @@ clap = { version = "4.5.17", features = ["derive"] }
 console-subscriber = "0.4.0"
 const_format = "0.2.33"
 criterion = "0.5"
-crossbeam-utils = "0.8.20"
-crossbeam-queue = "0.3.12"
 crossbeam-channel = "0.5"
-static_assertions = "1.1.0"
-derive_more = { version = "1.0.0", features = ["as_ref"] }
+crossbeam-queue = "0.3.12"
+crossbeam-utils = "0.8.20"
 derive-new = "0.7.0"
-tracing-subscriber = { version = "0.3", features = ["json", "env-filter"] }
+derive_more = { version = "1.0.0", features = ["as_ref"] }
 event-listener = "5.3.1"
 flume = "0.11"
 form_urlencoded = "1.2.1"
 futures = "0.3.31"
 futures-util = { version = "0.3.31", default-features = false } # Default features are disabled due to some crates' requirements
-git-version = "0.3.9"
 getrandom = { version = "0.2" }
+git-version = "0.3.9"
 hashbrown = "0.14"
 hex = { version = "0.4.3", default-features = false } # Default features are disabled due to usage in no_std crates
 hmac = { version = "0.12.1", features = ["std"] }
@@ -121,12 +119,11 @@ lazy_static = "1.5.0"
 leb128 = "0.2"
 libc = "0.2.158"
 libloading = "0.8"
-tracing = "0.1"
 lz4_flex = "0.11"
 nix = { version = "0.29.0", features = ["fs"] }
 nonempty-collections = { version = "0.3.0", features = ["serde"] }
-num_cpus = "1.16.0"
 num-traits = { version = "0.2.19", default-features = false }
+num_cpus = "1.16.0"
 once_cell = "1.19.0"
 ordered-float = "4.2.2"
 panic-message = "0.3.0"
@@ -143,116 +140,119 @@ rand_chacha = "0.3.1"
 rcgen = "0.13.1"
 ref-cast = "1.0.23"
 regex = "1.10.6"
-ron = "0.8.1"
 ringbuffer-spsc = "0.1.9"
+ron = "0.8.1"
 rsa = "0.9"
 rustc_version = "0.4.1"
 rustls = { version = "0.23.13", default-features = false, features = [
-    "logging",
-    "tls12",
-    "ring",
+  "logging",
+  "ring",
+  "tls12",
 ] }
 rustls-native-certs = "0.8.0"
 rustls-pemfile = "2.1.3"
-rustls-webpki = "0.102.8"
 rustls-pki-types = "1.8.0"
+rustls-webpki = "0.102.8"
 schemars = { version = "0.8.21", features = ["either"] }
-secrecy = { version = "0.8.0", features = ["serde", "alloc"] }
+secrecy = { version = "0.8.0", features = ["alloc", "serde"] }
 serde = { version = "1.0.210", default-features = false, features = [
-    "derive",
+  "derive",
 ] } # Default features are disabled due to usage in no_std crates
 serde_json = "1.0.128"
 serde_with = "3.12.0"
 serde_yaml = "0.9.34"
-static_init = "1.0.3"
-stabby = "36.1.1"
 sha3 = "0.10.8"
 shellexpand = "3.1.0"
 socket2 = { version = "0.5.7", features = ["all"] }
+stabby = "36.1.1"
+static_assertions = "1.1.0"
+static_init = "1.0.3"
 stop-token = "0.7.0"
 syn = "2.0"
 test-case = "3.3.1"
 tide = "0.16.0"
 time = "0.3.36"
 token-cell = { version = "1.5.0", default-features = false }
 tokio = { version = "1.40.0", default-features = false } # Default features are disabled due to some crates' requirements
-tokio-util = "0.7.12"
-tokio-tungstenite = "0.24.0"
 tokio-rustls = { version = "0.26.0", default-features = false }
+tokio-tungstenite = "0.24.0"
+tokio-util = "0.7.12"
+tracing = "0.1"
+tracing-subscriber = { version = "0.3", features = ["env-filter", "json"] }
 # tokio-vsock = see: io/zenoh-links/zenoh-link-vsock/Cargo.toml (workspaces does not support platform dependent dependencies)
+either = "1.13.0"
+prost = "0.13.2"
 thread-priority = "1.1.0"
+tls-listener = { version = "0.11.0", features = ["rustls-ring"] }
 typenum = "1.17.0"
 uhlc = { version = "0.8.0", default-features = false } # Default features are disabled due to usage in no_std crates
 unzip-n = "0.1.2"
 url = "2.5.2"
 urlencoding = "2.1.3"
 uuid = { version = "1.10.0", default-features = false, features = [
-    "v4",
+  "v4",
 ] } # Default features are disabled due to usage in no_std crates
 validated_struct = "2.1.0"
 vec_map = "0.8.2"
 webpki-roots = "0.26.5"
 win-sys = "0.3"
 winapi = { version = "0.3.9", features = ["iphlpapi", "winerror"] }
-x509-parser = "0.16.0"
-z-serial = "0.3.1"
-either = "1.13.0"
-prost = "0.13.2"
-tls-listener = { version = "0.11.0", features = ["rustls-ring"] }
 windows-sys = { version = "0.59.0", features = [
-    "Win32_Foundation",
-    "Win32_Networking_WinSock",
-    "Win32_System_IO",
+  "Win32_Foundation",
+  "Win32_Networking_WinSock",
+  "Win32_System_IO",
 ] }
-zenoh-ext = { version = "=1.5.0", path = "zenoh-ext", default-features = false }
-zenoh-shm = { version = "=1.5.0", path = "commons/zenoh-shm" }
-zenoh-result = { version = "=1.5.0", path = "commons/zenoh-result", default-features = false }
-zenoh-config = { version = "=1.5.0", path = "commons/zenoh-config" }
-zenoh-protocol = { version = "=1.5.0", path = "commons/zenoh-protocol", default-features = false }
-zenoh-keyexpr = { version = "=1.5.0", path = "commons/zenoh-keyexpr", default-features = false }
-zenoh-core = { version = "=1.5.0", path = "commons/zenoh-core" }
+x509-parser = "0.16.0"
+z-serial = "0.3.1"
+zenoh = { version = "=1.5.0", path = "zenoh", default-features = false }
 zenoh-buffers = { version = "=1.5.0", path = "commons/zenoh-buffers", default-features = false }
-zenoh-util = { version = "=1.5.0", path = "commons/zenoh-util" }
-zenoh-crypto = { version = "=1.5.0", path = "commons/zenoh-crypto" }
 zenoh-codec = { version = "=1.5.0", path = "commons/zenoh-codec" }
-zenoh-sync = { version = "=1.5.0", path = "commons/zenoh-sync" }
 zenoh-collections = { version = "=1.5.0", path = "commons/zenoh-collections", default-features = false }
-zenoh-macros = { version = "=1.5.0", path = "commons/zenoh-macros" }
-zenoh-plugin-trait = { version = "=1.5.0", path = "plugins/zenoh-plugin-trait", default-features = false }
-zenoh_backend_traits = { version = "=1.5.0", path = "plugins/zenoh-backend-traits", default-features = false }
-zenoh-transport = { version = "=1.5.0", path = "io/zenoh-transport", default-features = false }
-zenoh-link-tls = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-tls" }
-zenoh-link-tcp = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-tcp" }
-zenoh-link-unixsock_stream = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-unixsock_stream" }
+zenoh-config = { version = "=1.5.0", path = "commons/zenoh-config" }
+zenoh-core = { version = "=1.5.0", path = "commons/zenoh-core" }
+zenoh-crypto = { version = "=1.5.0", path = "commons/zenoh-crypto" }
+zenoh-examples = { version = "=1.5.0", path = "examples", default-features = false }
+zenoh-ext = { version = "=1.5.0", path = "zenoh-ext", default-features = false }
+zenoh-keyexpr = { version = "=1.5.0", path = "commons/zenoh-keyexpr", default-features = false }
+zenoh-link = { version = "=1.5.0", path = "io/zenoh-link" }
+zenoh-link-commons = { version = "=1.5.0", path = "io/zenoh-link-commons" }
 zenoh-link-quic = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-quic" }
 zenoh-link-quic_datagram = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-quic_datagram" }
+zenoh-link-serial = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-serial" }
+zenoh-link-tcp = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-tcp" }
+zenoh-link-tls = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-tls" }
 zenoh-link-udp = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-udp" }
-zenoh-link-ws = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-ws" }
 zenoh-link-unixpipe = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-unixpipe" }
-zenoh-link-serial = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-serial" }
+zenoh-link-unixsock_stream = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-unixsock_stream" }
 zenoh-link-vsock = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-vsock" }
-zenoh-link = { version = "=1.5.0", path = "io/zenoh-link" }
-zenoh-link-commons = { version = "=1.5.0", path = "io/zenoh-link-commons" }
-zenoh = { version = "=1.5.0", path = "zenoh", default-features = false }
+zenoh-link-ws = { version = "=1.5.0", path = "io/zenoh-links/zenoh-link-ws" }
+zenoh-macros = { version = "=1.5.0", path = "commons/zenoh-macros" }
+zenoh-plugin-trait = { version = "=1.5.0", path = "plugins/zenoh-plugin-trait", default-features = false }
+zenoh-protocol = { version = "=1.5.0", path = "commons/zenoh-protocol", default-features = false }
+zenoh-result = { version = "=1.5.0", path = "commons/zenoh-result", default-features = false }
 zenoh-runtime = { version = "=1.5.0", path = "commons/zenoh-runtime" }
+zenoh-shm = { version = "=1.5.0", path = "commons/zenoh-shm" }
+zenoh-sync = { version = "=1.5.0", path = "commons/zenoh-sync" }
 zenoh-task = { version = "=1.5.0", path = "commons/zenoh-task" }
-zenoh-examples = { version = "=1.5.0", path = "examples", default-features = false }
+zenoh-transport = { version = "=1.5.0", path = "io/zenoh-transport", default-features = false }
+zenoh-util = { version = "=1.5.0", path = "commons/zenoh-util" }
+zenoh_backend_traits = { version = "=1.5.0", path = "plugins/zenoh-backend-traits", default-features = false }
 
 [profile.dev]
 debug = true
 opt-level = 0
 
 [profile.fast]
-inherits = "release"
-opt-level = 3
 debug = true
 debug-assertions = true
-overflow-checks = true
+inherits = "release"
 lto = false
+opt-level = 3
+overflow-checks = true
 
 [profile.release]
+codegen-units = 1
 debug = false     # If you want debug symbol in release mode, set the env variable: RUSTFLAGS=-g
 lto = "fat"
-codegen-units = 1
 opt-level = 3
 panic = "abort"

Cross.toml

@@ -15,4 +15,3 @@ image = "jenoch/rust-cross:aarch64-unknown-linux-gnu"
 
 [target.aarch64-unknown-linux-musl]
 image = "jenoch/rust-cross:aarch64-unknown-linux-musl"
-

_typos.toml

@@ -2,8 +2,8 @@
 extend-exclude = [
   # Ignore files containing hexa.
   "io/zenoh-transport/tests/*.rs",
-  "zenoh/tests/open_time.rs",
   "zenoh/tests/authentication.rs",
+  "zenoh/tests/open_time.rs",
 ]