@mintlify/cli 4.0.1338 → 4.0.1340

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1338",
+  "version": "4.0.1340",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -33,7 +33,7 @@
   "scripts": {
     "dev": "yarn build && NODE_NO_WARNINGS=1 node bin/index.js",
     "prepare": "npm run build",
-    "build": "tsc --project tsconfig.build.json",
+    "build": "tsc --project tsconfig.build.json && node scripts/bundle-converter.mjs",
     "clean:build": "rimraf bin",
     "clean:all": "rimraf node_modules .eslintcache && yarn clean:build",
     "watch": "tsc --watch",
@@ -46,7 +46,7 @@
   "dependencies": {
     "@inquirer/prompts": "7.9.0",
     "@mintlify/common": "1.0.1042",
-    "@mintlify/link-rot": "3.0.1234",
+    "@mintlify/link-rot": "3.0.1235",
     "@mintlify/models": "0.0.343",
     "@mintlify/prebuild": "1.0.1190",
     "@mintlify/previewing": "4.0.1259",
@@ -64,9 +64,18 @@
     "open": "8.4.2",
     "openid-client": "6.8.2",
     "posthog-node": "5.17.2",
+    "prosemirror-model": "^1.25.0",
     "react": "19.2.3",
+    "remark": "^15.0.1",
+    "remark-frontmatter": "^5.0.0",
+    "remark-gfm": "^4.0.1",
+    "remark-math": "^6.0.0",
+    "remark-mdx": "^3.1.1",
+    "remark-stringify": "^11.0.0",
     "semver": "7.7.2",
+    "unified": "^11.0.5",
     "unist-util-visit": "5.0.0",
+    "yaml": "^2.8.3",
     "yargs": "17.7.1",
     "zod": "4.3.6"
   },
@@ -74,6 +83,7 @@
     "keytar": "7.9.0"
   },
   "devDependencies": {
+    "@mintlify/editor": "0.0.248",
     "@mintlify/ts-config": "2.0.2",
     "@tsconfig/recommended": "1.0.2",
     "@types/adm-zip": "0.5.7",
@@ -82,6 +92,7 @@
     "@types/mdast": "4.0.4",
     "@types/node": "18.15.0",
     "@types/yargs": "17.0.22",
+    "esbuild": "0.25.12",
     "openapi-types": "12.1.3",
     "oxfmt": "^0.51.0",
     "oxlint": "1.66.0",
@@ -92,5 +103,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "d8790a8402b1fd3460e84c83d060de276a1cb163"
+  "gitHead": "a35c4acbb224d6bfb0155931033e6c0c51896dc7"
 }

package/scripts/bundle-converter.mjs

@@ -0,0 +1,24 @@
+import { build } from 'esbuild';
+import { createRequire } from 'node:module';
+
+const require = createRequire(import.meta.url);
+const entry = require.resolve('@mintlify/editor/converter');
+
+await build({
+  entryPoints: [entry],
+  outfile: 'bin/vendor/converter.js',
+  bundle: true,
+  format: 'esm',
+  platform: 'node',
+  target: 'node18',
+  external: [
+    '@mintlify/common',
+    '@mintlify/validation',
+    'mdast-util-*',
+    'prosemirror-*',
+    'remark*',
+    'unified',
+    'unist-util-*',
+    'yaml',
+  ],
+});

package/src/cli.tsx

@@ -24,6 +24,8 @@ 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 { resolveExplicitFiles } from './deslop/resolveFiles.js';
+import { formatHandler } from './format.js';
 import {
   CMD_EXEC_PATH,
   checkPort,
@@ -296,6 +298,11 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
         'Check for broken links',
         (yargs) =>
           yargs
+            .option('files', {
+              type: 'string',
+              array: true,
+              description: 'Files or globs to check (defaults to the whole site)',
+            })
             .option('check-anchors', {
               type: 'boolean',
               default: false,
@@ -315,19 +322,35 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
               type: 'boolean',
               default: false,
               description: 'also check that docs.json redirect destinations resolve to valid paths',
-            }),
+            })
+            .example('mint broken-links --files introduction.mdx', 'Check a specific page')
+            .example('mint broken-links --files "guides/**/*.mdx"', 'Check pages matching a glob'),
         async (argv) => {
           await autoUpgradeIfNeeded();
           addLog(<SpinnerLog message="checking for broken links..." />);
           try {
+            const fileArgs = (argv.files ?? []).map(String).filter(Boolean);
+            const sourceFiles =
+              fileArgs.length > 0
+                ? new Set(
+                    (await resolveExplicitFiles(CMD_EXEC_PATH, fileArgs)).map((file) =>
+                      path.normalize(file)
+                    )
+                  )
+                : undefined;
             const graph = await buildGraph(undefined, {
               checkSnippets: argv['check-snippets'],
             });
             graph.precomputeFileResolutions();
 
-            const brokenInternalLinks = graph.getBrokenInternalLinks({
-              checkAnchors: argv['check-anchors'],
-            });
+            const brokenInternalLinks = graph
+              .getBrokenInternalLinks({
+                checkAnchors: argv['check-anchors'],
+              })
+              .filter(
+                ({ relativeDir, filename }) =>
+                  !sourceFiles || sourceFiles.has(path.join(relativeDir, filename))
+              );
 
             const brokenLinksByFile: Record<string, string[]> = {};
 
@@ -342,7 +365,10 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
             });
 
             if (argv['check-external']) {
-              const brokenExternalLinks = await getBrokenExternalLinks(graph);
+              const brokenExternalLinks = await getBrokenExternalLinks(
+                graph,
+                sourceFiles ? { sourceFiles } : undefined
+              );
               for (const result of brokenExternalLinks) {
                 for (const source of result.sources) {
                   const label = result.status
@@ -711,6 +737,15 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
             ),
         deslopHandler
       )
+      .command(
+        'format',
+        'Format MDX files in the current directory',
+        (yargs) =>
+          yargs
+            .usage('usage: mint format')
+            .example('mint format', 'format all MDX files in the current directory'),
+        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 { 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 { mdxToPm, pmToMdx } = await import('./vendor/converter.js');
+  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, { singleDollarTextMath: false });
+      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);
+};

package/src/vendor/converter.ts

@@ -0,0 +1 @@
+export * from '@mintlify/editor/converter';