@mintlify/cli 4.0.646 → 4.0.648

package/CONTRIBUTING.md

@@ -43,7 +43,3 @@ If for some reason the release workflow is broken or we can't access AWS program
 ## Manually overriding the client version used locally
 
 Run `mintlify dev --client-version x.x.xxxx` with the client version you would like to use and that version will be downloaded instead of the latest client version.
-
-## Breaking changes
-
-If cli or client contain breaking changes that require they are both updated together, change the MINIMUM_CLI_VERSION to make sure `mint dev` will silently update to a minimum viable CLI version.

package/__test__/update.test.ts

@@ -9,7 +9,6 @@ vi.mock('@mintlify/previewing', async () => {
   return {
     ...originalModule,
     getClientVersion: vi.fn(),
-    getTargetMintVersion: vi.fn(),
     downloadTargetMint: vi.fn(),
   };
 });
@@ -39,58 +38,30 @@ describe('update', () => {
     vi.resetAllMocks();
   });
 
-  it('should update the cli and client successfully', async () => {
+  it('should update the cli successfully', async () => {
     vi.mocked(getVersions).mockReturnValue({
       cli: '1.0.0',
       client: '1.0.0',
     });
-    vi.mocked(previewing.getTargetMintVersion).mockResolvedValue('2.0.0');
     vi.mocked(getLatestCliVersion).mockReturnValue('2.0.0');
     vi.mocked(execAsync).mockResolvedValue({ stdout: '', stderr: '' });
     vi.mocked(previewing.downloadTargetMint).mockResolvedValue();
 
     await update({ packageName: 'mintlify' });
 
-    expect(addLogSpy).toHaveBeenCalledTimes(4);
+    expect(addLogSpy).toHaveBeenCalledTimes(3);
     expect(addLogSpy).toHaveBeenCalledWith(
       expect.objectContaining({ props: { message: 'updating...' } })
     );
     expect(addLogSpy).toHaveBeenCalledWith(
       expect.objectContaining({ props: { message: 'updating mintlify package...' } })
     );
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'updating mintlify client to 2.0.0...' } })
-    );
     expect(addLogSpy).toHaveBeenCalledWith(
       expect.objectContaining({
         props: { message: 'updated mintlify to the latest version: 2.0.0' },
       })
     );
     expect(execAsync).toHaveBeenCalledWith('npm install -g mintlify@latest --silent');
-    expect(previewing.downloadTargetMint).toHaveBeenCalledWith({
-      targetVersion: '2.0.0',
-      existingVersion: '1.0.0',
-    });
-  });
-
-  it('should update the cli and client successfully - silently', async () => {
-    vi.mocked(getVersions).mockReturnValue({
-      cli: '1.0.0',
-      client: '1.0.0',
-    });
-    vi.mocked(previewing.getTargetMintVersion).mockResolvedValue('2.0.0');
-    vi.mocked(getLatestCliVersion).mockReturnValue('2.0.0');
-    vi.mocked(execAsync).mockResolvedValue({ stdout: '', stderr: '' });
-    vi.mocked(previewing.downloadTargetMint).mockResolvedValue();
-
-    await update({ packageName: 'mintlify', silent: true });
-
-    expect(addLogSpy).not.toHaveBeenCalled();
-    expect(execAsync).toHaveBeenCalledWith('npm install -g mintlify@latest --silent');
-    expect(previewing.downloadTargetMint).toHaveBeenCalledWith({
-      targetVersion: '2.0.0',
-      existingVersion: '1.0.0',
-    });
   });
 
   it('should return when already up to date', async () => {
@@ -99,9 +70,7 @@ describe('update', () => {
       client: '1.0.0',
     });
     vi.mocked(getLatestCliVersion).mockReturnValue('1.0.0');
-    vi.mocked(previewing.getTargetMintVersion).mockResolvedValue('1.0.0');
     vi.mocked(execAsync).mockResolvedValue({ stdout: '', stderr: '' });
-    vi.mocked(previewing.downloadTargetMint).mockResolvedValue();
 
     await update({ packageName: 'mintlify' });
 
@@ -113,83 +82,6 @@ describe('update', () => {
       expect.objectContaining({ props: { message: 'already up to date' } })
     );
     expect(execAsync).not.toHaveBeenCalled();
-    expect(previewing.downloadTargetMint).not.toHaveBeenCalled();
-  });
-
-  it('should return when already up to date - silently', async () => {
-    vi.mocked(getVersions).mockReturnValue({
-      cli: '1.0.0',
-      client: '1.0.0',
-    });
-    vi.mocked(getLatestCliVersion).mockReturnValue('1.0.0');
-    vi.mocked(previewing.getTargetMintVersion).mockResolvedValue('1.0.0');
-    vi.mocked(execAsync).mockResolvedValue({ stdout: '', stderr: '' });
-    vi.mocked(previewing.downloadTargetMint).mockResolvedValue();
-
-    await update({ packageName: 'mintlify', silent: true });
-
-    expect(addLogSpy).not.toHaveBeenCalled();
-    expect(execAsync).not.toHaveBeenCalled();
-    expect(previewing.downloadTargetMint).not.toHaveBeenCalled();
-  });
-
-  it('should only update cli if client version is up to date', async () => {
-    vi.mocked(getVersions).mockReturnValue({
-      cli: '1.0.0',
-      client: '2.0.0',
-    });
-    vi.mocked(getLatestCliVersion).mockReturnValue('2.0.0');
-    vi.mocked(previewing.getTargetMintVersion).mockResolvedValue('2.0.0');
-    vi.mocked(execAsync).mockResolvedValue({ stdout: '', stderr: '' });
-
-    await update({ packageName: 'mintlify' });
-
-    expect(addLogSpy).toHaveBeenCalledTimes(3);
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'updating...' } })
-    );
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'updating mintlify package...' } })
-    );
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({
-        props: { message: 'updated mintlify to the latest version: 2.0.0' },
-      })
-    );
-
-    expect(execAsync).toHaveBeenCalledWith('npm install -g mintlify@latest --silent');
-    expect(previewing.downloadTargetMint).not.toHaveBeenCalled();
-  });
-
-  it('should only update client if cli version is up to date', async () => {
-    vi.mocked(getVersions).mockReturnValue({
-      cli: '2.0.0',
-      client: '1.0.0',
-    });
-    vi.mocked(getLatestCliVersion).mockReturnValue('2.0.0');
-    vi.mocked(previewing.getTargetMintVersion).mockResolvedValue('2.0.0');
-    vi.mocked(execAsync).mockResolvedValue({ stdout: '', stderr: '' });
-
-    await update({ packageName: 'mintlify' });
-
-    expect(addLogSpy).toHaveBeenCalledTimes(3);
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'updating...' } })
-    );
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'updating mintlify client to 2.0.0...' } })
-    );
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({
-        props: { message: 'updated mintlify to the latest version: 2.0.0' },
-      })
-    );
-
-    expect(execAsync).not.toHaveBeenCalled();
-    expect(previewing.downloadTargetMint).toHaveBeenCalledWith({
-      targetVersion: '2.0.0',
-      existingVersion: '1.0.0',
-    });
   });
 
   it('should handle cli update failure', async () => {
@@ -198,7 +90,6 @@ describe('update', () => {
       client: '1.0.0',
     });
     vi.mocked(getLatestCliVersion).mockReturnValue('2.0.0');
-    vi.mocked(previewing.getTargetMintVersion).mockResolvedValue('2.0.0');
     vi.mocked(execAsync).mockRejectedValue(new Error('Update failed'));
 
     await update({ packageName: 'mintlify' });
@@ -214,28 +105,4 @@ describe('update', () => {
       expect.objectContaining({ props: { message: 'failed to update mintlify@latest' } })
     );
   });
-
-  it('should handle client update failure', async () => {
-    vi.mocked(getVersions).mockReturnValue({
-      cli: '1.0.0',
-      client: '1.0.0',
-    });
-    vi.mocked(getLatestCliVersion).mockReturnValue('2.0.0');
-    vi.mocked(previewing.getTargetMintVersion).mockResolvedValue('2.0.0');
-    vi.mocked(execAsync).mockResolvedValue({ stdout: '', stderr: '' });
-    vi.mocked(previewing.downloadTargetMint).mockRejectedValue(new Error('Download failed'));
-
-    await update({ packageName: 'mintlify' });
-
-    expect(addLogSpy).toHaveBeenCalledTimes(4);
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'updating...' } })
-    );
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'updating mintlify client to 2.0.0...' } })
-    );
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'failed to update mintlify client to 2.0.0' } })
-    );
-  });
 });

