@mintlify/cli 4.0.1344 → 4.0.1346

package/__test__/brokenLinks.test.ts

@@ -5,7 +5,7 @@ import path from 'node:path';
 import { mockProcessExit } from 'vitest-mock-process';
 
 import { resolveExplicitFiles } from '../src/deslop/resolveFiles.js';
-import { checkForMintJson, CMD_EXEC_PATH } from '../src/helpers.js';
+import { checkForMintJson, CMD_EXEC_PATH, findDocsRoot } from '../src/helpers.js';
 import { runCommand } from './utils.js';
 
 vi.mock('@mintlify/previewing', async (importOriginal) => {
@@ -18,6 +18,7 @@ vi.mock('../src/helpers.js', async (importOriginal) => {
   return {
     ...actual,
     checkForMintJson: vi.fn(),
+    findDocsRoot: vi.fn(),
   };
 });
 
@@ -50,6 +51,7 @@ describe('brokenLinks', () => {
     vi.clearAllMocks();
     vi.mocked(buildGraph).mockResolvedValue(mockGraph as never);
     vi.mocked(resolveExplicitFiles).mockResolvedValue([]);
+    vi.mocked(findDocsRoot).mockResolvedValue(CMD_EXEC_PATH);
     mockGraph.getBrokenInternalLinks.mockReturnValue([]);
   });
 
@@ -138,6 +140,44 @@ describe('brokenLinks', () => {
     expect(processExitMock).toHaveBeenCalledWith(1);
   });
 
+  it('builds the graph from the docs root when run inside a content folder', async () => {
+    const docsRoot = path.resolve(CMD_EXEC_PATH, '..', '..');
+    vi.mocked(checkForMintJson).mockResolvedValueOnce(true);
+    vi.mocked(findDocsRoot).mockResolvedValue(docsRoot);
+    vi.mocked(resolveExplicitFiles).mockResolvedValueOnce(['apis.mdx']);
+    mockGraph.getBrokenInternalLinks.mockReturnValue([]);
+
+    await runCommand('broken-links', '--files', 'apis.mdx');
+
+    expect(buildGraph).toHaveBeenCalledWith(docsRoot, expect.anything());
+    expect(processExitMock).toHaveBeenCalledWith(0);
+  });
+
+  it('rebases matched files onto the docs root so nested links still resolve', async () => {
+    const docsRoot = path.resolve(CMD_EXEC_PATH, '..', '..');
+    const nested = path.relative(docsRoot, path.join(CMD_EXEC_PATH, 'apis.mdx'));
+    vi.mocked(checkForMintJson).mockResolvedValueOnce(true);
+    vi.mocked(findDocsRoot).mockResolvedValue(docsRoot);
+    vi.mocked(resolveExplicitFiles).mockResolvedValueOnce(['apis.mdx']);
+    mockGraph.getBrokenInternalLinks.mockReturnValue([
+      {
+        relativeDir: path.dirname(nested),
+        filename: 'apis.mdx',
+        originalPath: '/docs/authenticate',
+        pathType: 'internal',
+      } as MdxPath,
+    ]);
+
+    await runCommand('broken-links', '--files', 'apis.mdx');
+
+    expect(addLogSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        props: { brokenLinksByFile: { [nested]: ['/docs/authenticate'] } },
+      })
+    );
+    expect(processExitMock).toHaveBeenCalledWith(1);
+  });
+
   it('fails when checking throws error', async () => {
     vi.mocked(checkForMintJson).mockResolvedValueOnce(true);
     vi.mocked(buildGraph).mockRejectedValueOnce(new Error('some error'));
@@ -163,6 +203,7 @@ describe('brokenLinks --check-external', () => {
     vi.clearAllMocks();
     vi.mocked(buildGraph).mockResolvedValue(mockGraph as never);
     vi.mocked(resolveExplicitFiles).mockResolvedValue([]);
+    vi.mocked(findDocsRoot).mockResolvedValue(CMD_EXEC_PATH);
     mockGraph.getBrokenInternalLinks.mockReturnValue([]);
   });
 

package/bin/cli.js

@@ -24,7 +24,7 @@ import { API_URL } from './constants.js';
 import { deslopHandler } from './deslop/index.js';
 import { resolveExplicitFiles } from './deslop/resolveFiles.js';
 import { formatHandler } from './format.js';
-import { CMD_EXEC_PATH, checkPort, checkNodeVersion, autoUpgradeIfNeeded, getVersions, isAI, suppressConsoleWarnings, terminate, } from './helpers.js';
+import { CMD_EXEC_PATH, checkPort, checkNodeVersion, autoUpgradeIfNeeded, findDocsRoot, getVersions, isAI, suppressConsoleWarnings, terminate, } from './helpers.js';
 import { init } from './init.js';
 import { getAccessToken } from './keyring.js';
 import { login } from './login.js';
@@ -266,11 +266,12 @@ export const cli = ({ packageName = 'mint' }) => {
         yield autoUpgradeIfNeeded();
         addLog(_jsx(SpinnerLog, { message: "checking for broken links..." }));
         try {
+            const docsRoot = yield findDocsRoot(CMD_EXEC_PATH);
             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)))
+                ? new Set((yield resolveExplicitFiles(CMD_EXEC_PATH, fileArgs)).map((file) => path.relative(docsRoot, path.resolve(CMD_EXEC_PATH, file))))
                 : undefined;
-            const graph = yield buildGraph(undefined, {
+            const graph = yield buildGraph(docsRoot, {
                 checkSnippets: argv['check-snippets'],
             });
             graph.precomputeFileResolutions();
@@ -311,7 +312,7 @@ export const cli = ({ packageName = 'mint' }) => {
                 const brokenRedirects = graph.getBrokenRedirects();
                 if (brokenRedirects.length > 0) {
                     const configFilename = yield fs
-                        .access(path.join(CMD_EXEC_PATH, 'docs.json'))
+                        .access(path.join(docsRoot, 'docs.json'))
                         .then(() => 'docs.json')
                         .catch(() => 'mint.json');
                     const labels = brokenRedirects.map(({ source, destination }) => `${source} → ${destination}`);

package/bin/helpers.js

@@ -55,6 +55,17 @@ export const checkNodeVersion = () => __awaiter(void 0, void 0, void 0, function
 export const checkForMintJson = () => __awaiter(void 0, void 0, void 0, function* () {
     return !!(yield getConfigPath(CMD_EXEC_PATH, 'mint'));
 });
+export const findDocsRoot = (startDir) => __awaiter(void 0, void 0, void 0, function* () {
+    const start = path.resolve(startDir);
+    const { root } = path.parse(start);
+    let dir = start;
+    while (dir !== root) {
+        if ((yield getConfigPath(dir, 'docs')) || (yield getConfigPath(dir, 'mint')))
+            return dir;
+        dir = path.dirname(dir);
+    }
+    return start;
+});
 export const checkForDocsJson = () => __awaiter(void 0, void 0, void 0, function* () {
     const docsJsonPath = path.join(CMD_EXEC_PATH, 'docs.json');
     if (!(yield fse.pathExists(docsJsonPath))) {