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

@@ -22,6 +22,24 @@ jobs:
       - name: Lint Client JS
         run: pnpm clients:js:lint
 
+  format_and_lint_workspace_toml:
+    name: Format & Lint workspace level Toml
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Environment
+        uses: ./.github/actions/setup
+        with:
+          tombi: true
+
+      - name: Format workspace level Toml
+        run: pnpm workspace:toml:format
+
+      - name: Lint workspace level Toml
+        run: pnpm workspace:toml:lint
+
   format_and_lint_client_rust:
     if: false # Disabled until we have a Rust client
     name: Format & Lint Client Rust
@@ -35,6 +53,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format Client Rust
         run: pnpm clients:rust:format
@@ -54,6 +73,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format
         run: pnpm programs:format
@@ -73,6 +93,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format
         run: pnpm p-interface:format
@@ -92,6 +113,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format
         run: pnpm p-token:format
@@ -111,6 +133,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
 
       - name: Format
         run: pnpm interface:format

.github/workflows/publish-rust.yml

@@ -56,6 +56,7 @@ jobs:
         with:
           clippy: true
           rustfmt: true
+          tombi: true
           solana: true
           cargo-cache-key: cargo-test-publish-${{ inputs.package_path }}
           cargo-cache-fallback-key: cargo-test-publish
@@ -66,6 +67,12 @@ jobs:
       - name: Lint
         run: pnpm zx ./scripts/rust/lint.mjs "${{ inputs.package_path }}"
 
+      - name: Format Toml
+        run: pnpm zx ./scripts/toml/format.mjs "${{ inputs.package_path }}"
+
+      - name: Lint Toml
+        run: pnpm zx ./scripts/toml/lint.mjs "${{ inputs.package_path }}"
+
       - name: Build programs
         run: pnpm programs:build
 

package.json

@@ -1,6 +1,8 @@
 {
   "private": true,
   "scripts": {
+    "workspace:toml:format": "zx ./scripts/toml/format.mjs Cargo.toml rust-toolchain.toml rustfmt.toml scripts/spellcheck.toml",
+    "workspace:toml:lint": "zx ./scripts/toml/lint.mjs Cargo.toml rust-toolchain.toml rustfmt.toml scripts/spellcheck.toml",
     "programs:build": "zx ./scripts/rust/build-sbf.mjs program",
     "programs:format": "zx ./scripts/rust/format.mjs program",
     "programs:lint": "zx ./scripts/rust/lint.mjs program",

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}`;
 }

scripts/toml/format.mjs

@@ -0,0 +1,13 @@
+#!/usr/bin/env zx
+import 'zx/globals';
+import { cliArguments, popArgument } from '../utils.mjs';
+
+const args = cliArguments();
+
+const fix = popArgument(args, '--fix');
+
+if (fix) {
+  await $`tombi format ${args}`;
+} else {
+  await $`tombi format --check ${args}`;
+}

scripts/toml/lint.mjs

@@ -0,0 +1,7 @@
+#!/usr/bin/env zx
+import 'zx/globals';
+import { cliArguments } from '../utils.mjs';
+
+const args = cliArguments();
+
+await $`tombi lint ${args}`;