@mintlify/cli 4.0.1704 → 4.0.1706

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1704",
+  "version": "4.0.1706",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -45,12 +45,12 @@
   },
   "dependencies": {
     "@inquirer/prompts": "7.9.0",
-    "@mintlify/common": "1.0.1292",
-    "@mintlify/link-rot": "3.0.1516",
+    "@mintlify/common": "1.0.1293",
+    "@mintlify/link-rot": "3.0.1518",
     "@mintlify/models": "0.0.378",
-    "@mintlify/og": "0.0.90",
-    "@mintlify/prebuild": "1.0.1457",
-    "@mintlify/previewing": "4.0.1535",
+    "@mintlify/og": "0.0.91",
+    "@mintlify/prebuild": "1.0.1458",
+    "@mintlify/previewing": "4.0.1536",
     "@mintlify/validation": "0.1.940",
     "adm-zip": "0.6.0",
     "chalk": "5.2.0",
@@ -82,7 +82,7 @@
     "keytar": "7.9.0"
   },
   "devDependencies": {
-    "@mintlify/editor": "0.0.555",
+    "@mintlify/editor": "0.0.556",
     "@mintlify/ts-config": "2.0.2",
     "@tsconfig/recommended": "1.0.2",
     "@types/detect-port": "1.3.2",
@@ -101,5 +101,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "7d40d8a1004c6a1603b9edb2bb906c23799ccae7"
+  "gitHead": "a13039de2913c7f9430361c153ea313a3efc4290"
 }

package/src/brokenLinks.tsx

@@ -0,0 +1,152 @@
+import { buildGraph, getBrokenExternalLinks, getFilesLinksDependOn } from '@mintlify/link-rot';
+import {
+  addLog,
+  clearLogs,
+  BrokenLinksLog,
+  ErrorLog,
+  SpinnerLog,
+  SuccessLog,
+  WarningLog,
+} from '@mintlify/previewing';
+import fs from 'node:fs/promises';
+import path from 'path';
+
+import { autoUpgradeIfNeeded, CMD_EXEC_PATH, findDocsRoot, terminate } from './helpers.js';
+import { resolveExplicitFiles } from './resolveFiles.js';
+
+type BrokenLinksArgs = {
+  files?: (string | number)[];
+  'check-anchors': boolean;
+  'check-external': boolean;
+  'check-snippets': boolean;
+  'check-redirects': boolean;
+};
+
+export const brokenLinksHandler = async (argv: BrokenLinksArgs): Promise<void> => {
+  await autoUpgradeIfNeeded();
+  addLog(<SpinnerLog message="checking for broken links..." />);
+  try {
+    const docsRoot = await findDocsRoot(CMD_EXEC_PATH);
+    const fileArgs = (argv.files ?? []).map(String).filter(Boolean);
+    const sourceFiles =
+      fileArgs.length > 0
+        ? new Set(
+            (await resolveExplicitFiles(CMD_EXEC_PATH, fileArgs)).map((file) =>
+              path.relative(docsRoot, path.resolve(CMD_EXEC_PATH, file))
+            )
+          )
+        : undefined;
+    // One unparseable page shouldn't hide every other result: report it and keep going
+    const parseErrorsByFile = new Map<string, string>();
+    const graph = await buildGraph(docsRoot, {
+      checkSnippets: argv['check-snippets'],
+      onParseError: (filePath, error) => parseErrorsByFile.set(filePath, error.message),
+    });
+    graph.precomputeFileResolutions();
+    // With --files, a failure elsewhere only matters when a selected link needs that
+    // file: an anchor pointing at it, or a snippet the selected page renders
+    const dependencies = sourceFiles
+      ? getFilesLinksDependOn(graph, sourceFiles, {
+          checkAnchors: argv['check-anchors'],
+          checkSnippets: argv['check-snippets'],
+        })
+      : undefined;
+    const parseErrors = [...parseErrorsByFile]
+      .filter(
+        ([filePath]) =>
+          !sourceFiles ||
+          sourceFiles.has(filePath) ||
+          dependencies?.has(filePath.split(path.sep).join('/'))
+      )
+      .map(([, message]) => message);
+
+    const brokenInternalLinks = graph
+      .getBrokenInternalLinks({
+        checkAnchors: argv['check-anchors'],
+      })
+      .filter(
+        ({ relativeDir, filename }) =>
+          !sourceFiles || sourceFiles.has(path.join(relativeDir, filename))
+      );
+
+    const brokenLinksByFile: Record<string, string[]> = {};
+
+    brokenInternalLinks.forEach((mdxPath) => {
+      const filename = path.join(mdxPath.relativeDir, mdxPath.filename);
+      const existing = brokenLinksByFile[filename];
+      if (existing) {
+        existing.push(mdxPath.originalPath);
+      } else {
+        brokenLinksByFile[filename] = [mdxPath.originalPath];
+      }
+    });
+
+    if (argv['check-external']) {
+      const brokenExternalLinks = await getBrokenExternalLinks(
+        graph,
+        sourceFiles ? { sourceFiles } : undefined
+      );
+      for (const result of brokenExternalLinks) {
+        for (const source of result.sources) {
+          const label = result.status
+            ? `${result.url} (${result.status})`
+            : `${result.url} (${result.error})`;
+          const existing = brokenLinksByFile[source.file];
+          if (existing) {
+            existing.push(label);
+          } else {
+            brokenLinksByFile[source.file] = [label];
+          }
+        }
+      }
+    }
+
+    if (argv['check-redirects']) {
+      const brokenRedirects = graph.getBrokenRedirects();
+      if (brokenRedirects.length > 0) {
+        const configFilename = await fs
+          .access(path.join(docsRoot, 'docs.json'))
+          .then(() => 'docs.json')
+          .catch(() => 'mint.json');
+        const labels = brokenRedirects.map(
+          ({ source, destination }) => `${source} → ${destination}`
+        );
+        const existing = brokenLinksByFile[configFilename];
+        if (existing) {
+          existing.push(...labels);
+        } else {
+          brokenLinksByFile[configFilename] = labels;
+        }
+      }
+    }
+
+    const hasBrokenLinks = Object.keys(brokenLinksByFile).length > 0;
+    if (!hasBrokenLinks && parseErrors.length === 0) {
+      clearLogs();
+      addLog(<SuccessLog message="no broken links found" />);
+      await terminate(0);
+    }
+
+    clearLogs();
+    if (hasBrokenLinks) {
+      addLog(<BrokenLinksLog brokenLinksByFile={brokenLinksByFile} />);
+    } else {
+      addLog(<SuccessLog message="no broken links found in the files that parsed" />);
+    }
+    for (const message of parseErrors) {
+      addLog(<ErrorLog message={message} />);
+    }
+    if (parseErrors.length > 0) {
+      addLog(
+        <WarningLog
+          message={`skipped ${parseErrors.length} file(s) that could not be parsed; links in them were not checked`}
+        />
+      );
+    }
+  } catch (err) {
+    addLog(<ErrorLog message={err instanceof Error ? err.message : 'unknown error'} />);
+    await terminate(1);
+  }
+
+  await terminate(1);
+};

