@mintlify/cli 4.0.1108 → 4.0.1110

package/bin/cli.js

@@ -29,6 +29,7 @@ import { logout } from './logout.js';
 import { mdxLinter } from './mdxLinter.js';
 import { createTelemetryMiddleware } from './middlewares/telemetryMiddleware.js';
 import { checkOpenApiFile, getOpenApiFilenamesFromDocsConfig } from './openApiCheck.js';
+import { scoreHandler } from './score/index.js';
 import { status, getCliSubdomains } from './status.js';
 import { trackTelemetryPreferenceChange } from './telemetry/track.js';
 import { update } from './update.js';
@@ -411,6 +412,18 @@ export const cli = ({ packageName = 'mint' }) => {
         }
     }))
         .command('analytics', 'View analytics for your documentation', analyticsBuilder)
+        .command('score <url>', 'Run agent readiness checks on a docs site', (yargs) => yargs
+        .positional('url', {
+        type: 'string',
+        demandOption: true,
+        description: 'URL of the docs site to check',
+    })
+        .option('format', {
+        type: 'string',
+        choices: ['table', 'plain', 'json'],
+        description: 'Output format',
+    })
+        .example('mint score docs.example.com', 'Run agent readiness checks'), scoreHandler)
         // 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))

package/bin/score/client.js

@@ -0,0 +1,25 @@
+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 { authenticatedFetch } from '../authenticatedFetch.js';
+import { API_URL } from '../constants.js';
+export function getScore(url) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const endpoint = new URL(`${API_URL}/api/cli/score`);
+        endpoint.searchParams.set('url', url);
+        const res = yield authenticatedFetch(endpoint.toString(), {
+            headers: { Accept: 'application/json' },
+        });
+        if (!res.ok) {
+            const body = yield res.text().catch(() => '');
+            throw new Error(`API error (${res.status}): ${body || res.statusText}`);
+        }
+        return res.json();
+    });
+}

package/bin/score/index.js

@@ -0,0 +1,98 @@
+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 { addLog, ErrorLog, SpinnerLog, removeLastLog } from '@mintlify/previewing';
+import chalk from 'chalk';
+import { Text } from 'ink';
+import { terminate } from '../helpers.js';
+import { getScore } from './client.js';
+function resolveFormat(argv) {
+    if (argv.format === 'table' || argv.format === 'plain' || argv.format === 'json')
+        return argv.format;
+    return 'table';
+}
+function statusIcon(pass) {
+    return pass ? chalk.green('✓') : chalk.red('✗');
+}
+function formatCheckName(name) {
+    return name
+        .replace(/([A-Z])/g, ' $1')
+        .replace(/^./, (c) => c.toUpperCase())
+        .trim();
+}
+function renderChecks(checks, indent = 0) {
+    const lines = [];
+    const pad = '  '.repeat(indent + 1);
+    for (const check of checks) {
+        lines.push(`${pad}${statusIcon(check.pass)}  ${formatCheckName(check.name)}`);
+        if (check.children && check.children.length > 0) {
+            lines.push(...renderChecks(check.children, indent + 1));
+        }
+    }
+    return lines;
+}
+function renderPlain(checks, prefix = '') {
+    const lines = [];
+    for (const check of checks) {
+        lines.push(`${prefix}${check.pass ? 'PASS' : 'FAIL'}\t${check.name}`);
+        if (check.children && check.children.length > 0) {
+            lines.push(...renderPlain(check.children, prefix + '  '));
+        }
+    }
+    return lines;
+}
+function output(format, text) {
+    if (format === 'table') {
+        addLog(_jsx(Text, { children: text }));
+    }
+    else {
+        process.stdout.write(text + '\n');
+    }
+}
+export const scoreHandler = (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    const format = resolveFormat(argv);
+    try {
+        if (format === 'table')
+            addLog(_jsx(SpinnerLog, { message: "Running agent readiness checks..." }));
+        const data = yield getScore(argv.url);
+        if (format === 'table')
+            removeLastLog();
+        if (format === 'json') {
+            output(format, JSON.stringify(data, null, 2));
+            yield terminate(0);
+            return;
+        }
+        if (format === 'plain') {
+            const lines = [`SCORE\t${data.overallScore}`, ...renderPlain(data.checks)];
+            output(format, lines.join('\n'));
+            yield terminate(0);
+            return;
+        }
+        const scoreColor = data.overallScore >= 70 ? 'green' : data.overallScore >= 40 ? 'yellow' : 'red';
+        const lines = [];
+        lines.push(chalk.bold(`\nAgent Readiness Score — ${data.url}\n`));
+        lines.push(`  Score: ${chalk[scoreColor].bold(`${data.overallScore}%`)}\n`);
+        lines.push(chalk.bold('  Checks'));
+        lines.push(...renderChecks(data.checks));
+        output(format, lines.join('\n'));
+        yield terminate(0);
+    }
+    catch (err) {
+        const message = err instanceof Error ? err.message : 'unknown error';
+        if (format === 'table') {
+            removeLastLog();
+            addLog(_jsx(ErrorLog, { message: message }));
+        }
+        else {
+            process.stderr.write(`Error: ${message}\n`);
+        }
+        yield terminate(1);
+    }
+});

package/bin/score/types.js

@@ -0,0 +1 @@
+export {};