@mintlify/cli 4.0.603 → 4.0.605

package/bin/cli.js

@@ -7,164 +7,170 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { validate, getOpenApiDocumentFromUrl, isAllowedLocalSchemaUrl } from '@mintlify/common';
 import { getBrokenInternalLinks, renameFilesAndUpdateLinksInContent } from '@mintlify/link-rot';
-import { dev } from '@mintlify/previewing';
-import Chalk from 'chalk';
-import fs from 'fs/promises';
-import yaml from 'js-yaml';
+import { addLog, dev, ErrorLog, SpinnerLog, SuccessLog, Logs, clearLogs, BrokenLinksLog, } from '@mintlify/previewing';
+import { render, Text } from 'ink';
 import path from 'path';
 import semver from 'semver';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { LOCAL_LINKED_VERSION, MINIMUM_CLI_VERSION } from './constants.js';
-import { checkPort, checkForMintJson, checkNodeVersion, upgradeConfig, checkForDocsJson, getCliVersion, getVersions, suppressConsoleWarnings, } from './helpers.js';
+import { checkPort, checkForMintJson, checkNodeVersion, upgradeConfig, checkForDocsJson, getCliVersion, getVersions, suppressConsoleWarnings, terminate, readLocalOpenApiFile, } from './helpers.js';
 import { update } from './update.js';
