@mintlify/cli 4.0.1080 → 4.0.1081

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1080",
+  "version": "4.0.1081",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -47,10 +47,8 @@
     "@inquirer/prompts": "7.9.0",
     "@mintlify/common": "1.0.832",
     "@mintlify/link-rot": "3.0.1005",
-    "@mintlify/models": "0.0.287",
     "@mintlify/prebuild": "1.0.974",
     "@mintlify/previewing": "4.0.1033",
-    "@mintlify/scraping": "4.0.696",
     "@mintlify/validation": "0.1.651",
     "adm-zip": "0.5.16",
     "chalk": "5.2.0",
@@ -95,5 +93,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "1686b983ba34748f3685d0c91f1db11d0df500ea"
+  "gitHead": "5ae51fe99e6cdb06b0c0307a0f3f90026b2df180"
 }

package/src/cli.tsx

@@ -1,8 +1,4 @@
-import {
-  buildGraph,
-  getBrokenExternalLinks,
-  renameFilesAndUpdateLinksInContent,
-} from '@mintlify/link-rot';
+import { buildGraph, getBrokenExternalLinks } from '@mintlify/link-rot';
 import {
   addLog,
   dev,
@@ -16,7 +12,6 @@ import {
   BrokenLinksLog,
   WarningLog,
 } from '@mintlify/previewing';
-import { checkUrl } from '@mintlify/scraping';
 import { render, Text } from 'ink';
 import fs from 'node:fs/promises';
 import path from 'path';
@@ -38,9 +33,7 @@ import { init } from './init.js';
 import { login } from './login.js';
 import { logout } from './logout.js';
 import { mdxLinter } from './mdxLinter.js';
-import { migrateMdx } from './migrateMdx.js';
 import { checkOpenApiFile, getOpenApiFilenamesFromDocsConfig } from './openApiCheck.js';
-import { scrapeSite, scrapePage, scrapeOpenApi } from './scrape.js';
 import { status } from './status.js';
 import { createTelemetryMiddleware } from './telemetry/middleware.js';
 import { trackTelemetryPreferenceChange } from './telemetry/track.js';
@@ -320,32 +313,6 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
           await terminate(1);
         }
       )
-      .command(
-        'rename <from> <to>',
-        'rename a file and update all internal link references',
-        (yargs) =>
-          yargs
-            .positional('from', {
-              describe: 'the file to rename',
-              type: 'string',
-            })
-            .positional('to', {
-              describe: 'the new name for the file',
-              type: 'string',
-            })
-            .demandOption(['from', 'to'])
-            .option('force', {
-              type: 'boolean',
-              default: false,
-              description: 'rename files and skip errors',
-            })
-            .epilog('example: `mintlify rename introduction.mdx overview.mdx`'),
-        async ({ from, to, force }) => {
-          await autoUpgradeIfNeeded();
-          await renameFilesAndUpdateLinksInContent(from, to, force);
-          await terminate(0);
-        }
-      )
       .command(
         'status',
         false,
@@ -382,15 +349,6 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
           await terminate(0);
         }
       )
-      .command(
-        'migrate-mdx',
-        'migrate mdx openapi endpoint pages to x-mint extensions and docs.json',
-        () => undefined,
-        async () => {
-          await migrateMdx();
-          await terminate(0);
-        }
-      )
       .command(
         ['a11y', 'accessibility-check', 'a11y-check', 'accessibility'],
         'check for accessibility issues in documentation',
@@ -505,80 +463,6 @@ export const cli = ({ packageName = 'mint' }: { packageName?: string }) => {
           }
         }
       )
-      .command('scrape', 'scrape documentation from external sites', (yargs) =>
-        yargs
-          .command(
-            ['$0 <url>', 'site <url>'],
-            'scrape an entire documentation site',
-            (yargs) =>
-              yargs
-                .positional('url', {
-                  describe: 'The URL of the documentation site to scrape',
-                  type: 'string',
-                  demandOption: true,
-                })
-                .option('filter', {
-                  describe:
-                    'Only scrape URLs matching this path filter (e.g. /docs will match /docs and /docs/*)',
-                  type: 'string',
-                  alias: 'f',
-                })
-                .check(checkUrl),
-            async ({ url, filter }) => {
-              await scrapeSite(url, filter);
-            }
-          )
-          .command(
-            'page <url>',
-            'scrape a single documentation page',
-            (yargs) =>
-              yargs
-                .positional('url', {
-                  describe: 'The URL of the documentation page to scrape',
-                  type: 'string',
-                  demandOption: true,
-                })
-                .check(checkUrl),
-            async ({ url }) => {
-              await scrapePage(url);
-            }
-          )
-          .command(
-            'openapi <openapiLocation>',
-            'generate mdx files from an openapi spec',
-            (yargs) =>
-              yargs
-                .positional('openapiLocation', {
-                  describe: 'The filename or URL location of the OpenAPI spec',
-                  type: 'string',
-                  demandOption: true,
-                })
-                .option('writeFiles', {
-                  describe: 'Whether or not to write the frontmatter files',
-                  default: true,
-                  type: 'boolean',
-                  alias: 'w',
-                })
-                .option('outDir', {
-                  describe: 'The folder in which to write any created frontmatter files',
-                  type: 'string',
-                  alias: 'o',
-                })
-                .option('overwrite', {
-                  describe: 'Whether or not to overwrite existing files',
-                  default: false,
-                  type: 'boolean',
-                }),
-            async (argv) => {
-              await scrapeOpenApi({
-                openapiLocation: argv.openapiLocation,
-                writeFiles: argv.writeFiles,
-                outDir: argv.outDir,
-                overwrite: argv.overwrite,
-              });
-            }
-          )
-      )
       // 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/__test__/migrateMdx.test.ts

