@mintlify/cli 4.0.1333 → 4.0.1335

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1333",
+  "version": "4.0.1335",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -45,12 +45,13 @@
   },
   "dependencies": {
     "@inquirer/prompts": "7.9.0",
-    "@mintlify/common": "1.0.1039",
-    "@mintlify/link-rot": "3.0.1231",
-    "@mintlify/models": "0.0.342",
-    "@mintlify/prebuild": "1.0.1187",
-    "@mintlify/previewing": "4.0.1256",
-    "@mintlify/validation": "0.1.796",
+    "@mintlify/common": "1.0.1040",
+    "@mintlify/editor": "0.0.246",
+    "@mintlify/link-rot": "3.0.1232",
+    "@mintlify/models": "0.0.343",
+    "@mintlify/prebuild": "1.0.1188",
+    "@mintlify/previewing": "4.0.1257",
+    "@mintlify/validation": "0.1.797",
     "adm-zip": "0.5.16",
     "chalk": "5.2.0",
     "color": "4.2.3",
@@ -92,5 +93,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "48ebadbb106c4c5969cd83c048e660bc39955f3f"
+  "gitHead": "60dbc26b00135e7d72e7728a661c64f569352f91"
 }

package/src/cli.tsx

@@ -24,6 +24,7 @@ import { setTelemetryEnabled } from './config.js';
 import { getConfigValue, setConfigValue, clearConfigValue } from './config.js';
 import { API_URL } from './constants.js';
 import { deslopHandler } from './deslop/index.js';
+import { formatHandler } from './format.js';
 import {
   CMD_EXEC_PATH,
   checkPort,
@@ -711,6 +712,7 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
             ),
         deslopHandler
       )
+      .command('format', false, () => undefined, formatHandler)
       // Coming soon commands — visible in help, tracked via telemetry to gauge interest.
       .command(
         'ai',

package/src/format.tsx

@@ -0,0 +1,67 @@
+import { isMintIgnored, processMintIgnoreString } from '@mintlify/common';
+import { mdxToPm, pmToMdx } from '@mintlify/editor/converter';
+import { getMintIgnore } from '@mintlify/prebuild';
+import { addLog, ErrorLog, SuccessLog } from '@mintlify/previewing';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+import { CMD_EXEC_PATH, terminate } from './helpers.js';
+
+async function getGitIgnore(): Promise<string[]> {
+  try {
+    const content = await fs.readFile(path.join(CMD_EXEC_PATH, '.gitignore'), 'utf-8');
+    return processMintIgnoreString(content);
+  } catch {
+    return [];
+  }
+}
+
+async function* walk(dir: string, ignores: string[]): AsyncGenerator<string> {
+  const entries = await fs.readdir(dir, { withFileTypes: true });
+  for (const entry of entries) {
+    const full = path.join(dir, entry.name);
+    const relative = path.relative(CMD_EXEC_PATH, full).split(path.sep).join('/');
+    if (entry.isDirectory()) {
+      if (isMintIgnored(`${relative}/`, ignores)) continue;
+      yield* walk(full, ignores);
+    } else if (entry.name.endsWith('.mdx')) {
+      if (isMintIgnored(relative, ignores)) continue;
+      yield full;
+    }
+  }
+}
+
+export const formatHandler = async (): Promise<void> => {
+  const ignores = [...(await getGitIgnore()), ...(await getMintIgnore(CMD_EXEC_PATH))];
+  let total = 0;
+  let changed = 0;
+  let failed = 0;
+
+  for await (const file of walk(CMD_EXEC_PATH, ignores)) {
+    total++;
+    const relative = path.relative(CMD_EXEC_PATH, file);
+    try {
+      const raw = await fs.readFile(file, 'utf-8');
+      const { doc, frontmatter } = mdxToPm(raw);
+      const formatted = `${pmToMdx(doc, { frontmatter })}\n`;
+      if (formatted !== raw) {
+        await fs.writeFile(file, formatted);
+        changed++;
+      }
+    } catch (error) {
+      failed++;
+      addLog(
+        <ErrorLog
+          message={`${relative}: ${error instanceof Error ? error.message : 'unknown error'}`}
+        />
+      );
+    }
+  }
+
+  addLog(
+    <SuccessLog
+      message={`formatted ${changed} of ${total} mdx file${total === 1 ? '' : 's'}${failed > 0 ? ` (${failed} failed)` : ''}`}
+    />
+  );
+  await terminate(failed > 0 ? 1 : 0);
+};