CI: Require TOML to be formatted

tombi is a pretty good TOML formatter/LSP with support for TOML in
general, and Rust Cargo.toml in particular.

Using a unified format is nice.

In particular, tombi sorts not just properties within a section, but
also sections and tables.  Apparently some TOML parsers may fail if
tables are not correctly sorted.

Author: ilya-bobyr

.github/actions/setup/action.yml

@@ -19,6 +19,9 @@ inputs:
   rustfmt:
     description: Install Rustfmt if `true`. Defaults to `false`.
     required: false
+  tombi:
+    description: Install tombi if `true`. Defaults to `false`.
+    required: false
   solana:
     description: Install Solana if `true`. Defaults to `false`.
     required: false
@@ -95,6 +98,10 @@ runs:
         toolchain: ${{ env.TOOLCHAIN_LINT }}
         components: clippy
 
+    - name: Install tombi
+      if: ${{ inputs.tombi == 'true' }}
+      uses: tombi-toml/setup-tombi@v1
+
     - name: Install Solana
       if: ${{ inputs.solana == 'true' }}
       uses: solana-program/actions/install-solana@v1

.github/workflows/main.yml

@@ -35,6 +35,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format Client Rust
         run: pnpm clients:rust:format
@@ -54,6 +55,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format
         run: pnpm programs:format
@@ -73,6 +75,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format
         run: pnpm p-interface:format
@@ -92,6 +95,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format
         run: pnpm p-token:format
@@ -111,6 +115,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format
         run: pnpm interface:format

scripts/rust/format.mjs

@@ -18,7 +18,9 @@ const manifestPath = path.join(workingDirectory, folder, 'Cargo.toml');
 
 // Format the client.
 if (fix) {
+  await $`tombi format ${formatArgs} ${folder}`;
   await $`cargo ${toolchain} fmt --manifest-path ${manifestPath} ${cargoArgs} -- ${fmtArgs}`;
 } else {
+  await $`tombi lint ${formatArgs} ${folder}`;
   await $`cargo ${toolchain} fmt --manifest-path ${manifestPath} ${cargoArgs} -- --check ${fmtArgs}`;
 }