@@ -1,236 +0,0 @@
-import { toPosixPath } from '@mintlify/common';
-import { getConfigObj, getConfigPath } from '@mintlify/prebuild';
-import * as previewing from '@mintlify/previewing';
-import { validateDocsConfig } from '@mintlify/validation';
-import fs from 'fs';
-import { outputFile } from 'fs-extra';
-
-import { migrateMdx } from '../src/migrateMdx.js';
-
-vi.mock('../src/constants.js', () => ({
-  HOME_DIR: '/home/test-user',
-  CMD_EXEC_PATH: '/project',
-}));
-
-vi.mock('@mintlify/prebuild', async () => {
-  const original = await vi.importActual<typeof import('@mintlify/prebuild')>('@mintlify/prebuild');
-  return {
-    ...original,
-    getConfigPath: vi.fn(),
-    getConfigObj: vi.fn(),
-  };
-});
-
-vi.mock('@mintlify/validation', async () => {
-  const original =
-    await vi.importActual<typeof import('@mintlify/validation')>('@mintlify/validation');
-  return {
-    ...original,
-    validateDocsConfig: vi.fn(),
-  };
-});
-
-vi.mock('fs-extra', () => ({
-  outputFile: vi.fn(),
-}));
-
-const addLogSpy = vi.spyOn(previewing, 'addLog');
-
-describe('migrateMdx', () => {
-  beforeEach(() => {
-    vi.clearAllMocks();
-  });
-
-  const mkDirent = (name: string, isDir: boolean) =>
-    ({ name, isDirectory: () => isDir, isFile: () => !isDir }) as unknown as fs.Dirent;
-
-  const readdirSpy = vi.spyOn(fs.promises, 'readdir');
-  readdirSpy.mockImplementation(async (p: Parameters<typeof fs.promises.readdir>[0]) => {
-    const value = toPosixPath(
-      typeof p === 'string' ? p : (p as unknown as { toString(): string }).toString()
-    );
-    if (value === '/project') {
-      return [
-        mkDirent('api', true),
-        mkDirent('webhooks', true),
-        mkDirent('openapi.json', false),
-        mkDirent('openapi1.json', false),
-      ];
-    }
-    if (value === '/project/api') {
-      return [mkDirent('pets.mdx', false)];
-    }
-    if (value === '/project/webhooks') {
-      return [mkDirent('newPet.mdx', false)];
-    }
-    return [] as unknown as fs.Dirent[];
-  });
-
-  it('logs and exits when docs.json is not found', async () => {
-    vi.mocked(getConfigPath).mockResolvedValueOnce(undefined as unknown as string);
-
-    await migrateMdx();
-
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'docs.json not found in current directory' } })
-    );
-  });
-
-  it('migrates a path operation MDX page to x-mint and updates docs.json and spec', async () => {
-    vi.mocked(getConfigPath).mockResolvedValueOnce('/project/docs.json');
-    vi.mocked(getConfigObj).mockResolvedValueOnce({
-      navigation: {
-        pages: ['api/pets'],
-      },
-    } as unknown as object);
-    vi.mocked(validateDocsConfig).mockResolvedValueOnce({
-      success: true,
-      data: {
-        navigation: {
-          pages: ['api/pets'],
-        },
-      },
-    } as unknown as ReturnType<typeof validateDocsConfig>);
-
-    const existsSyncSpy = vi.spyOn(fs, 'existsSync');
-    existsSyncSpy.mockImplementation((p: fs.PathLike) => {
-      const value = toPosixPath(String(p));
-      return value === '/project/api/pets.mdx' || value === 'openapi.json';
-    });
-
-    const readFileSpy = vi.spyOn(fs.promises, 'readFile');
-    readFileSpy.mockImplementation(async (p: Parameters<typeof fs.promises.readFile>[0]) => {
-      const value = toPosixPath(
-        typeof p === 'string' ? p : (p as unknown as { toString(): string }).toString()
-      );
-      if (value === '/project/docs.json') {
-        return JSON.stringify({ navigation: { pages: ['api/pets'] } });
-      }
-      if (value === '/project/api/pets.mdx') {
-        return `---\nopenapi: openapi.json GET /pets\n---\n\n# Title\nContent`;
-      }
-      if (value === '/project/openapi.json') {
-        return JSON.stringify({
-          openapi: '3.0.0',
-          info: { title: 'Test', version: '1.0.0' },
-          paths: {
-            '/pets': {
-              get: {
-                summary: 'List pets',
-                responses: { '200': { description: 'ok' } },
-              },
-            },
-          },
-        });
-      }
-      throw new Error('Unexpected readFile path: ' + value);
-    });
-
-    const unlinkSpy = vi.spyOn(fs.promises, 'unlink').mockResolvedValueOnce();
-
-    await migrateMdx();
-
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'docs.json updated' } })
-    );
-
-    expect(outputFile).toHaveBeenCalledWith(
-      '/project/docs.json',
-      expect.stringContaining('openapi.json get /pets')
-    );
-
-    const specWriteCall = vi
-      .mocked(outputFile)
-      .mock.calls.find(
-        (c) => typeof c[0] === 'string' && (c[0] as string).includes('openapi.json')
-      );
-    expect(specWriteCall).toBeTruthy();
-    const writtenSpec = JSON.parse(specWriteCall?.[1] as string);
-    expect(writtenSpec.paths['/pets'].get['x-mint']).toEqual(
-      expect.objectContaining({ href: '/api/pets' })
-    );
-
-    expect(
-      unlinkSpy.mock.calls.some((c) => toPosixPath(c[0] as string) === '/project/api/pets.mdx')
-    ).toBe(true);
-
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'migration complete' } })
-    );
-  });
-
-  it('migrates a webhook MDX page to x-mint on the webhook operation', async () => {
-    vi.mocked(getConfigPath).mockResolvedValueOnce('/project/docs.json');
-    vi.mocked(getConfigObj).mockResolvedValueOnce({
-      navigation: {
-        pages: ['webhooks/newPet'],
-      },
-    } as unknown as object);
-    vi.mocked(validateDocsConfig).mockResolvedValueOnce({
-      success: true,
-      data: {
-        navigation: {
-          pages: ['webhooks/newPet'],
-        },
-      },
-    } as unknown as ReturnType<typeof validateDocsConfig>);
-
-    const existsSyncSpy = vi.spyOn(fs, 'existsSync');
-    existsSyncSpy.mockImplementation((p: fs.PathLike) => {
-      const value = toPosixPath(String(p));
-      return value === '/project/webhooks/newPet.mdx' || value === 'openapi1.json';
-    });
-
-    const readFileSpy = vi.spyOn(fs.promises, 'readFile');
-    readFileSpy.mockImplementation(async (p: Parameters<typeof fs.promises.readFile>[0]) => {
-      const value = toPosixPath(
-        typeof p === 'string' ? p : (p as unknown as { toString(): string }).toString()
-      );
-      if (value === '/project/docs.json') {
-        return JSON.stringify({ navigation: { pages: ['webhooks/newPet'] } });
-      }
-      if (value === '/project/webhooks/newPet.mdx') {
-        return `---\nopenapi: openapi1.json webhook newPet\n---\n\n# Webhook\nBody`;
-      }
-      if (value === '/project/openapi1.json') {
-        return JSON.stringify({
-          openapi: '3.1.0',
-          info: { title: 'Test', version: '1.0.0' },
-          webhooks: {
-            newPet: {
-              post: {
-                summary: 'Webhook - new pet',
-                requestBody: {},
-                responses: { '200': { description: 'ok' } },
-              },
-            },
-          },
-        });
-      }
-      throw new Error('Unexpected readFile path: ' + value);
-    });
-
-    vi.spyOn(fs.promises, 'unlink').mockResolvedValueOnce();
-
-    await migrateMdx();
-
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'docs.json updated' } })
-    );
-
-    const specWriteCall = vi
-      .mocked(outputFile)
-      .mock.calls.find(
-        (c) => typeof c[0] === 'string' && (c[0] as string).includes('openapi1.json')
-      );
-    expect(specWriteCall).toBeTruthy();
-    const writtenSpec = JSON.parse(specWriteCall?.[1] as string);
-    expect(writtenSpec.webhooks.newPet.post['x-mint']).toEqual(
-      expect.objectContaining({ href: '/webhooks/newPet' })
-    );
-
-    expect(addLogSpy).toHaveBeenCalledWith(
-      expect.objectContaining({ props: { message: 'migration complete' } })
-    );
-  });
-});