@mintlify/cli 4.0.1433 → 4.0.1437

package/bin/cli.js

@@ -31,6 +31,7 @@ import { login } from './login.js';
 import { logout } from './logout.js';
 import { mdxLinter } from './mdxLinter.js';
 import { createTelemetryMiddleware } from './middlewares/telemetryMiddleware.js';
+import { mintTestHandler } from './mintTest.js';
 import { checkOpenApiFile, getOpenApiFilenamesFromDocsConfig } from './openApiCheck.js';
 import { resolveExplicitFiles } from './resolveFiles.js';
 import { scoreHandler } from './score/index.js';
@@ -69,12 +70,15 @@ const showWelcome = (packageName) => __awaiter(void 0, void 0, void 0, function*
     yield terminate(0);
 });
 export const cli = ({ packageName = 'mint' }) => {
-    if (shouldShowWelcome(hideBin(process.argv))) {
+    const commandArguments = hideBin(process.argv);
+    if (shouldShowWelcome(commandArguments)) {
         return showWelcome(packageName);
     }
     const telemetryMiddleware = createTelemetryMiddleware();
-    render(_jsx(Logs, {}));
-    return (yargs(hideBin(process.argv))
+    if (commandArguments.find((argument) => !argument.startsWith('-')) !== 'test') {
+        render(_jsx(Logs, {}));
+    }
+    return (yargs(commandArguments)
         .scriptName(packageName)
         .option('telemetry', {
         type: 'boolean',
@@ -196,6 +200,9 @@ export const cli = ({ packageName = 'mint' }) => {
         const { cli: cliVersion } = getVersions(packageName);
         yield validateBuild(Object.assign(Object.assign({}, argv), { packageName,
             cliVersion }));
+    }))
+        .command('test', 'Test runnable code blocks with a local coding agent', (yargs) => yargs.usage('usage: mint test'), () => __awaiter(void 0, void 0, void 0, function* () {
+        yield mintTestHandler();
     }))
         .command('export', 'Export a static site for air-gapped deployment', (yargs) => yargs
         .option('output', {
@@ -551,7 +558,6 @@ export const cli = ({ packageName = 'mint' }) => {
         .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', '[Coming soon] AI-powered documentation (run mint ai to vote)', () => undefined, comingSoon('ai', packageName))
-        .command('test', '[Coming soon] Test your documentation (run mint test to vote)', () => undefined, comingSoon('test', packageName))
         .command('mcp', '[Coming soon] MCP server for documentation (run mint mcp to vote)', () => undefined, comingSoon('mcp', packageName))
         // Print the help menu when the user enters an invalid command.
         .strictCommands()

package/bin/mintTest.js

@@ -0,0 +1,96 @@
+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 { DEFAULT_COMMAND_TIMEOUT_MS, DEFAULT_CONCURRENCY, clearRunSave, discoverCodeBlocks, loadRunSave, runCodeTests, } from '@mintlify/agent-harness';
+import path from 'node:path';
+import { CMD_EXEC_PATH, findDocsRoot, isAI, terminate } from './helpers.js';
+import { getAccessToken } from './keyring.js';
+import { fileInNavPaths, loadDocsNavScope } from './mintTestNav.js';
+import { countReport, formatDuration, runMintTestUi } from './mintTestUi.js';
+import { getCliStatus } from './status.js';
+export function mintTestHandler() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c, _d;
+        try {
+            const accessToken = yield getAccessToken().catch(() => null);
+            if (!accessToken) {
+                process.stderr.write('not logged in. Run `mint login` to authenticate.\n');
+                yield terminate(1);
+                return;
+            }
+            const cliStatus = yield getCliStatus(accessToken);
+            if ((cliStatus === null || cliStatus === void 0 ? void 0 : cliStatus.org.name.toLowerCase()) !== 'mintlify') {
+                process.stderr.write('mint test is not available for your organization.\n');
+                yield terminate(1);
+                return;
+            }
+            const targetPath = yield findDocsRoot(CMD_EXEC_PATH);
+            const interactive = process.stdin.isTTY === true &&
+                process.stdout.isTTY === true &&
+                !isAI() &&
+                !process.env.CI &&
+                process.env.CLI_TEST_MODE !== 'true';
+            const { docsRoot, pages: discoveredPages } = yield discoverCodeBlocks(targetPath);
+            const scope = yield loadDocsNavScope(docsRoot);
+            const pages = scope
+                ? discoveredPages.filter((page) => fileInNavPaths(page.file, scope.navPaths))
+                : discoveredPages;
+            const autoSelectedFiles = (scope ? pages.filter((page) => fileInNavPaths(page.file, scope.autoSelectedPaths)) : pages).map((page) => page.file);
+            const totalPages = scope ? scope.navPaths.size : pages.length;
+            const outputDirectory = path.join(docsRoot, 'tests', 'mint-test');
+            let save = yield loadRunSave(outputDirectory);
+            if (save) {
+                const known = new Set(pages.map((page) => page.file));
+                const selectedFiles = save.selectedFiles.filter((file) => known.has(file));
+                if (selectedFiles.length === 0) {
+                    yield clearRunSave(outputDirectory);
+                    save = null;
+                }
+                else {
+                    save = Object.assign(Object.assign({}, save), { selectedFiles });
+                }
+            }
+            if (interactive) {
+                const exitCode = yield runMintTestUi({
+                    targetPath,
+                    docsRoot,
+                    pages,
+                    autoSelectedFiles,
+                    totalPages,
+                    save,
+                });
+                yield terminate(exitCode);
+                return;
+            }
+            if (save)
+                process.stdout.write(`resuming run ${save.runId}\n`);
+            const report = yield runCodeTests({
+                path: targetPath,
+                agents: (_a = save === null || save === void 0 ? void 0 : save.agents) !== null && _a !== void 0 ? _a : ['claude'],
+                model: (_b = save === null || save === void 0 ? void 0 : save.model) !== null && _b !== void 0 ? _b : 'claude-opus-4-8',
+                selectedFiles: (_c = save === null || save === void 0 ? void 0 : save.selectedFiles) !== null && _c !== void 0 ? _c : autoSelectedFiles,
+                outputDirectory,
+                runId: (_d = save === null || save === void 0 ? void 0 : save.runId) !== null && _d !== void 0 ? _d : null,
+                concurrency: DEFAULT_CONCURRENCY,
+                commandTimeoutMs: DEFAULT_COMMAND_TIMEOUT_MS,
+                signal: new AbortController().signal,
+                onTaskUpdate: () => { },
+            });
+            const counts = countReport(report.tasks);
+            process.stdout.write(`mint test ${report.status}: ${counts.passed} passed, ${counts.failed} failed, ${counts.agentErrors} agent errors\n`);
+            process.stdout.write(`finished in ${formatDuration(report.durationMs)}\n`);
+            process.stdout.write(`report: ${report.reportPath}\n`);
+            yield terminate(report.status === 'passed' ? 0 : 1);
+        }
+        catch (error) {
+            process.stderr.write(`mint test failed: ${error instanceof Error ? error.message : 'unknown error'}\n`);
+            yield terminate(1);
+        }
+    });
+}

package/bin/mintTestNav.js

@@ -0,0 +1,35 @@
+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 { getAllPathsInDocsNav } from '@mintlify/common';
+import { getConfigObj } from '@mintlify/prebuild';
+export function loadDocsNavScope(docsRoot) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = (yield getConfigObj(docsRoot, 'docs').catch(() => null));
+        const navigation = config === null || config === void 0 ? void 0 : config.navigation;
+        if (!navigation)
+            return null;
+        const navPaths = new Set(getAllPathsInDocsNav(navigation));
+        if (navPaths.size === 0)
+            return null;
+        const firstLanguage = 'languages' in navigation ? navigation.languages[0] : null;
+        const autoSelectedPaths = firstLanguage ? new Set(getAllPathsInDocsNav(firstLanguage)) : navPaths;
+        return { navPaths, autoSelectedPaths };
+    });
+}
+export function navCandidatesForFile(file) {
+    const base = file.replace(/\.mdx?$/i, '');
+    const candidates = [base];
+    if (base.endsWith('/index'))
+        candidates.push(base.slice(0, -'/index'.length));
+    return candidates;
+}
+export function fileInNavPaths(file, paths) {
+    return navCandidatesForFile(file).some((candidate) => paths.has(candidate));
+}

package/bin/mintTestTree.js

@@ -0,0 +1,94 @@
+function buildTree(pages) {
+    var _a;
+    const root = { id: 'dir:', kind: 'directory', label: '.', blockCount: 0, children: [] };
+    const directories = new Map([['', root]]);
+    for (const page of pages) {
+        const parts = page.file.split('/');
+        let parent = root;
+        let directoryPath = '';
+        for (const part of parts.slice(0, -1)) {
+            directoryPath = directoryPath ? `${directoryPath}/${part}` : part;
+            let directory = directories.get(directoryPath);
+            if (!directory) {
+                directory = {
+                    id: `dir:${directoryPath}`,
+                    kind: 'directory',
+                    label: part,
+                    blockCount: 0,
+                    children: [],
+                };
+                directories.set(directoryPath, directory);
+                parent.children.push(directory);
+            }
+            parent = directory;
+        }
+        parent.children.push({
+            id: `file:${page.file}`,
+            kind: 'file',
+            label: (_a = parts[parts.length - 1]) !== null && _a !== void 0 ? _a : page.file,
+            file: page.file,
+            blockCount: page.blockCount,
+            children: [],
+        });
+    }
+    const sumBlocks = (node) => {
+        if (node.kind === 'file')
+            return node.blockCount;
+        node.blockCount = node.children.reduce((total, child) => total + sumBlocks(child), 0);
+        return node.blockCount;
+    };
+    sumBlocks(root);
+    const sortChildren = (node) => {
+        node.children.sort((left, right) => {
+            if (left.kind !== right.kind)
+                return left.kind === 'directory' ? -1 : 1;
+            return left.label.localeCompare(right.label);
+        });
+        for (const child of node.children)
+            sortChildren(child);
+    };
+    sortChildren(root);
+    return root;
+}
+function descendantFiles(node) {
+    if (node.kind === 'file')
+        return node.file ? [node.file] : [];
+    return node.children.flatMap(descendantFiles);
+}
+function selectionState(files, selectedFiles) {
+    if (files.length === 0)
+        return 'none';
+    const selectedCount = files.filter((file) => selectedFiles.has(file)).length;
+    if (selectedCount === 0)
+        return 'none';
+    return selectedCount === files.length ? 'all' : 'some';
+}
+export function visibleScopeRows(pages, expandedDirectories, selectedFiles) {
+    const root = buildTree(pages);
+    const rows = [];
+    const visit = (node, depth) => {
+        const files = descendantFiles(node);
+        const expanded = node.kind === 'directory' ? expandedDirectories.has(node.id) : undefined;
+        rows.push(Object.assign(Object.assign(Object.assign({ id: node.id, kind: node.kind, label: node.label, depth }, (node.file ? { file: node.file } : {})), { blockCount: node.blockCount, selectableFiles: files, selection: selectionState(files, selectedFiles) }), (expanded !== undefined ? { expanded } : {})));
+        if (node.kind === 'directory' && expanded) {
+            for (const child of node.children)
+                visit(child, depth + 1);
+        }
+    };
+    for (const child of root.children)
+        visit(child, 0);
+    return rows;
+}
+export function toggleScopeSelection(selectedFiles, row) {
+    const next = new Set(selectedFiles);
+    if (row.selectableFiles.length === 0)
+        return next;
+    const shouldSelect = row.selectableFiles.some((file) => !next.has(file));
+    for (const file of row.selectableFiles) {
+        if (shouldSelect)
+            next.add(file);
+        else
+            next.delete(file);
+    }
+    return next;
+}