-export const cli = () => yargs(hideBin(process.argv))
-    .middleware(checkNodeVersion)
-    .middleware(suppressConsoleWarnings)
-    .command('dev', 'Runs Mintlify project locally.', (yargs) => yargs
-    .option('open', {
-    type: 'boolean',
-    default: true,
-    description: 'Open Mintlify in the browser',
-})
-    .option('local-schema', {
-    type: 'boolean',
-    default: false,
-    hidden: true,
-    description: 'Use a locally hosted schema file (note: only https protocol is supported in production)',
-})
-    .option('client-version', {
-    type: 'string',
-    hidden: true,
-    description: 'The version of the client to use for cli testing',
-})
-    .usage('Usage: mintlify dev [options]')
-    .example('mintlify dev', 'Run with default settings (opens in browser)')
-    .example('mintlify dev --no-open', 'Run without opening in browser'), (argv) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
-    const port = yield checkPort(argv);
-    const packageName = (_b = (_a = process.argv[1]) === null || _a === void 0 ? void 0 : _a.split('/').pop()) !== null && _b !== void 0 ? _b : 'mintlify';
-    const cliVersion = getCliVersion();
-    if (cliVersion &&
-        cliVersion !== LOCAL_LINKED_VERSION &&
-        semver.lt(cliVersion, MINIMUM_CLI_VERSION)) {
-        yield update({ packageName, silent: true });
-    }
-    if (port != undefined) {
-        yield dev(Object.assign(Object.assign({}, argv), { port,
-            packageName, cliVersion: cli }));
-    }
-    else {
-        console.error(`No available port found.`);
-    }
-}))
-    .command('openapi-check <openapiFilenameOrUrl>', 'Validate an OpenAPI spec', (yargs) => yargs
-    .positional('openapiFilenameOrUrl', {
-    describe: 'The filename of the OpenAPI spec (e.g. ./openapi.yaml) or the URL to the OpenAPI spec (e.g. https://petstore3.swagger.io/api/v3/openapi.json)',
-    type: 'string',
-    demandOption: true,
-})
-    .option('local-schema', {
-    type: 'boolean',
-    default: false,
-    description: 'Use a locally hosted schema file (note: only https protocol is supported in production)',
-}), (_a) => __awaiter(void 0, [_a], void 0, function* ({ openapiFilenameOrUrl, 'local-schema': localSchema }) {
-    try {
-        if (isAllowedLocalSchemaUrl(openapiFilenameOrUrl, localSchema)) {
-            yield getOpenApiDocumentFromUrl(openapiFilenameOrUrl);
-            console.log('✅ Your OpenAPI definition is valid.');
-            process.exit(0);
+export const cli = () => {
+    render(_jsx(Logs, {}));
+    return (yargs(hideBin(process.argv))
+        .middleware(checkNodeVersion)
+        .middleware(suppressConsoleWarnings)
+        .command('dev', 'initialize a local preview environment', (yargs) => yargs
+        .option('open', {
+        type: 'boolean',
+        default: true,
+        description: 'open a local preview in the browser',
+    })
+        .option('local-schema', {
+        type: 'boolean',
+        default: false,
+        hidden: true,
+        description: 'use a locally hosted schema file (note: only https protocol is supported in production)',
+    })
+        .option('client-version', {
+        type: 'string',
+        hidden: true,
+        description: 'the version of the client to use for cli testing',
+    })
+        .usage('usage: mintlify dev [options]')
+        .example('mintlify dev', 'run with default settings (opens in browser)')
+        .example('mintlify dev --no-open', 'run without opening in browser'), (argv) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b;
+        const port = yield checkPort(argv);
+        const packageName = (_b = (_a = process.argv[1]) === null || _a === void 0 ? void 0 : _a.split('/').pop()) !== null && _b !== void 0 ? _b : 'mintlify';
+        const cliVersion = getCliVersion();
+        if (cliVersion &&
+            cliVersion !== LOCAL_LINKED_VERSION &&
+            semver.lt(cliVersion, MINIMUM_CLI_VERSION)) {
+            yield update({ packageName, silent: true });
         }
-        const pathname = path.resolve(process.cwd(), openapiFilenameOrUrl);
-        const file = yield fs.readFile(pathname, 'utf-8');
-        const document = yaml.load(file);
-        if (!document) {
-            throw new Error('Failed to parse OpenAPI spec: could not parse file correctly, please check for any syntax errors.');
+        if (port != undefined) {
+            yield dev(Object.assign(Object.assign({}, argv), { port,
+                packageName, cliVersion: cli }));
         }
-        yield validate(document);
-        console.log('✅ Your OpenAPI definition is valid.');
-    }
-    catch (err) {
-        console.error(Chalk.red(err));
-        process.exit(1);
-    }
-}))
-    .command('broken-links', 'Check for broken links in your Mintlify project.', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
-    const hasMintJson = yield checkForMintJson();
-    if (!hasMintJson) {
-        yield checkForDocsJson();
-    }
-    console.log(Chalk.bold('Checking for broken links...\n'));
-    try {
-        const brokenLinks = yield getBrokenInternalLinks();
-        if (brokenLinks.length === 0) {
-            console.log(Chalk.green('No broken links found.'));
-            return;
+        else {
+            addLog(_jsx(ErrorLog, { message: "no available port found" }));
+            yield terminate(1);
         }
-        const brokenLinksByFile = {};
-        brokenLinks.forEach((mdxPath) => {
-            const filename = path.join(mdxPath.relativeDir, mdxPath.filename);
-            const brokenLinksForFile = brokenLinksByFile[filename];
-            if (brokenLinksForFile) {
-                brokenLinksForFile.push(mdxPath.originalPath);
+    }))
+        .command('openapi-check <filename>', 'check if an OpenAPI spec is valid', (yargs) => yargs
+        .positional('filename', {
+        describe: 'the filename of the OpenAPI spec (e.g. ./openapi.yaml) or the URL to the OpenAPI spec (e.g. https://petstore3.swagger.io/api/v3/openapi.json)',
+        type: 'string',
+        demandOption: true,
+    })
+        .option('local-schema', {
+        type: 'boolean',
+        default: false,
+        description: 'use a locally hosted schema file (note: only https protocol is supported in production)',
+    }), (_a) => __awaiter(void 0, [_a], void 0, function* ({ filename, 'local-schema': localSchema }) {
+        try {
+            if (isAllowedLocalSchemaUrl(filename, localSchema)) {
+                yield getOpenApiDocumentFromUrl(filename);
+                addLog(_jsx(SuccessLog, { message: "OpenAPI definition is valid." }));
+                yield terminate(0);
             }
-            else {
-                brokenLinksByFile[filename] = [mdxPath.originalPath];
+            const document = yield readLocalOpenApiFile(filename);
+            if (!document) {
+                throw new Error('failed to parse OpenAPI spec: could not parse file correctly, please check for any syntax errors.');
             }
-        });
-        Object.entries(brokenLinksByFile).forEach(([fileName, brokenLinks]) => {
-            console.group(`${Chalk.underline(fileName)}`);
-            console.log(brokenLinks.join('\n'), '\n');
-            console.groupEnd();
-        });
-        console.error(Chalk.yellow(`${brokenLinks.length} broken links found.`));
-        process.exit(1);
-    }
-    catch (err) {
-        console.error(Chalk.red(err));
-        process.exit(1);
-    }
-}))
-    .command('rename <from> <to>', 'Rename file in a Mintlify project and update the internal link references.', (yargs) => yargs
-    .positional('from', {
-    describe: 'The file to rename',
-    type: 'string',
-})
-    .positional('to', {
-    describe: 'The new name for the file',
-    type: 'string',
-})
-    .demandOption(['from', 'to'])
-    .epilog('Example: `mintlify rename introduction.mdx overview.mdx`'), (_a) => __awaiter(void 0, [_a], void 0, function* ({ from, to }) {
-    const hasMintJson = yield checkForMintJson();
-    if (!hasMintJson) {
-        yield checkForDocsJson();
-    }
-    yield renameFilesAndUpdateLinksInContent(from, to);
-}))
-    .command('update', 'Update the Mintlify client and cli to the latest version', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
-    const packageName = (_b = (_a = process.argv[1]) === null || _a === void 0 ? void 0 : _a.split('/').pop()) !== null && _b !== void 0 ? _b : 'mintlify';
-    yield update({ packageName });
-}))
-    .command('upgrade', 'Upgrade the mint.json file to v2 (docs.json)', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
-    const hasMintJson = yield checkForMintJson();
-    if (!hasMintJson) {
-        yield checkForDocsJson();
-    }
-    yield upgradeConfig();
-}))
-    .command(['version', 'v'], 'Print the current version of the Mintlify CLI and client', () => undefined, () => {
-    const { cli, client } = getVersions();
-    console.log(`Mintlify CLI version: ${cli}`);
-    console.log(`Mintlify Client version: ${client}`);
-})
-    // Print the help menu when the user enters an invalid command.
-    .strictCommands()
-    .demandCommand(1, 'Unknown command. See above for the list of supported commands.')
-    // Alias option flags --help = -h, default --version = -v
-    .alias('h', 'help')
-    .alias('v', 'version')
-    .parse();
+            yield validate(document);
+            addLog(_jsx(SuccessLog, { message: "OpenAPI definition is valid." }));
+        }
+        catch (err) {
+            addLog(_jsx(ErrorLog, { message: err instanceof Error ? err.message : 'unknown error' }));
+            yield terminate(1);
+        }
+        yield terminate(0);
+    }))
+        .command('broken-links', 'check for invalid internal links', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        const hasMintJson = yield checkForMintJson();
+        if (!hasMintJson) {
+            yield checkForDocsJson();
+        }
+        addLog(_jsx(SpinnerLog, { message: "checking for broken links..." }));
+        try {
+            const brokenLinks = yield getBrokenInternalLinks();
+            if (brokenLinks.length === 0) {
+                clearLogs();
+                addLog(_jsx(SuccessLog, { message: "no broken links found" }));
+                yield terminate(0);
+            }
+            const brokenLinksByFile = {};
+            brokenLinks.forEach((mdxPath) => {
+                const filename = path.join(mdxPath.relativeDir, mdxPath.filename);
+                const brokenLinksForFile = brokenLinksByFile[filename];
+                if (brokenLinksForFile) {
+                    brokenLinksForFile.push(mdxPath.originalPath);
+                }
+                else {
+                    brokenLinksByFile[filename] = [mdxPath.originalPath];
+                }
+            });
+            clearLogs();
+            addLog(_jsx(BrokenLinksLog, { brokenLinksByFile: brokenLinksByFile }));
+        }
+        catch (err) {
+            addLog(_jsx(ErrorLog, { message: err instanceof Error ? err.message : 'unknown error' }));
+            yield terminate(1);
+        }
+        yield terminate(0);
+    }))
+        .command('rename <from> <to>', 'rename a file and update all internal link references', (yargs) => yargs
+        .positional('from', {
+        describe: 'the file to rename',
+        type: 'string',
+    })
+        .positional('to', {
+        describe: 'the new name for the file',
+        type: 'string',
+    })
+        .demandOption(['from', 'to'])
+        .option('force', {
+        type: 'boolean',
+        default: false,
+        description: 'rename files and skip errors',
+    })
+        .epilog('example: `mintlify rename introduction.mdx overview.mdx`'), (_a) => __awaiter(void 0, [_a], void 0, function* ({ from, to, force }) {
+        const hasMintJson = yield checkForMintJson();
+        if (!hasMintJson) {
+            yield checkForDocsJson();
+        }
+        yield renameFilesAndUpdateLinksInContent(from, to, force);
+        yield terminate(0);
+    }))
+        .command('update', 'update the CLI to the latest version', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b;
+        const packageName = (_b = (_a = process.argv[1]) === null || _a === void 0 ? void 0 : _a.split('/').pop()) !== null && _b !== void 0 ? _b : 'mintlify';
+        yield update({ packageName });
+        yield terminate(0);
+    }))
+        .command('upgrade', 'upgrade mint.json file to docs.json (current format)', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        const hasMintJson = yield checkForMintJson();
+        if (!hasMintJson) {
+            yield checkForDocsJson();
+        }
+        yield upgradeConfig();
+    }))
+        .command(['version', 'v'], 'display the current version of the CLI and client', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        const { cli, client } = getVersions();
+        addLog(_jsxs(Text, { children: [_jsx(Text, { bold: true, color: "green", children: "cli version" }), ' ', cli] }));
+        addLog(_jsxs(Text, { children: [_jsx(Text, { bold: true, color: "green", children: "client version" }), ' ', client] }));
+    }))
+        // Print the help menu when the user enters an invalid command.
+        .strictCommands()
+        .demandCommand(1, 'unknown command. see above for the list of supported commands.')
+        // Alias option flags --help = -h, default --version = -v
+        .alias('h', 'help')
+        .alias('v', 'version')
+        .parse());
+};

