@mintlify/cli 4.0.570 → 4.0.572

package/__test__/update.test.ts

@@ -0,0 +1,137 @@
+import { getTargetMintVersion, downloadTargetMint } from '@mintlify/previewing';
+import { execSync } from 'node:child_process';
+import { mockProcessExit } from 'vitest-mock-process';
+
+import { getLatestCliVersion, getVersions } from '../src/helpers.js';
+import { update } from '../src/update.js';
+
+vi.mock('node:child_process', () => ({
+  execSync: vi.fn(),
+}));
+
+vi.mock('@mintlify/previewing', () => ({
+  getClientVersion: vi.fn(),
+  getTargetMintVersion: vi.fn(),
+  downloadTargetMint: vi.fn(),
+}));
+
+vi.mock('../src/helpers.js', async (importOriginal) => {
+  const original = await importOriginal();
+  return {
+    // @ts-expect-error - this is a mock
+    ...original,
+    getLatestCliVersion: vi.fn(),
+    getVersions: vi.fn(),
+  };
+});
+
+const processExitMock = mockProcessExit();
+
+describe('update', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  afterEach(() => {
+    vi.resetAllMocks();
+  });
+
+  it('should update the cli and client successfully', async () => {
+    vi.mocked(getVersions).mockReturnValue({
+      cli: '1.0.0',
+      client: '1.0.0',
+    });
+    vi.mocked(getTargetMintVersion).mockResolvedValue('2.0.0');
+    vi.mocked(getLatestCliVersion).mockReturnValue('2.0.0');
+    vi.mocked(execSync).mockReturnValue(Buffer.from(''));
+    vi.mocked(downloadTargetMint).mockResolvedValue();
+
+    await update({ packageName: 'mintlify' });
+
+    expect(execSync).toHaveBeenCalledWith('npm install -g mintlify@latest --silent');
+    expect(downloadTargetMint).toHaveBeenCalledWith({
+      logger: expect.any(Object),
+      targetVersion: '2.0.0',
+      existingVersion: '1.0.0',
+    });
+  });
+
+  it('should return when already up to date', async () => {
+    vi.mocked(getVersions).mockReturnValue({
+      cli: '1.0.0',
+      client: '1.0.0',
+    });
+    vi.mocked(getLatestCliVersion).mockReturnValue('1.0.0');
+    vi.mocked(getTargetMintVersion).mockResolvedValue('1.0.0');
+    vi.mocked(execSync).mockReturnValue(Buffer.from(''));
+    vi.mocked(downloadTargetMint).mockResolvedValue();
+
+    await update({ packageName: 'mintlify' });
+
+    expect(execSync).not.toHaveBeenCalled();
+    expect(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(getTargetMintVersion).mockResolvedValue('2.0.0');
+    vi.mocked(execSync).mockReturnValue(Buffer.from(''));
+
+    await update({ packageName: 'mintlify' });
+
+    expect(execSync).toHaveBeenCalledWith('npm install -g mintlify@latest --silent');
+    expect(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(getTargetMintVersion).mockResolvedValue('2.0.0');
+    vi.mocked(execSync).mockReturnValue(Buffer.from(''));
+
+    await update({ packageName: 'mintlify' });
+
+    expect(execSync).not.toHaveBeenCalled();
+    expect(downloadTargetMint).toHaveBeenCalledWith({
+      logger: expect.any(Object),
+      targetVersion: '2.0.0',
+      existingVersion: '1.0.0',
+    });
+  });
+
+  it('should handle cli update failure', async () => {
+    vi.mocked(getVersions).mockReturnValue({
+      cli: '1.0.0',
+      client: '1.0.0',
+    });
+    vi.mocked(getLatestCliVersion).mockReturnValue('2.0.0');
+    vi.mocked(getTargetMintVersion).mockResolvedValue('2.0.0');
+    vi.mocked(execSync).mockImplementation(() => {
+      throw new Error('Update failed');
+    });
+
+    await update({ packageName: 'mintlify' });
+    expect(processExitMock).toHaveBeenCalledWith(1);
+  });
+
+  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(getTargetMintVersion).mockResolvedValue('2.0.0');
+    vi.mocked(execSync).mockReturnValue(Buffer.from(''));
+    vi.mocked(downloadTargetMint).mockRejectedValue(new Error('Download failed'));
+
+    await update({ packageName: 'mintlify' });
+    expect(processExitMock).toHaveBeenCalledWith(1);
+  });
+});

package/bin/cli.js

@@ -17,6 +17,7 @@ import path from 'path';
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 import { checkPort, checkForMintJson, checkNodeVersion, upgradeConfig, checkForDocsJson, getVersions, } from './helpers.js';
+import { update } from './update.js';
 export const cli = () => yargs(hideBin(process.argv))
     .middleware(checkNodeVersion)
     .command('dev', 'Runs Mintlify project locally.', (yargs) => yargs
@@ -39,9 +40,12 @@ export const cli = () => yargs(hideBin(process.argv))
     .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';
     if (port != undefined) {
-        yield dev(Object.assign(Object.assign({}, argv), { port }));
+        yield dev(Object.assign(Object.assign({}, argv), { port,
+            packageName }));
     }
     else {
         console.error(`No available port found.`);
@@ -130,6 +134,11 @@ export const cli = () => yargs(hideBin(process.argv))
         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();

package/bin/helpers.js

@@ -16,6 +16,7 @@ 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 path from 'path';
 import yargs from 'yargs';
@@ -110,3 +111,9 @@ export const getVersions = () => {
     const client = getClientVersion().trim();
     return { cli, client };
 };
+export const getLatestCliVersion = (packageName) => {
+    return execSync(`npm view ${packageName} version --silent`, {
+        encoding: 'utf-8',
+        stdio: ['pipe', 'pipe', 'pipe'],
+    }).trim();
+};