feat(mdx/image): Add dead image detection

packages/core/src/node/mdx/options.ts

@@ -97,7 +97,20 @@ export async function createMDXOptions(options: {
               remarkLinkOptions,
             },
       ],
-      remarkImage,
+      [
+        remarkImage,
+        isSsgMd
+          ? {
+              docDirectory,
+              remarkImageOptions: {
+                checkDeadImages: false,
+              },
+            }
+          : {
+              docDirectory,
+              remarkImageOptions: config?.markdown?.image,
+            },
+      ],
       isSsgMd && [
         remarkSplitMdx,
         typeof config?.llms === 'object'

packages/core/src/node/mdx/remarkPlugins/image.test.ts

@@ -1,4 +1,7 @@
-import { describe, expect, it } from '@rstest/core';
+import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import path from 'node:path';
+import { afterAll, beforeAll, describe, expect, it } from '@rstest/core';
 import { compile } from '../processor';
 
 describe('mdx', () => {
@@ -19,3 +22,84 @@ describe('mdx', () => {
     expect(result).toMatchSnapshot();
   });
 });
+
+describe('checkDeadImages', () => {
+  let docDir: string;
+  let origNodeEnv: string | undefined;
+
+  beforeAll(() => {
+    docDir = mkdtempSync(path.join(tmpdir(), 'rspress-test-'));
+    mkdirSync(path.join(docDir, 'public'), { recursive: true });
+    writeFileSync(path.join(docDir, 'existing.png'), '');
+    writeFileSync(path.join(docDir, 'public', 'logo.png'), '');
+    origNodeEnv = process.env.NODE_ENV;
+    process.env.NODE_ENV = 'production';
+  });
+
+  afterAll(() => {
+    process.env.NODE_ENV = origNodeEnv;
+    rmSync(docDir, { recursive: true });
+  });
+
+  it('existing absolute image', async () => {
+    const result = await compile({
+      source: '![alt](/logo.png)',
+      docDirectory: docDir,
+      filepath: path.join(docDir, 'index.mdx'),
+      config: null,
+      pluginDriver: null,
+      routeService: null,
+    });
+    expect(result).toBeDefined();
+  });
+
+  it('missing absolute image', async () => {
+    await expect(
+      compile({
+        source: '![alt](/missing.png)',
+        docDirectory: docDir,
+        filepath: path.join(docDir, 'index.mdx'),
+        config: null,
+        pluginDriver: null,
+        routeService: null,
+      }),
+    ).rejects.toThrow('Dead image found');
+  });
+
+  it('existing relative image', async () => {
+    const result = await compile({
+      source: '![alt](./existing.png)',
+      docDirectory: docDir,
+      filepath: path.join(docDir, 'index.mdx'),
+      config: null,
+      pluginDriver: null,
+      routeService: null,
+    });
+    expect(result).toBeDefined();
+  });
+
+  it('missing relative image', async () => {
+    await expect(
+      compile({
+        source: '![alt](./missing.png)',
+        docDirectory: docDir,
+        filepath: path.join(docDir, 'index.mdx'),
+        config: null,
+        pluginDriver: null,
+        routeService: null,
+      }),
+    ).rejects.toThrow('Dead image found');
+  });
+
+  it('external image', async () => {
+    const result = await compile({
+      source: '![alt](https://example.com/image.png)',
+      docDirectory: docDir,
+      filepath: path.join(docDir, 'index.mdx'),
+      config: null,
+      pluginDriver: null,
+      routeService: null,
+    });
+    expect(result).toBeDefined();
+  });
+});