@mintlify/cli 4.0.1647 → 4.0.1649

package/__test__/mdxAccessibility.test.ts

@@ -0,0 +1,81 @@
+import fs from 'fs';
+
+import { checkMdxAccessibility } from '../src/mdxAccessibility.js';
+
+vi.mock('@mintlify/prebuild', async (importOriginal) => {
+  const mod = await importOriginal<typeof import('@mintlify/prebuild')>();
+  return {
+    ...mod,
+    getMintIgnore: vi.fn(async () => []),
+    categorizeFilePaths: vi.fn(async () => ({ contentFilenames: ['test.mdx'] })),
+  };
+});
+
+vi.mock('fs');
+
+const mockReadFileSync = vi.mocked(fs.readFileSync);
+
+beforeEach(() => {
+  vi.clearAllMocks();
+});
+
+describe('checkMdxAccessibility', () => {
+  it('detects missing alt on markdown image', async () => {
+    mockReadFileSync.mockReturnValueOnce('![](image.png)' as unknown as Buffer);
+    const result = await checkMdxAccessibility('/docs');
+    expect(result.missingAltAttributes).toHaveLength(1);
+    expect(result.missingAltAttributes[0]?.element).toBe('img');
+  });
+
+  it('detects missing alt on JSX img', async () => {
+    mockReadFileSync.mockReturnValueOnce('<img src="image.png" />' as unknown as Buffer);
+    const result = await checkMdxAccessibility('/docs');
+    expect(result.missingAltAttributes).toHaveLength(1);
+    expect(result.missingAltAttributes[0]?.element).toBe('img');
+  });
+
+  it('detects missing alt on JSX video', async () => {
+    mockReadFileSync.mockReturnValueOnce('<video src="clip.mp4" />' as unknown as Buffer);
+    const result = await checkMdxAccessibility('/docs');
+    expect(result.missingAltAttributes).toHaveLength(1);
+    expect(result.missingAltAttributes[0]?.element).toBe('video');
+  });
+
+  it('detects empty anchor', async () => {
+    mockReadFileSync.mockReturnValueOnce('<a href="/page"></a>' as unknown as Buffer);
+    const result = await checkMdxAccessibility('/docs');
+    expect(result.missingAltAttributes).toHaveLength(1);
+    expect(result.missingAltAttributes[0]?.element).toBe('a');
+  });
+
+  it('passes when alt text is present', async () => {
+    mockReadFileSync.mockReturnValueOnce('![A cat](cat.png)' as unknown as Buffer);
+    const result = await checkMdxAccessibility('/docs');
+    expect(result.missingAltAttributes).toHaveLength(0);
+  });
+
+  it('does not skip files containing {#id} heading syntax', async () => {
+    const content = '## Heading {#custom-id}\n\n<img src="image.png" />';
+    mockReadFileSync.mockReturnValueOnce(content as unknown as Buffer);
+    const result = await checkMdxAccessibility('/docs');
+    expect(result.missingAltAttributes).toHaveLength(1);
+    expect(result.missingAltAttributes[0]?.element).toBe('img');
+  });
+
+  it('reports accurate line numbers when {#id} heading precedes the issue', async () => {
+    const content = '## Heading {#custom-id}\n\n<img src="image.png" />';
+    mockReadFileSync.mockReturnValueOnce(content as unknown as Buffer);
+    const result = await checkMdxAccessibility('/docs');
+    expect(result.missingAltAttributes[0]?.line).toBe(2);
+  });
+
+  it('returns correct totals', async () => {
+    mockReadFileSync.mockReturnValueOnce(
+      '<img src="a.png" />\n<img src="b.png" />' as unknown as Buffer
+    );
+    const result = await checkMdxAccessibility('/docs');
+    expect(result.totalFiles).toBe(1);
+    expect(result.filesWithIssues).toBe(1);
+    expect(result.missingAltAttributes).toHaveLength(2);
+  });
+});

package/bin/mdxAccessibility.js

@@ -75,7 +75,8 @@ const checkAltAttributes = (filePath, content) => {
         };
     };
     try {
-        coreRemark().use(visitElements).processSync(content);
+        const stripped = content.replace(/^( {0,3}#{1,6}\s+.+?)\s*\{#[^}]+\}\s*$/gm, '$1');
+        coreRemark().use(visitElements).processSync(stripped);
     }
     catch (error) {
         console.warn(`Warning: Could not parse ${filePath}: ${error}`);