@mintlify/cli 4.0.589 → 4.0.591

package/__test__/cli.test.ts

@@ -1,7 +1,7 @@
 import { dev } from '@mintlify/previewing';
 import inquirer from 'inquirer';
 
-import { cli } from '../src/cli.js';
+import { runCommand } from './utils.js';
 
 vi.mock('@mintlify/previewing', () => ({ dev: vi.fn() }));
 
@@ -74,13 +74,3 @@ describe('cli', () => {
     );
   });
 });
-
-/**
- * Programmatically set arguments and execute the CLI script
- *
- * @param {...string} args - Additional command arguments.
- */
-async function runCommand(...args: string[]) {
-  process.argv = ['node', 'cli.js', ...args];
-  return cli();
-}

package/__test__/minVersion.test.ts

@@ -0,0 +1,59 @@
+import { dev } from '@mintlify/previewing';
+
+import { LOCAL_LINKED_VERSION } from '../src/constants.js';
+import { getCliVersion } from '../src/helpers.js';
+import * as updateModule from '../src/update.js';
+import { runCommand } from './utils.js';
+
+vi.mock('../src/helpers.js', async (importOriginal) => {
+  const original = await importOriginal();
+  return {
+    // @ts-expect-error - this is a mock
+    ...original,
+    getCliVersion: vi.fn(),
+  };
+});
+
+vi.mock('@mintlify/previewing', () => ({ dev: vi.fn() }));
+
+vi.mock('../src/update.js', () => ({
+  update: vi.fn().mockResolvedValue(undefined),
+}));
+
+describe('minimum version', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  afterEach(() => {
+    vi.resetAllMocks();
+  });
+
+  it('should automatically update the cli if the version is below the minimum', async () => {
+    vi.mocked(getCliVersion).mockReturnValueOnce('4.1.0');
+    const updateSpy = vi.spyOn(updateModule, 'update');
+
+    await runCommand('dev');
+
+    expect(updateSpy).toHaveBeenCalled();
+    expect(dev).toHaveBeenCalled();
+  });
+  it('should not update the cli if the version is above the minimum', async () => {
+    vi.mocked(getCliVersion).mockReturnValueOnce('4.2.1');
+    const updateSpy = vi.spyOn(updateModule, 'update');
+
+    await runCommand('dev');
+
+    expect(updateSpy).not.toHaveBeenCalled();
+    expect(dev).toHaveBeenCalled();
+  });
+  it('should not update the cli if the version is linked to local package', async () => {
+    vi.mocked(getCliVersion).mockReturnValueOnce(LOCAL_LINKED_VERSION);
+    const updateSpy = vi.spyOn(updateModule, 'update');
+
+    await runCommand('dev');
+
+    expect(updateSpy).not.toHaveBeenCalled();
+    expect(dev).toHaveBeenCalled();
+  });
+});

package/__test__/update.test.ts

@@ -21,7 +21,10 @@ vi.mock('../src/helpers.js', async (importOriginal) => {
     // @ts-expect-error - this is a mock
     ...original,
     getLatestCliVersion: vi.fn(),
-    getVersions: vi.fn(),
+    getVersions: vi.fn().mockReturnValue({
+      cli: '1.0.0',
+      client: '1.0.0',
+    }),
   };
 });
 

package/__test__/utils.ts

@@ -0,0 +1,11 @@
+import { cli } from '../src/cli.js';
+
+/**
+ * Programmatically set arguments and execute the CLI script
+ *
+ * @param {...string} args - Additional command arguments.
+ */
+export async function runCommand(...args: string[]) {
+  process.argv = ['node', 'cli.js', ...args];
+  return cli();
+}

package/bin/cli.js

@@ -14,9 +14,11 @@ 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 { checkPort, checkForMintJson, checkNodeVersion, upgradeConfig, checkForDocsJson, getVersions, } from './helpers.js';
+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';
 export const cli = () => yargs(hideBin(process.argv))
     .middleware(checkNodeVersion)
@@ -41,11 +43,26 @@ export const cli = () => yargs(hideBin(process.argv))
     .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;
+    // 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 = 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 }));
+            packageName, cliVersion: cli }));
     }
     else {
         console.error(`No available port found.`);

package/bin/constants.js

@@ -1,3 +1,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/bin/helpers.js

@@ -20,7 +20,7 @@ import { execSync } from 'node:child_process';
 import Ora from 'ora';
 import path from 'path';
 import yargs from 'yargs';
-import { CMD_EXEC_PATH } from './constants.js';
+import { CMD_EXEC_PATH, LOCAL_LINKED_VERSION } from './constants.js';
 export const checkPort = (argv) => __awaiter(void 0, void 0, void 0, function* () {
     const initialPort = typeof argv.port === 'number' ? argv.port : 3000;
     if (initialPort === (yield detect(initialPort)))
@@ -94,20 +94,22 @@ export const upgradeConfig = () => __awaiter(void 0, void 0, void 0, function* (
         process.exit(1);
     }
 });
-const getCliVersion = () => {
+export const getCliVersion = () => {
     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;
 };
 export const getVersions = () => {
-    let cli = getCliVersion();
-    if (cli === 'unknown') {
-        cli = 'linked to local package';
-    }
+    const cli = getCliVersion();
     const client = getClientVersion().trim();
     return { cli, client };
 };