package/bin/helpers.js

@@ -7,17 +7,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { jsx as _jsx } from "react/jsx-runtime";
 import { getConfigPath } from '@mintlify/prebuild';
 import { MintConfigUpdater } from '@mintlify/prebuild';
-import { getClientVersion } from '@mintlify/previewing';
+import { addLog, ErrorLog, getClientVersion, SuccessLog, InfoLog, SpinnerLog, removeLastLog, } from '@mintlify/previewing';
 import { upgradeToDocsConfig } from '@mintlify/validation';
-import Chalk from 'chalk';
 import detect from 'detect-port';
 import fse from 'fs-extra';
 import fs from 'fs/promises';
 import inquirer from 'inquirer';
-import { execSync } from 'node:child_process';
-import Ora from 'ora';
+import yaml from 'js-yaml';
+import { exec, execSync } from 'node:child_process';
+import { promisify } from 'node:util';
 import path from 'path';
 import yargs from 'yargs';
 import { CMD_EXEC_PATH, LOCAL_LINKED_VERSION } from './constants.js';
@@ -26,7 +27,7 @@ export const checkPort = (argv) => __awaiter(void 0, void 0, void 0, function* (
     if (initialPort === (yield detect(initialPort)))
         return initialPort;
     for (let port = initialPort + 1; port < initialPort + 10; port++) {
-        console.log(`Port ${port - 1} is already in use. Trying ${port} instead.`);
+        addLog(_jsx(InfoLog, { message: `port ${port - 1} is already in use. trying ${port} instead` }));
         if (port === (yield detect(port)))
             return port;
     }
@@ -39,39 +40,33 @@ export const checkNodeVersion = () => __awaiter(void 0, void 0, void 0, function
     const versionArr = nodeVersionString.split('.');
     const majorVersion = parseInt(versionArr[0], 10);
     if (majorVersion < 18) {
-        const logger = buildLogger();
-        logger.fail(`Mintlify requires a node version >= 18.0.0 (current version ${nodeVersionString}). Try removing the mintlify package, upgrading node, reinstalling mintlify, and running again.`);
-        process.exit(1);
+        addLog(_jsx(ErrorLog, { message: `mintlify requires a node version >= 18.0.0 (current version ${nodeVersionString}). try removing the mintlify package, upgrading node, reinstalling mintlify, and running again.` }));
     }
 });
-export const buildLogger = (startText = '') => {
-    const logger = Ora().start(startText);
-    return logger;
-};
 export const checkForMintJson = () => __awaiter(void 0, void 0, void 0, function* () {
     return !!(yield getConfigPath(CMD_EXEC_PATH, 'mint'));
 });
 export const checkForDocsJson = () => __awaiter(void 0, void 0, void 0, function* () {
     const docsJsonPath = path.join(CMD_EXEC_PATH, 'docs.json');
     if (!(yield fse.pathExists(docsJsonPath))) {
-        console.log('New docs.json file is available.');
+        addLog(_jsx(InfoLog, { message: "new docs.json file is available" }));
         const promptResult = yield inquirer.prompt([
             {
                 type: 'list',
                 name: 'action',
-                message: 'Would you like to upgrade your mint.json to docs.json?',
+                message: 'would you like to upgrade your mint.json to docs.json?',
                 choices: [
-                    { name: 'Continue (use existing mint.json)', value: 'continue' },
-                    { name: 'Upgrade (migrate from mint.json -> docs.json)', value: 'upgrade' },
+                    { name: 'upgrade (migrate from mint.json to docs.json)', value: 'upgrade' },
+                    { name: 'continue (use existing mint.json)', value: 'continue' },
                 ],
             },
         ]);
         const { action } = promptResult;
         if (action === 'continue') {
-            console.log('Proceeding with the existing mint.json...');
+            addLog(_jsx(InfoLog, { message: "proceeding with the existing mint.json..." }));
         }
         if (action === 'upgrade') {
-            console.log('Upgrading docs.json...');
+            addLog(_jsx(SpinnerLog, { message: "upgrading docs.json..." }));
             yield upgradeConfig();
         }
     }
@@ -87,11 +82,12 @@ export const upgradeConfig = () => __awaiter(void 0, void 0, void 0, function* (
             shouldUpgradeTheme: true,
         });
         yield fs.writeFile(docsJsonPath, JSON.stringify(upgradedDocsConfig, null, 2));
-        console.log(Chalk.green('✅ Your mint.json file has been upgraded to v2 (docs.json).'));
+        removeLastLog();
+        addLog(_jsx(SuccessLog, { message: "mint.json file has been upgraded to docs.json." }));
     }
     catch (err) {
-        console.error(Chalk.red(err));
-        process.exit(1);
+        removeLastLog();
+        addLog(_jsx(ErrorLog, { message: err instanceof Error ? err.message : 'an unknown error occurred' }));
     }
 });
 export const getCliVersion = () => {
@@ -143,3 +139,15 @@ export const suppressConsoleWarnings = () => {
         originalConsoleWarn.apply(console, args);
     };
 };
+export const readLocalOpenApiFile = (filename) => __awaiter(void 0, void 0, void 0, function* () {
+    const pathname = path.resolve(process.cwd(), filename);
+    const file = yield fs.readFile(pathname, 'utf-8');
+    const document = yaml.load(file);
+    return document;
+});
+export const terminate = (code) => __awaiter(void 0, void 0, void 0, function* () {
+    // Wait for the logs to be fully rendered before exiting
+    yield new Promise((resolve) => setTimeout(resolve, 50));
+    process.exit(code);
+});
+export const execAsync = promisify(exec);