package/src/cli.tsx

@@ -1,15 +1,11 @@
-import { buildGraph, getBrokenExternalLinks, getFilesLinksDependOn } from '@mintlify/link-rot';
 import {
   addLog,
   dev,
   exportSite,
   validateBuild,
   ErrorLog,
-  SpinnerLog,
   SuccessLog,
   Logs,
-  clearLogs,
-  BrokenLinksLog,
   WarningLog,
 } from '@mintlify/previewing';
 import { thumbnailOverrideSchema } from '@mintlify/validation';
@@ -23,6 +19,7 @@ import { accessibilityCheck } from './accessibilityCheck.js';
 import { addDomain } from './addDomain.js';
 import { createAgentClaimLink } from './agent-claim.js';
 import { analyticsBuilder } from './analytics/index.js';
+import { brokenLinksHandler } from './brokenLinks.js';
 import { comingSoon } from './comingSoon.js';
 import { setTelemetryEnabled } from './config.js';
 import { getConfigValue, setConfigValue, clearConfigValue } from './config.js';
@@ -35,7 +32,6 @@ import {
   checkPort,
   checkNodeVersion,
   autoUpgradeIfNeeded,
-  findDocsRoot,
   getVersions,
   isAI,
   suppressConsoleWarnings,
@@ -53,7 +49,6 @@ import {
   checkOpenApiFile,
   getOpenApiFilenamesFromDocsConfig,
 } from './openApiCheck.js';
-import { resolveExplicitFiles } from './resolveFiles.js';
 import { scoreHandler } from './score/index.js';
 import { sendPublishPrompt, signup } from './signup.js';
 import { status, getCliSubdomains } from './status.js';
@@ -451,134 +446,7 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
             })
             .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 docsRoot = await findDocsRoot(CMD_EXEC_PATH);
