@mintlify/cli 4.0.1089 → 4.0.1091

package/bin/cli.js

@@ -17,6 +17,7 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { accessibilityCheck } from './accessibilityCheck.js';
 import { analyticsBuilder } from './analytics/index.js';
+import { comingSoon } from './comingSoon.js';
 import { setTelemetryEnabled } from './config.js';
 import { getConfigValue, setConfigValue, clearConfigValue } from './config.js';
 import { API_URL } from './constants.js';
@@ -53,7 +54,7 @@ export const cli = ({ packageName = 'mint' }) => {
         .middleware(checkNodeVersion)
         .middleware(suppressConsoleWarnings)
         .middleware(telemetryMiddleware)
-        .command('dev', 'initialize a local preview environment', (yargs) => yargs
+        .command('dev', 'Initialize a local preview environment', (yargs) => yargs
         .option('open', {
         type: 'boolean',
         default: true,
@@ -113,7 +114,7 @@ export const cli = ({ packageName = 'mint' }) => {
             yield terminate(1);
         }
     }))
-        .command('validate', 'validate the documentation build (strict mode, exits on warnings or errors)', (yargs) => yargs
+        .command('validate', 'Validate the documentation build (strict mode, exits on warnings or errors)', (yargs) => yargs
         .option('local-schema', {
         type: 'boolean',
         default: false,
@@ -153,7 +154,7 @@ export const cli = ({ packageName = 'mint' }) => {
         yield validateBuild(Object.assign(Object.assign({}, argv), { packageName,
             cliVersion }));
     }))
-        .command('export', 'export a static site for air-gapped deployment', (yargs) => yargs
+        .command('export', 'Export a static site for air-gapped deployment', (yargs) => yargs
         .option('output', {
         type: 'string',
         default: 'export.zip',
@@ -195,7 +196,7 @@ export const cli = ({ packageName = 'mint' }) => {
         const valid = yield checkOpenApiFile(filename, localSchema);
         yield terminate(valid ? 0 : 1);
     }))
-        .command('broken-links', 'check for broken links', (yargs) => yargs
+        .command('broken-links', 'Check for broken links', (yargs) => yargs
         .option('check-anchors', {
         type: 'boolean',
         default: false,
@@ -267,16 +268,16 @@ export const cli = ({ packageName = 'mint' }) => {
         yield status();
         yield terminate(0);
     }))
-        .command('logout', 'logout of your mintlify account', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        .command('logout', 'Logout of your Mintlify account', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
         yield logout();
         yield terminate(0);
     }))
-        .command('login', 'authenticate your account to mintlify', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        .command('login', 'Authenticate your account to Mintlify', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
         yield login();
         yield terminate(0);
     }))
-        .command('config', 'manage CLI configuration', (yargs) => yargs
-        .command('set <key> <value>', 'set a configuration value', (yargs) => yargs
+        .command('config', 'Manage CLI configuration', (yargs) => yargs
+        .command('set <key> <value>', 'Set a configuration value', (yargs) => yargs
         .positional('key', {
         type: 'string',
         demandOption: true,
@@ -297,7 +298,7 @@ export const cli = ({ packageName = 'mint' }) => {
         addLog(_jsx(SuccessLog, { message: `${argv.key} = "${argv.value}"` }));
         yield terminate(0);
     }))
-        .command('get <key>', 'get a configuration value', (yargs) => yargs.positional('key', {
+        .command('get <key>', 'Get a configuration value', (yargs) => yargs.positional('key', {
         type: 'string',
         demandOption: true,
         description: 'Config key (e.g. subdomain, dateFrom, dateTo)',
@@ -312,7 +313,7 @@ export const cli = ({ packageName = 'mint' }) => {
         addLog(_jsx(Text, { children: val !== null && val !== void 0 ? val : 'not set' }));
         yield terminate(0);
     }))
-        .command('clear <key>', 'remove a configuration value', (yargs) => yargs.positional('key', {
+        .command('clear <key>', 'Remove a configuration value', (yargs) => yargs.positional('key', {
         type: 'string',
         demandOption: true,
         description: 'Config key (e.g. subdomain, dateFrom, dateTo)',
@@ -328,11 +329,11 @@ export const cli = ({ packageName = 'mint' }) => {
         yield terminate(0);
     }))
         .demandCommand(1, 'specify a subcommand: set, get, or clear'))
-        .command('update', 'update the CLI to the latest version', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        .command('update', 'Update the CLI to the latest version', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
         yield update({ packageName });
         yield terminate(0);
     }))
-        .command(['a11y', 'accessibility-check', 'a11y-check', 'accessibility'], 'check for accessibility issues in documentation', (yargs) => yargs
+        .command(['a11y', 'accessibility-check', 'a11y-check', 'accessibility'], 'Check for accessibility issues in documentation', (yargs) => yargs
         .option('skip-contrast', {
         type: 'boolean',
         default: false,
@@ -362,12 +363,12 @@ export const cli = ({ packageName = 'mint' }) => {
         }
         yield terminate(accessibilityCheckTerminateCode || mdxLinterTerminateCode);
     }))
-        .command(['version', 'v'], 'display the current version of the cli and client', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        .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] }));
     }))
-        .command('new [directory]', 'create a new mintlify documentation site', (yargs) => yargs
+        .command('new [directory]', 'Create a new Mintlify documentation site', (yargs) => yargs
         .positional('directory', {
         describe: 'The directory to initialize your documentation',
         type: 'string',
@@ -395,7 +396,7 @@ export const cli = ({ packageName = 'mint' }) => {
             yield terminate(1);
         }
     }))
-        .command('workflow', 'add a workflow to your documentation repository', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
+        .command('workflow', 'Add a workflow to your documentation repository', () => undefined, () => __awaiter(void 0, void 0, void 0, function* () {
         try {
             yield addWorkflow();
             yield terminate(0);
@@ -405,7 +406,12 @@ export const cli = ({ packageName = 'mint' }) => {
             yield terminate(1);
         }
     }))
-        .command('analytics', 'view analytics for your documentation', analyticsBuilder)
+        .command('analytics', 'View analytics for your documentation', analyticsBuilder)
+        // 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('signup', '[Coming soon] Sign up for a Mintlify account (run mint signup to vote)', () => undefined, comingSoon('signup', 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()
         .demandCommand(1, 'unknown command. see above for the list of supported commands.')

package/bin/comingSoon.js

@@ -0,0 +1,26 @@
+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, SuccessLog, WarningLog } from '@mintlify/previewing';
+import { Text } from 'ink';
+import { isTelemetryEnabled } from './config.js';
+import { terminate } from './helpers.js';
+export function comingSoon(command, packageName) {
+    return () => __awaiter(this, void 0, void 0, function* () {
+        if (!isTelemetryEnabled()) {
+            addLog(_jsx(WarningLog, { message: `Telemetry is disabled, so your vote won't be counted. Enable it with: ${packageName} --telemetry=true` }));
+        }
+        else {
+            addLog(_jsx(SuccessLog, { message: `Thanks for your interest in "${packageName} ${command}"! Your vote has been counted.` }));
+        }
+        addLog(_jsx(Text, { dimColor: true, children: "This feature is currently in development. Learn more at https://mintlify.com/docs" }));
+        yield terminate(0);
+    });
+}