Format the project with oxfmt

.devcontainer/devcontainer.json

@@ -1,18 +1,18 @@
 {
-    "name": "Ona",
-    "image": "mcr.microsoft.com/devcontainers/base:2.0.4-noble",
-    "containerEnv": {
-        "DO_NOT_TRACK": "1",
-        "NO_UPDATE_NOTIFIER": "1",
-        "COREPACK_ENABLE_DOWNLOAD_PROMPT": "0"
+  "name": "Ona",
+  "image": "mcr.microsoft.com/devcontainers/base:2.0.4-noble",
+  "containerEnv": {
+    "DO_NOT_TRACK": "1",
+    "NO_UPDATE_NOTIFIER": "1",
+    "COREPACK_ENABLE_DOWNLOAD_PROMPT": "0"
+  },
+  "postCreateCommand": ".devcontainer/lifecycle/post-create.sh",
+  "remoteUser": "vscode",
+  "features": {
+    "ghcr.io/devcontainers/features/node:1": {
+      "version": "22",
+      "pnpmVersion": "none"
     },
-    "postCreateCommand": ".devcontainer/lifecycle/post-create.sh",
-    "remoteUser": "vscode",
-    "features": {
-        "ghcr.io/devcontainers/features/node:1": {
-            "version": "22",
-            "pnpmVersion": "none"
-        },
-        "ghcr.io/devcontainers/features/github-cli:1": {}
-    }
+    "ghcr.io/devcontainers/features/github-cli:1": {}
+  }
 }

.github/workflows/ci.yml

@@ -29,6 +29,9 @@ jobs:
       - name: Generate API client
         run: pnpm generate
 
+      - name: Check formatting
+        run: pnpm format:check
+
       - name: Typecheck
         run: pnpm typecheck
 

.oxfmtrc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "printWidth": 80,
+  "ignorePatterns": ["*.md", "api-spec.json", "pnpm-lock.yaml"]
+}

AGENTS.md

@@ -14,6 +14,10 @@ We map from the REST api path to a command structure for CLI with the following
 - Use the same placeholder for common inputs: `<id>` for IDs, `<timestamp>` for date-times, `<date>` for date-only values, `<bool>` for true/false, `<query>` for search terms, `<json>` for inline JSON, `<path>` for local files, and `<text>` for other free text.
 - Mark repeatable flags `(repeatable)`. Describe timestamps as “ISO 8601 timestamp”; avoid repeated format examples.
 
+# Formatting
+
+- Run `pnpm format` (oxfmt) before committing; CI runs `pnpm format:check`. Markdown is not formatted.
+
 # Testing
 
 - Test changes end to end when modifying the CLI. Build the binary and test the commands.

package.json

@@ -2,26 +2,24 @@
   "name": "@vanta/cli",
   "version": "0.2.0",
   "description": "Vanta CLI — manage compliance resources from the terminal",
-  "type": "module",
+  "license": "SEE LICENSE IN LICENSE",
   "bin": {
     "vanta": "./dist/cli.js"
   },
   "files": [
     "dist"
   ],
+  "type": "module",
   "scripts": {
     "generate": "openapi-ts",
     "dev": "tsx src/cli.ts",
     "build": "pnpm run generate && tsup",
     "typecheck": "tsc --noEmit",
     "test": "node --import tsx --test 'src/**/*.test.ts'",
-    "build:binaries": "tsx scripts/build-binaries.ts"
-  },
-  "packageManager": "[email protected]",
-  "engines": {
-    "node": ">=22"
+    "build:binaries": "tsx scripts/build-binaries.ts",
+    "format": "oxfmt",
+    "format:check": "oxfmt --check"
   },
-  "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
     "@napi-rs/keyring": "^1.3.0",
     "@toon-format/toon": "^0.8.0",
@@ -31,8 +29,13 @@
     "@hey-api/openapi-ts": "^0.85.0",
     "@types/node": "^22.15.0",
     "bun": "^1.3.14",
+    "oxfmt": "0.72.0",
     "tsup": "^8.5.0",
     "tsx": "^4.20.0",
     "typescript": "^5.8.0"
-  }
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "packageManager": "[email protected]"
 }

scripts/build-binaries.ts

@@ -31,7 +31,9 @@ const targets = [
 function run(cmd: string, args: string[]): void {
   const result = spawnSync(cmd, args, { stdio: "inherit" });
   if (result.status !== 0) {
-    throw new Error(`${cmd} ${args.join(" ")} failed with code ${result.status}`);
+    throw new Error(
+      `${cmd} ${args.join(" ")} failed with code ${result.status}`,
+    );
   }
 }