-            const fileArgs = (argv.files ?? []).map(String).filter(Boolean);
-            const sourceFiles =
-              fileArgs.length > 0
-                ? new Set(
-                    (await resolveExplicitFiles(CMD_EXEC_PATH, fileArgs)).map((file) =>
-                      path.relative(docsRoot, path.resolve(CMD_EXEC_PATH, file))
-                    )
-                  )
-                : undefined;
-            // One unparseable page shouldn't hide every other result: report it and keep going
-            const parseErrorsByFile = new Map<string, string>();
-            const graph = await buildGraph(docsRoot, {
-              checkSnippets: argv['check-snippets'],
-              onParseError: (filePath, error) => parseErrorsByFile.set(filePath, error.message),
-            });
-            graph.precomputeFileResolutions();
-            // With --files, a failure elsewhere only matters when a selected link needs that
-            // file: an anchor pointing at it, or a snippet the selected page renders
-            const dependencies = sourceFiles
-              ? getFilesLinksDependOn(graph, sourceFiles, {
-                  checkAnchors: argv['check-anchors'],
-                  checkSnippets: argv['check-snippets'],
-                })
-              : undefined;
-            const parseErrors = [...parseErrorsByFile]
-              .filter(
-                ([filePath]) =>
-                  !sourceFiles ||
-                  sourceFiles.has(filePath) ||
-                  dependencies?.has(filePath.split(path.sep).join('/'))
-              )
-              .map(([, message]) => message);
-
-            const brokenInternalLinks = graph
-              .getBrokenInternalLinks({
-                checkAnchors: argv['check-anchors'],
-              })
-              .filter(
-                ({ relativeDir, filename }) =>
-                  !sourceFiles || sourceFiles.has(path.join(relativeDir, filename))
-              );
-
-            const brokenLinksByFile: Record<string, string[]> = {};
-
-            brokenInternalLinks.forEach((mdxPath) => {
-              const filename = path.join(mdxPath.relativeDir, mdxPath.filename);
-              const existing = brokenLinksByFile[filename];
-              if (existing) {
-                existing.push(mdxPath.originalPath);
-              } else {
-                brokenLinksByFile[filename] = [mdxPath.originalPath];
-              }
-            });
-
-            if (argv['check-external']) {
-              const brokenExternalLinks = await getBrokenExternalLinks(
-                graph,
-                sourceFiles ? { sourceFiles } : undefined
-              );
-              for (const result of brokenExternalLinks) {
-                for (const source of result.sources) {
-                  const label = result.status
-                    ? `${result.url} (${result.status})`
-                    : `${result.url} (${result.error})`;
-                  const existing = brokenLinksByFile[source.file];
-                  if (existing) {
-                    existing.push(label);
-                  } else {
-                    brokenLinksByFile[source.file] = [label];
-                  }
-                }
-              }
-            }
-
-            if (argv['check-redirects']) {
-              const brokenRedirects = graph.getBrokenRedirects();
-              if (brokenRedirects.length > 0) {
-                const configFilename = await fs
-                  .access(path.join(docsRoot, 'docs.json'))
-                  .then(() => 'docs.json')
-                  .catch(() => 'mint.json');
-                const labels = brokenRedirects.map(
-                  ({ source, destination }) => `${source} → ${destination}`
-                );
-                const existing = brokenLinksByFile[configFilename];
-                if (existing) {
-                  existing.push(...labels);
-                } else {
-                  brokenLinksByFile[configFilename] = labels;
-                }
-              }
-            }
-
-            const hasBrokenLinks = Object.keys(brokenLinksByFile).length > 0;
-            if (!hasBrokenLinks && parseErrors.length === 0) {
-              clearLogs();
-              addLog(<SuccessLog message="no broken links found" />);
-              await terminate(0);
-            }
-
-            clearLogs();
-            if (hasBrokenLinks) {
-              addLog(<BrokenLinksLog brokenLinksByFile={brokenLinksByFile} />);
-            } else {
-              addLog(<SuccessLog message="no broken links found in the files that parsed" />);
-            }
-            for (const message of parseErrors) {
-              addLog(<ErrorLog message={message} />);
-            }
-            if (parseErrors.length > 0) {
-              addLog(
-                <WarningLog
-                  message={`skipped ${parseErrors.length} file(s) that could not be parsed; links in them were not checked`}
-                />
-              );
-            }
-          } catch (err) {
-            addLog(<ErrorLog message={err instanceof Error ? err.message : 'unknown error'} />);
-            await terminate(1);
-          }
-
-          await terminate(1);
-        }
+        (argv) => brokenLinksHandler(argv)
       )
       .command(
         'status',