@mintlify/cli 4.0.1705 → 4.0.1706

package/bin/brokenLinks.js

@@ -0,0 +1,122 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+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';
+export const brokenLinksHandler = (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    yield autoUpgradeIfNeeded();
+    addLog(_jsx(SpinnerLog, { message: "checking for broken links..." }));
+    try {
+        const docsRoot = yield findDocsRoot(CMD_EXEC_PATH);
+        const fileArgs = ((_a = argv.files) !== null && _a !== void 0 ? _a : []).map(String).filter(Boolean);
+        const sourceFiles = fileArgs.length > 0
+            ? new Set((yield 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();
+        const graph = yield 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 === null || dependencies === void 0 ? void 0 : 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 = {};
+        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 = yield 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 = yield 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(_jsx(SuccessLog, { message: "no broken links found" }));
+            yield terminate(0);
+        }
+        clearLogs();
+        if (hasBrokenLinks) {
+            addLog(_jsx(BrokenLinksLog, { brokenLinksByFile: brokenLinksByFile }));
+        }
+        else {
+            addLog(_jsx(SuccessLog, { message: "no broken links found in the files that parsed" }));
+        }
+        for (const message of parseErrors) {
+            addLog(_jsx(ErrorLog, { message: message }));
+        }
+        if (parseErrors.length > 0) {
+            addLog(_jsx(WarningLog, { message: `skipped ${parseErrors.length} file(s) that could not be parsed; links in them were not checked` }));
+        }
+    }
+    catch (err) {
+        addLog(_jsx(ErrorLog, { message: err instanceof Error ? err.message : 'unknown error' }));
+        yield terminate(1);
+    }
+    yield terminate(1);
+});

package/bin/cli.js

@@ -8,8 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { buildGraph, getBrokenExternalLinks, getFilesLinksDependOn } from '@mintlify/link-rot';
-import { addLog, dev, exportSite, validateBuild, ErrorLog, SpinnerLog, SuccessLog, Logs, clearLogs, BrokenLinksLog, WarningLog, } from '@mintlify/previewing';
+import { addLog, dev, exportSite, validateBuild, ErrorLog, SuccessLog, Logs, WarningLog, } from '@mintlify/previewing';
 import { thumbnailOverrideSchema } from '@mintlify/validation';
 import { render, Text } from 'ink';
 import fs from 'node:fs/promises';
@@ -20,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';
@@ -27,7 +27,7 @@ import { API_URL } from './constants.js';
 import { DEPLOY_HELP, deploymentInstructions } from './deploy-instructions.js';
 import { formatDeployment, prepareAgentDeployment } from './deploy.js';
 import { formatHandler } from './format.js';
-import { CMD_EXEC_PATH, checkPort, checkNodeVersion, autoUpgradeIfNeeded, findDocsRoot, getVersions, isAI, suppressConsoleWarnings, terminate, } from './helpers.js';
+import { CMD_EXEC_PATH, checkPort, checkNodeVersion, autoUpgradeIfNeeded, getVersions, isAI, suppressConsoleWarnings, terminate, } from './helpers.js';
 import { init } from './init.js';
 import { getAccessToken } from './keyring.js';
 import { login } from './login.js';
@@ -36,7 +36,6 @@ import { mdxLinter } from './mdxLinter.js';
 import { createTelemetryMiddleware } from './middlewares/telemetryMiddleware.js';
 import { ogCommand } from './og.js';
 import { buildOverlayRegistryForCheck, 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';
@@ -362,112 +361,7 @@ export const cli = ({ packageName = 'mint' }) => {
         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'), (argv) => __awaiter(void 0, void 0, void 0, function* () {
-        var _a;
-        yield autoUpgradeIfNeeded();
-        addLog(_jsx(SpinnerLog, { message: "checking for broken links..." }));
-        try {
-            const docsRoot = yield findDocsRoot(CMD_EXEC_PATH);
-            const fileArgs = ((_a = argv.files) !== null && _a !== void 0 ? _a : []).map(String).filter(Boolean);
-            const sourceFiles = fileArgs.length > 0
-                ? new Set((yield 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();
-            const graph = yield 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 === null || dependencies === void 0 ? void 0 : 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 = {};
-            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 = yield 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 = yield 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(_jsx(SuccessLog, { message: "no broken links found" }));
-                yield terminate(0);
-            }
-            clearLogs();
-            if (hasBrokenLinks) {
-                addLog(_jsx(BrokenLinksLog, { brokenLinksByFile: brokenLinksByFile }));
-            }
-            else {
-                addLog(_jsx(SuccessLog, { message: "no broken links found in the files that parsed" }));
-            }
-            for (const message of parseErrors) {
-                addLog(_jsx(ErrorLog, { message: message }));
-            }
-            if (parseErrors.length > 0) {
-                addLog(_jsx(WarningLog, { message: `skipped ${parseErrors.length} file(s) that could not be parsed; links in them were not checked` }));
-            }
-        }
-        catch (err) {
-            addLog(_jsx(ErrorLog, { message: err instanceof Error ? err.message : 'unknown error' }));
-            yield terminate(1);
-        }
-        yield terminate(1);
-    }))
+        .example('mint broken-links --files "guides/**/*.mdx"', 'Check pages matching a glob'), (argv) => brokenLinksHandler(argv))
         .command('status', 'View current authentication status', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
         yield status();
         yield terminate(0);