package/bin/cli.js

@@ -13,11 +13,9 @@ import { getBrokenInternalLinks, renameFilesAndUpdateLinksInContent } from '@min
 import { addLog, dev, ErrorLog, SpinnerLog, SuccessLog, Logs, clearLogs, BrokenLinksLog, WarningLog, } 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, terminate, readLocalOpenApiFile, } from './helpers.js';
+import { checkPort, checkForMintJson, checkNodeVersion, upgradeConfig, checkForDocsJson, getVersions, suppressConsoleWarnings, terminate, readLocalOpenApiFile, } from './helpers.js';
 import { update } from './update.js';
 export const cli = ({ packageName = 'mint' }) => {
     render(_jsx(Logs, {}));
@@ -51,15 +49,11 @@ export const cli = ({ packageName = 'mint' }) => {
         .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* () {
         const port = yield checkPort(argv);
-        const cliVersion = getCliVersion();
-        if (cliVersion &&
-            cliVersion !== LOCAL_LINKED_VERSION &&
-            semver.lt(cliVersion, MINIMUM_CLI_VERSION)) {
-            yield update({ packageName, silent: true });
-        }
+        const { cli: cliVersion } = getVersions();
         if (port != undefined) {
             yield dev(Object.assign(Object.assign({}, argv), { port,
-                packageName, cliVersion: cli }));
+                packageName,
+                cliVersion }));
         }
         else {
             addLog(_jsx(ErrorLog, { message: "no available port found" }));

package/bin/constants.js

@@ -1,5 +1,3 @@
 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.90';

package/bin/helpers.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { jsx as _jsx } from "react/jsx-runtime";
 import { getConfigPath } from '@mintlify/prebuild';
 import { MintConfigUpdater } from '@mintlify/prebuild';
-import { addLog, ErrorLog, getClientVersion, SuccessLog, InfoLog, SpinnerLog, removeLastLog, } from '@mintlify/previewing';
+import { addLog, ErrorLog, getClientVersion, SuccessLog, InfoLog, SpinnerLog, removeLastLog, LOCAL_LINKED_CLI_VERSION, } from '@mintlify/previewing';
 import { upgradeToDocsConfig } from '@mintlify/validation';
 import detect from 'detect-port';
 import fse from 'fs-extra';
@@ -21,7 +21,7 @@ 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';
+import { CMD_EXEC_PATH } 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)))
@@ -100,7 +100,7 @@ export const getCliVersion = () => {
     // when running `npm link` the version is 'unknown'
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (version === 'unknown') {
-        version = LOCAL_LINKED_VERSION;
+        version = LOCAL_LINKED_CLI_VERSION;
     }
     return version;
 };