@mintlify/cli 4.0.1337 → 4.0.1339

package/__test__/brokenLinks.test.ts

@@ -1,9 +1,11 @@
 import { buildGraph, getBrokenExternalLinks } from '@mintlify/link-rot';
 import { MdxPath } from '@mintlify/link-rot/dist/graph.js';
 import { addLog, clearLogs } from '@mintlify/previewing';
+import path from 'node:path';
 import { mockProcessExit } from 'vitest-mock-process';
 
-import { checkForMintJson } from '../src/helpers.js';
+import { resolveExplicitFiles } from '../src/deslop/resolveFiles.js';
+import { checkForMintJson, CMD_EXEC_PATH } from '../src/helpers.js';
 import { runCommand } from './utils.js';
 
 vi.mock('@mintlify/previewing', async (importOriginal) => {
@@ -19,6 +21,11 @@ vi.mock('../src/helpers.js', async (importOriginal) => {
   };
 });
 
+vi.mock('../src/deslop/resolveFiles.js', () => ({
+  resolveChangedFiles: vi.fn(),
+  resolveExplicitFiles: vi.fn(),
+}));
+
 const mockGraph = {
   precomputeFileResolutions: vi.fn(),
   getBrokenInternalLinks: vi.fn().mockReturnValue([]),
@@ -42,6 +49,7 @@ describe('brokenLinks', () => {
   beforeEach(() => {
     vi.clearAllMocks();
     vi.mocked(buildGraph).mockResolvedValue(mockGraph as never);
+    vi.mocked(resolveExplicitFiles).mockResolvedValue([]);
     mockGraph.getBrokenInternalLinks.mockReturnValue([]);
   });
 
@@ -94,6 +102,42 @@ describe('brokenLinks', () => {
     expect(processExitMock).toHaveBeenCalledWith(1);
   });
 
+  it('checks only files matching the provided option', async () => {
+    vi.mocked(checkForMintJson).mockResolvedValueOnce(true);
+    vi.mocked(resolveExplicitFiles).mockResolvedValueOnce(['guides/selected.mdx']);
+    mockGraph.getBrokenInternalLinks.mockReturnValue([
+      {
+        relativeDir: 'guides',
+        filename: 'selected.mdx',
+        originalPath: '/api/selected-invalid',
+        pathType: 'internal',
+      } as MdxPath,
+      {
+        relativeDir: 'guides',
+        filename: 'other.mdx',
+        originalPath: '/api/other-invalid',
+        pathType: 'internal',
+      } as MdxPath,
+    ]);
+
+    await runCommand('broken-links', '--files', 'guides/selected.mdx', 'guides/**/*.mdx');
+
+    expect(resolveExplicitFiles).toHaveBeenCalledWith(CMD_EXEC_PATH, [
+      'guides/selected.mdx',
+      'guides/**/*.mdx',
+    ]);
+    expect(addLogSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        props: {
+          brokenLinksByFile: {
+            [path.join('guides', 'selected.mdx')]: ['/api/selected-invalid'],
+          },
+        },
+      })
+    );
+    expect(processExitMock).toHaveBeenCalledWith(1);
+  });
+
   it('fails when checking throws error', async () => {
     vi.mocked(checkForMintJson).mockResolvedValueOnce(true);
     vi.mocked(buildGraph).mockRejectedValueOnce(new Error('some error'));
@@ -118,6 +162,7 @@ describe('brokenLinks --check-external', () => {
   beforeEach(() => {
     vi.clearAllMocks();
     vi.mocked(buildGraph).mockResolvedValue(mockGraph as never);
+    vi.mocked(resolveExplicitFiles).mockResolvedValue([]);
     mockGraph.getBrokenInternalLinks.mockReturnValue([]);
   });
 
@@ -160,6 +205,19 @@ describe('brokenLinks --check-external', () => {
     expect(processExitMock).toHaveBeenCalledWith(1);
   });
 
+  it('checks external links only from matching files', async () => {
+    vi.mocked(checkForMintJson).mockResolvedValueOnce(true);
+    vi.mocked(resolveExplicitFiles).mockResolvedValueOnce(['selected.mdx']);
+    vi.mocked(getBrokenExternalLinks).mockResolvedValueOnce([]);
+
+    await runCommand('broken-links', '--files', 'selected.mdx', '--check-external');
+
+    expect(getBrokenExternalLinks).toHaveBeenCalledWith(mockGraph, {
+      sourceFiles: new Set(['selected.mdx']),
+    });
+    expect(processExitMock).toHaveBeenCalledWith(0);
+  });
+
   it('fails when external link checking throws error', async () => {
     vi.mocked(checkForMintJson).mockResolvedValueOnce(true);
     vi.mocked(getBrokenExternalLinks).mockRejectedValueOnce(new Error('network error'));

package/bin/cli.js

@@ -21,6 +21,7 @@ import { setTelemetryEnabled } from './config.js';
 import { getConfigValue, setConfigValue, clearConfigValue } from './config.js';
 import { API_URL } from './constants.js';
 import { deslopHandler } from './deslop/index.js';
+import { resolveExplicitFiles } from './deslop/resolveFiles.js';
 import { CMD_EXEC_PATH, checkPort, checkNodeVersion, autoUpgradeIfNeeded, getVersions, isAI, suppressConsoleWarnings, terminate, } from './helpers.js';
 import { init } from './init.js';
 import { getAccessToken } from './keyring.js';
@@ -232,6 +233,11 @@ export const cli = ({ packageName = 'mint' }) => {
         yield terminate(valid ? 0 : 1);
     }))
         .command('broken-links', 'Check for broken links', (yargs) => yargs
+        .option('files', {
+        type: 'string',
+        array: true,
+        description: 'Files or globs to check (defaults to the whole site)',
+    })
         .option('check-anchors', {
         type: 'boolean',
         default: false,
@@ -251,17 +257,26 @@ export const cli = ({ packageName = 'mint' }) => {
         type: 'boolean',
         default: false,
         description: 'also check that docs.json redirect destinations resolve to valid paths',
-    }), (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    })
+        .example('mint broken-links --files introduction.mdx', 'Check a specific page')
+        .example('mint broken-links --files "guides/**/*.mdx"', 'Check pages matching a glob'), (argv) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
         yield autoUpgradeIfNeeded();
         addLog(_jsx(SpinnerLog, { message: "checking for broken links..." }));
         try {
+            const fileArgs = ((_a = argv.files) !== null && _a !== void 0 ? _a : []).map(String).filter(Boolean);
+            const sourceFiles = fileArgs.length > 0
+                ? new Set((yield resolveExplicitFiles(CMD_EXEC_PATH, fileArgs)).map((file) => path.normalize(file)))
+                : undefined;
             const graph = yield buildGraph(undefined, {
                 checkSnippets: argv['check-snippets'],
             });
             graph.precomputeFileResolutions();
-            const brokenInternalLinks = graph.getBrokenInternalLinks({
+            const brokenInternalLinks = graph
+                .getBrokenInternalLinks({
                 checkAnchors: argv['check-anchors'],
-            });
+            })
+                .filter(({ relativeDir, filename }) => !sourceFiles || sourceFiles.has(path.join(relativeDir, filename)));
             const brokenLinksByFile = {};
             brokenInternalLinks.forEach((mdxPath) => {
                 const filename = path.join(mdxPath.relativeDir, mdxPath.filename);
@@ -274,7 +289,7 @@ export const cli = ({ packageName = 'mint' }) => {
                 }
             });
             if (argv['check-external']) {
-                const brokenExternalLinks = yield getBrokenExternalLinks(graph);
+                const brokenExternalLinks = yield getBrokenExternalLinks(graph, sourceFiles ? { sourceFiles } : undefined);
                 for (const result of brokenExternalLinks) {
                     for (const source of result.sources) {
                         const label = result.status