@mintlify/cli 4.0.590 → 4.0.591

package/bin/update.js

@@ -10,8 +10,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { getTargetMintVersion, downloadTargetMint } from '@mintlify/previewing';
 import { execSync } from 'node:child_process';
 import { buildLogger, getLatestCliVersion, getVersions } from './helpers.js';
-export const update = (_a) => __awaiter(void 0, [_a], void 0, function* ({ packageName }) {
-    const logger = buildLogger(`Updating ${packageName} to the latest version...`);
+export const update = (_a) => __awaiter(void 0, [_a], void 0, function* ({ packageName, silent, }) {
+    let logger = undefined;
+    if (!silent) {
+        logger = buildLogger(`Updating ${packageName} to the latest version...`);
+    }
     const { cli: existingCliVersion, client: existingClientVersion } = getVersions();
     const latestCliVersion = getLatestCliVersion(packageName);
     const latestClientVersion = yield getTargetMintVersion(logger);
@@ -22,22 +25,30 @@ export const update = (_a) => __awaiter(void 0, [_a], void 0, function* ({ packa
         latestCliVersion.trim() === existingCliVersion.trim() &&
         latestClientVersion.trim() === existingClientVersion.trim();
     if (isUpToDate) {
-        logger.succeed('Already up to date.');
+        if (!silent && logger) {
+            logger.succeed('Already up to date.');
+        }
         return;
     }
     if (existingCliVersion && latestCliVersion.trim() !== existingCliVersion.trim()) {
         try {
-            logger.text = `Updating ${packageName} package...`;
+            if (logger) {
+                logger.text = `Updating ${packageName} package...`;
+            }
             execSync(`npm install -g ${packageName}@latest --silent`);
         }
         catch (err) {
-            logger.fail(`Failed to update ${packageName}@latest`);
+            if (logger) {
+                logger.fail(`Failed to update ${packageName}@latest`);
+            }
             process.exit(1);
         }
     }
     if (latestClientVersion && latestClientVersion !== existingClientVersion) {
         try {
-            logger.text = `Updating Mintlify client to ${latestClientVersion}...`;
+            if (logger) {
+                logger.text = `Updating Mintlify client to ${latestClientVersion}...`;
+            }
             yield downloadTargetMint({
                 logger,
                 targetVersion: latestClientVersion,
@@ -45,9 +56,13 @@ export const update = (_a) => __awaiter(void 0, [_a], void 0, function* ({ packa
             });
         }
         catch (err) {
-            logger.fail(`Failed to update Mintlify client to ${latestClientVersion}`);
+            if (logger) {
+                logger.fail(`Failed to update Mintlify client to ${latestClientVersion}`);
+            }
             process.exit(1);
         }
     }
-    logger.succeed(`Updated ${packageName} to the latest version: ${latestCliVersion}`);
+    if (logger) {
+        logger.succeed(`Updated ${packageName} to the latest version: ${latestCliVersion}`);
+    }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.590",
+  "version": "4.0.591",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -43,7 +43,7 @@
     "@mintlify/link-rot": "3.0.543",
     "@mintlify/models": "0.0.197",
     "@mintlify/prebuild": "1.0.539",
-    "@mintlify/previewing": "4.0.580",
+    "@mintlify/previewing": "4.0.581",
     "@mintlify/validation": "0.1.396",
     "chalk": "^5.2.0",
     "detect-port": "^1.5.1",
@@ -51,6 +51,7 @@
     "inquirer": "^12.3.0",
     "js-yaml": "^4.1.0",
     "ora": "^6.1.2",
+    "semver": "^7.7.2",
     "yargs": "^17.6.0"
   },
   "devDependencies": {
@@ -71,5 +72,5 @@
     "vitest": "^2.0.4",
     "vitest-mock-process": "^1.0.4"
   },
-  "gitHead": "a2587be0d2751d1429685cebc59cf1385699942d"
+  "gitHead": "f940794a73b51d9c1794e2cebad1ad3fa2cd94a5"
 }

package/src/cli.ts

@@ -5,15 +5,18 @@ import Chalk from 'chalk';
 import fs from 'fs/promises';
 import yaml from 'js-yaml';
 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,
 } from './helpers.js';
 import { update } from './update.js';
@@ -47,13 +50,31 @@ export const cli = () =>
           .example('mintlify dev', 'Run with default settings (opens in browser)')
           .example('mintlify dev --no-open', 'Run without opening in browser'),
       async (argv) => {
+        // Suppress deprecation warning for punycode
+        const originalConsoleError = console.error;
+        console.error = (...args) => {
+          const message = args.join(' ');
+          if (message.includes('DeprecationWarning')) {
+            return;
+          }
+          originalConsoleError.apply(console, args);
+        };
         const port = await checkPort(argv);
         const packageName = process.argv[1]?.split('/').pop() ?? 'mintlify';
+        const cliVersion = getCliVersion();
+        if (
+          cliVersion &&
+          cliVersion !== LOCAL_LINKED_VERSION &&
+          semver.lt(cliVersion, MINIMUM_CLI_VERSION)
+        ) {
+          await update({ packageName, silent: true });
+        }
         if (port != undefined) {
           await dev({
             ...argv,
             port,
             packageName,
+            cliVersion: cli,
           });
         } else {
           console.error(`No available port found.`);

package/src/constants.ts

@@ -2,3 +2,5 @@ import os from 'os';
 
 export const HOME_DIR = os.homedir();
 export const CMD_EXEC_PATH = process.cwd();
+export const LOCAL_LINKED_VERSION = 'linked to local package';
+export const MINIMUM_CLI_VERSION = '4.1.8';

package/src/helpers.ts

@@ -13,7 +13,7 @@ import path from 'path';
 import type { ArgumentsCamelCase } from 'yargs';
 import yargs from 'yargs';
 
-import { CMD_EXEC_PATH } from './constants.js';
+import { CMD_EXEC_PATH, LOCAL_LINKED_VERSION } from './constants.js';
 
 export const checkPort = async (argv: ArgumentsCamelCase): Promise<number | undefined> => {
   const initialPort = typeof argv.port === 'number' ? argv.port : 3000;
@@ -98,13 +98,18 @@ export const upgradeConfig = async () => {
   }
 };
 
-const getCliVersion = (): string | undefined => {
+export const getCliVersion = (): string | undefined => {
   const y = yargs();
   let version = undefined;
   y.showVersion((s) => {
     version = s;
     return false;
   });
+  // when running `npm link` the version is 'unknown'
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  if (version === 'unknown') {
+    version = LOCAL_LINKED_VERSION;
+  }
   return version;
 };
 
@@ -112,10 +117,7 @@ export const getVersions = (): {
   cli: string | undefined;
   client: string | undefined;
 } => {
-  let cli = getCliVersion();
-  if (cli === 'unknown') {
-    cli = 'linked to local package';
-  }
+  const cli = getCliVersion();
   const client = getClientVersion().trim();
   return { cli, client };
 };

package/src/update.ts

@@ -1,10 +1,20 @@
 import { getTargetMintVersion, downloadTargetMint } from '@mintlify/previewing';
 import { execSync } from 'node:child_process';
+import { Ora as OraType } from 'ora';
 
 import { buildLogger, getLatestCliVersion, getVersions } from './helpers.js';
 
-export const update = async ({ packageName }: { packageName: string }) => {
-  const logger = buildLogger(`Updating ${packageName} to the latest version...`);
+export const update = async ({
+  packageName,
+  silent,
+}: {
+  packageName: string;
+  silent?: boolean;
+}) => {
+  let logger: OraType | undefined = undefined;
+  if (!silent) {
+    logger = buildLogger(`Updating ${packageName} to the latest version...`);
+  }
   const { cli: existingCliVersion, client: existingClientVersion } = getVersions();
   const latestCliVersion = getLatestCliVersion(packageName);
   const latestClientVersion = await getTargetMintVersion(logger);
@@ -17,33 +27,45 @@ export const update = async ({ packageName }: { packageName: string }) => {
     latestClientVersion.trim() === existingClientVersion.trim();
 
   if (isUpToDate) {
-    logger.succeed('Already up to date.');
+    if (!silent && logger) {
+      logger.succeed('Already up to date.');
+    }
     return;
   }
 
   if (existingCliVersion && latestCliVersion.trim() !== existingCliVersion.trim()) {
     try {
-      logger.text = `Updating ${packageName} package...`;
+      if (logger) {
+        logger.text = `Updating ${packageName} package...`;
+      }
       execSync(`npm install -g ${packageName}@latest --silent`);
     } catch (err) {
-      logger.fail(`Failed to update ${packageName}@latest`);
+      if (logger) {
+        logger.fail(`Failed to update ${packageName}@latest`);
+      }
       process.exit(1);
     }
   }
 
   if (latestClientVersion && latestClientVersion !== existingClientVersion) {
     try {
-      logger.text = `Updating Mintlify client to ${latestClientVersion}...`;
+      if (logger) {
+        logger.text = `Updating Mintlify client to ${latestClientVersion}...`;
+      }
       await downloadTargetMint({
         logger,
         targetVersion: latestClientVersion,
         existingVersion: existingClientVersion ?? null,
       });
     } catch (err) {
-      logger.fail(`Failed to update Mintlify client to ${latestClientVersion}`);
+      if (logger) {
+        logger.fail(`Failed to update Mintlify client to ${latestClientVersion}`);
+      }
       process.exit(1);
     }
   }
 
-  logger.succeed(`Updated ${packageName} to the latest version: ${latestCliVersion}`);
+  if (logger) {
+    logger.succeed(`Updated ${packageName} to the latest version: ${latestCliVersion}`);
+  }
 };