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

@@ -10,6 +10,10 @@ inputs:
   components:
     description: Cargo components to install. Comma-separated string of [`audit`, `hack``, `release`, `semver-checks].
     required: false
+  tombi:
+    description: >
+      Install `tombi` - TOML formatter/linter, if `true`.  Defaults to `false.
+    required: false
   solana:
     description: Install Solana if `true`. Defaults to `false`.
     required: false
@@ -47,6 +51,10 @@ runs:
         toolchain: ${{ env.TOOLCHAIN_FORMAT }}
         components: rustfmt
 
+    - name: Install Toml formatter and linter tombi
+      if: ${{ inputs.tombi == 'true' }}
+      uses: tombi-toml/setup-tombi@v1
+
     - name: Install Rust 'lint' Toolchain
       if: ${{ contains(inputs.toolchain, 'lint') }}
       uses: dtolnay/rust-toolchain@master

.github/workflows/main.yml

@@ -68,6 +68,7 @@ jobs:
           cargo-cache-key: cargo-${{ matrix.member }}
           toolchain: build, format, lint, test
           components: hack
+          tombi: true
           solana: true
 
       - name: fmt

scripts/format.mts

@@ -14,11 +14,14 @@ const toolchain = getToolchainArgument('format');
 const fix = popArgument(formatArgs, '--fix');
 
 const [cargoArgs, fmtArgs] = partitionArguments(formatArgs, '--');
-const manifestPath = path.join(workingDirectory, folder, 'Cargo.toml');
+const targetDir = path.join(workingDirectory, folder);
+const manifestPath = path.join(targetDir, 'Cargo.toml');
 
 // Format the client.
 if (fix) {
+  await $`tombi format -- ${targetDir}`
   await $`cargo ${toolchain} fmt --manifest-path ${manifestPath} ${cargoArgs} -- ${fmtArgs}`;
 } else {
+  await $`tombi format --check -- ${targetDir}`
   await $`cargo ${toolchain} fmt --manifest-path ${manifestPath} ${cargoArgs} -- --check ${fmtArgs}`;
 }

scripts/lint-toml.mts

@@ -0,0 +1,12 @@
+#!/usr/bin/env zx
+import 'zx/globals';
+import {
+  cliArguments,
+  workingDirectory,
+} from './setup/shared.mts';
+
+const [folder, ...args] = cliArguments();
+
+const targetDir = path.join(workingDirectory, folder);
+
+await $`tombi lint -- ${targetDir}`;

scripts/lint.mts

@@ -6,4 +6,5 @@ await Promise.all([
   $`tsx ./scripts/clippy.mts ${args}`,
   $`tsx ./scripts/doc.mts ${args}`,
   $`tsx ./scripts/hack.mts ${args}`,
+  $`tsx ./scripts/lint-toml.mts ${args}`,
 ]);