feat(route): add cleanUrlsRedirect option (#3571)

Author: SoonIter

e2e/fixtures/auto-nav-sidebar/index.test.ts

@@ -18,7 +18,7 @@ test.describe('Auto nav and sidebar test', async () => {
   });
 
   test('Should render nav and sidebar correctly', async ({ page }) => {
-    await page.goto(`http://localhost:${appPort}/guide/`, {
+    await page.goto(`http://localhost:${appPort}/guide/index.html`, {
       waitUntil: 'networkidle',
     });
 
@@ -295,11 +295,11 @@ test.describe('Auto nav and sidebar test', async () => {
   test('Sidebar not have same name md/mdx will not navigate', async ({
     page,
   }) => {
-    await page.goto(`http://localhost:${appPort}/guide/`, {
+    await page.goto(`http://localhost:${appPort}/guide/index.html`, {
       waitUntil: 'networkidle',
     });
     await page.click('.rp-doc-layout__sidebar .rp-sidebar-group');
-    expect(page.url()).toBe(`http://localhost:${appPort}/guide/`);
+    expect(page.url()).toBe(`http://localhost:${appPort}/guide/index.html`);
   });
 
   test('Should load nested subpage API Overview correctly', async ({

e2e/fixtures/clean-urls-redirect/doc/en/folder/index.md

@@ -0,0 +1 @@
+# Folder

e2e/fixtures/clean-urls-redirect/doc/en/guide/start/introduction.md

@@ -0,0 +1 @@
+# Introduction

e2e/fixtures/clean-urls-redirect/doc/en/index.md

@@ -0,0 +1 @@
+# Home

e2e/fixtures/clean-urls-redirect/doc/zh/folder/index.md

@@ -0,0 +1 @@
+# Folder

e2e/fixtures/clean-urls-redirect/doc/zh/guide/start/introduction.md

@@ -0,0 +1 @@
+# Introduction

e2e/fixtures/clean-urls-redirect/doc/zh/index.md

@@ -0,0 +1 @@
+# Home

e2e/fixtures/clean-urls-redirect/index.test.ts

@@ -0,0 +1,109 @@
+import { expect, test } from '@playwright/test';
+import { getPort, killProcess, runDevCommand } from '../../utils/runCommands';
+
+test.describe('route.cleanUrlsRedirect', () => {
+  let cleanUrlApp: Awaited<ReturnType<typeof runDevCommand>>;
+  let cleanUrlPort: number;
+  let disabledApp: Awaited<ReturnType<typeof runDevCommand>>;
+  let disabledPort: number;
+  let htmlUrlApp: Awaited<ReturnType<typeof runDevCommand>>;
+  let htmlUrlPort: number;
+
+  test.beforeAll(async () => {
+    const appDir = import.meta.dirname;
+
+    htmlUrlPort = await getPort();
+    htmlUrlApp = await runDevCommand(appDir, htmlUrlPort);
+
+    cleanUrlPort = await getPort();
+    cleanUrlApp = await runDevCommand(
+      appDir,
+      cleanUrlPort,
+      'rspress.clean-urls.config.ts',
+    );
+
+    disabledPort = await getPort();
+    disabledApp = await runDevCommand(
+      appDir,
+      disabledPort,
+      'rspress.disabled.config.ts',
+    );
+  });
+
+  test.afterAll(async () => {
+    await Promise.all([
+      killProcess(htmlUrlApp),
+      killProcess(cleanUrlApp),
+      killProcess(disabledApp),
+    ]);
+  });
+
+  test('normalizes matched routes when cleanUrls is false', async ({
+    page,
+  }) => {
+    const cases = [
+      [
+        '/docs/zh/guide/start/introduction',
+        '/docs/zh/guide/start/introduction.html',
+      ],
+      [
+        '/docs/zh/guide/start/introduction/',
+        '/docs/zh/guide/start/introduction.html',
+      ],
+      [
+        '/docs/zh/guide/start/introduction/index.html',
+        '/docs/zh/guide/start/introduction.html',
+      ],
+      ['/docs/zh/folder/', '/docs/zh/folder/index.html'],
+    ] as const;
+
+    for (const [incomingUrl, expectedUrl] of cases) {
+      await page.goto(`http://localhost:${htmlUrlPort}${incomingUrl}`, {
+        waitUntil: 'networkidle',
+      });
+      await expect(page).toHaveURL(
+        `http://localhost:${htmlUrlPort}${expectedUrl}`,
+      );
+      await expect(page.locator('.rspress-doc')).toBeVisible();
+    }
+  });
+
+  test('normalizes matched routes when cleanUrls is true', async ({ page }) => {
+    const cases = [
+      [
+        '/docs/zh/guide/start/introduction.html',
+        '/docs/zh/guide/start/introduction',
+      ],
+      [
+        '/docs/zh/guide/start/introduction/',
+        '/docs/zh/guide/start/introduction',
+      ],
+      [
+        '/docs/zh/guide/start/introduction/index.html',
+        '/docs/zh/guide/start/introduction',
+      ],
+      ['/docs/zh/folder/index.html', '/docs/zh/folder/'],
+    ] as const;
+
+    for (const [incomingUrl, expectedUrl] of cases) {
+      await page.goto(`http://localhost:${cleanUrlPort}${incomingUrl}`, {
+        waitUntil: 'networkidle',
+      });
+      await expect(page).toHaveURL(
+        `http://localhost:${cleanUrlPort}${expectedUrl}`,
+      );
+      await expect(page.locator('.rspress-doc')).toBeVisible();
+    }
+  });
+
+  test('does not normalize matched routes when disabled', async ({ page }) => {
+    const pathname = '/docs/zh/guide/start/introduction.html';
+
+    await page.goto(`http://localhost:${disabledPort}${pathname}`, {
+      waitUntil: 'networkidle',
+    });
+
+    await expect(page).toHaveURL(`http://localhost:${disabledPort}${pathname}`);
+    await expect(page.locator('.rspress-doc')).toBeVisible();
+  });
+});

e2e/fixtures/clean-urls-redirect/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@rspress-fixture/clean-urls-redirect",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "rspress build",
+    "dev": "rspress dev",
+    "preview": "rspress preview"
+  },
+  "dependencies": {
+    "@rspress/core": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^22.8.1"
+  }
+}

e2e/fixtures/clean-urls-redirect/rspress.clean-urls.config.ts

@@ -0,0 +1,13 @@
+import * as path from 'node:path';
+import { defineConfig } from '@rspress/core';
+
+export default defineConfig({
+  root: path.join(import.meta.dirname, 'doc'),
+  base: '/docs/',
+  lang: 'en',
+  locales: [{ lang: 'en' }, { lang: 'zh' }],
+  route: {
+    cleanUrls: true,
+    localeRedirect: 'never',
+  },
+});