Merge branch 'main' into feat-preserve-query-on-redirect

.github/release.yml

@@ -0,0 +1,26 @@
+# .github/release.yml
+
+changelog:
+  exclude:
+    authors:
+      # Ignore the release PR created by github-actions
+      - github-actions
+  categories:
+    - title: Breaking Changes 🍭
+      labels:
+        - "change: breaking"
+    - title: New Features 🎉
+      labels:
+        - "change: feat"
+    - title: Performance 🚀
+      labels:
+        - "change: perf"
+    - title: Bug Fixes 🐞
+      labels:
+        - "change: fix"
+    - title: Document 📖
+      labels:
+        - "change: docs"
+    - title: Other Changes
+      labels:
+        - "*"

.github/renovate.json5

@@ -1,11 +1,13 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": ["config:recommended"],
+  "extends": ["config:recommended", "schedule:weekly"],
   "packageRules": [
     // Use chore as semantic commit type for commit messages
     {
       "matchPackagePatterns": ["*"],
-      "semanticCommitType": "chore"
+      "semanticCommitType": "chore",
+      // always bump package.json
+      "rangeStrategy": "bump"
     },
     {
       "groupName": "rsbuild",
@@ -33,6 +35,8 @@
     // manually updating
     "typescript",
     // align Node.js version minimum requirements
-    "@types/node"
+    "@types/node",
+    "node",
+    "pnpm"
   ]
 }

e2e/fixtures/api-docgen/doc/index.mdx

@@ -0,0 +1,7 @@
+# Hello World
+
+## API
+
+This is API Table
+
+<API moduleName="button" />

e2e/fixtures/api-docgen/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@rspress-fixture/rspress-api-docgen",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "rspress dev",
+    "build": "rspress build",
+    "preview": "rspress preview"
+  },
+  "dependencies": {
+    "@rspress/plugin-api-docgen": "workspace:*",
+    "rspress": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^14"
+  }
+}

e2e/fixtures/api-docgen/rspress.config.ts

@@ -0,0 +1,15 @@
+import path from 'path';
+import { defineConfig } from 'rspress/config';
+import { pluginApiDocgen } from '@rspress/plugin-api-docgen';
+
+export default defineConfig({
+  root: path.join(__dirname, 'doc'),
+  plugins: [
+    pluginApiDocgen({
+      entries: {
+        button: './src/Button.ts',
+      },
+      apiParseTool: 'react-docgen-typescript',
+    }),
+  ],
+});

e2e/fixtures/api-docgen/src/Button.ts

@@ -0,0 +1,15 @@
+export type ButtonProps = {
+  /**
+   * Whether to disable the button
+   * - This is extra line a
+   * - This is extra line b
+   */
+  disabled?: boolean;
+  /**
+   * Type of Button
+   * @default 'default'
+   */
+  size?: 'mini' | 'small' | 'default' | 'large';
+};
+
+export const Button = (props?: ButtonProps) => {};

e2e/fixtures/custom-id/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@rspress-fixture/rspress-custom-id",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "rspress dev",
+    "build": "rspress build",
+    "preview": "rspress preview"
+  },
+  "dependencies": {
+    "rspress": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^14"
+  }
+}

e2e/fixtures/custom-id/rspress.config.ts

@@ -0,0 +1,6 @@
+import * as path from 'path';
+import { defineConfig } from 'rspress/config';
+
+export default defineConfig({
+  root: path.join(__dirname, 'doc'),
+});

e2e/fixtures/custom-id/tsconfig.json

@@ -0,0 +1 @@
+{}

e2e/fixtures/i18n/doc/en/guide/_meta.json

@@ -0,0 +1,14 @@
+[
+  {
+    "type": "dir",
+    "name": "basic",
+    "label": "basic"
+  },
+  {
+    "type": "divider"
+  },
+  {
+    "type": "section-header",
+    "label": "growth"
+  }
+]

e2e/fixtures/i18n/doc/en/guide/quick-start.mdx → e2e/fixtures/i18n/doc/en/guide/basic/quick-start.mdx

@@ -1,5 +1,5 @@
 # Quick Start
 
-[click by absolute path](/guide/install) to go to install
+[click by absolute path](/guide/basic/install) to go to install
 
 [click for relative path](./install) to go to install

e2e/fixtures/i18n/doc/zh/guide/_meta.json

@@ -0,0 +1,14 @@
+[
+  {
+    "type": "dir",
+    "name": "basic",
+    "label": "basic"
+  },
+  {
+    "type": "divider"
+  },
+  {
+    "type": "section-header",
+    "label": "growth"
+  }
+]

e2e/fixtures/i18n/doc/zh/guide/quick-start.mdx → e2e/fixtures/i18n/doc/zh/guide/basic/quick-start.mdx

@@ -1,5 +1,5 @@
 # 快速开始
 
-[点击通过绝对路径](/guide/install) 跳往安装
+[点击通过绝对路径](/guide/basic/install) 跳往安装
 
 [点击通过相对路径](./install) 跳往安装

e2e/fixtures/i18n/i18n.json

@@ -0,0 +1,10 @@
+{
+  "basic": {
+    "zh": "基本",
+    "en": "Basic"
+  },
+  "growth": {
+    "zh": "成长",
+    "en": "Growth"
+  }
+}

e2e/fixtures/i18n/rspress.config.ts

@@ -14,19 +14,6 @@ export default defineConfig({
         lang: 'zh',
         title: '一个很棒的项目',
         description: '一个很棒的项目描述',
-        sidebar: {
-          '/guide/': [
-            {
-              text: '指南',
-              items: [
-                {
-                  text: '快速上手',
-                  link: '/guide/quick-start',
-                },
-              ],
-            },
-          ],
-        },
         // 语言切换按钮的文案
         // Language switch button text
         label: '简体中文',
@@ -35,19 +22,6 @@ export default defineConfig({
         lang: 'en',
         title: 'A awesome project',
         description: 'A awesome project description',
-        sidebar: {
-          '/en/guide/': [
-            {
-              text: 'Guide',
-              items: [
-                {
-                  text: 'Quick Start',
-                  link: '/en/guide/quick-start',
-                },
-              ],
-            },
-          ],
-        },
         label: 'English',
       },
     ],

e2e/fixtures/replace-rules/doc/content.mdx

@@ -0,0 +1 @@
+# content

e2e/fixtures/replace-rules/doc/index.mdx

@@ -0,0 +1,3 @@
+import Content from './content.mdx';
+
+<Content />

e2e/fixtures/replace-rules/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@rspress-fixture/rspress-replace-rules",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "dev": "rspress dev",
+    "build": "rspress build",
+    "preview": "rspress preview"
+  },
+  "dependencies": {
+    "rspress": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "^14"
+  }
+}

e2e/fixtures/replace-rules/rspress.config.ts

@@ -0,0 +1,12 @@
+import * as path from 'path';
+import { defineConfig } from 'rspress/config';
+
+export default defineConfig({
+  root: path.join(__dirname, 'doc'),
+  replaceRules: [
+    {
+      search: /content/g,
+      replace: 'h1',
+    },
+  ],
+});

e2e/fixtures/replace-rules/tsconfig.json

@@ -0,0 +1 @@
+{}

e2e/tests/api-docgen.test.ts

@@ -0,0 +1,50 @@
+import { expect, test } from '@playwright/test';
+import path from 'path';
+import { getPort, killProcess, runDevCommand } from '../utils/runCommands';
+
+const fixtureDir = path.resolve(__dirname, '../fixtures');
+
+test.describe('api-docgen test', async () => {
+  let appPort;
+  let app;
+
+  test.beforeAll(async () => {
+    const appDir = path.join(fixtureDir, 'api-docgen');
+    appPort = await getPort();
+    app = await runDevCommand(appDir, appPort);
+  });
+
+  test.afterAll(async () => {
+    if (app) {
+      await killProcess(app);
+    }
+  });
+
+  test('Index page', async ({ page }) => {
+    await page.goto(`http://localhost:${appPort}`);
+    const table = await page.$('table');
+    const tableContent = await page.evaluate(table => table?.innerHTML, table);
+
+    // Property
+    expect(tableContent).toContain('Property');
+    expect(tableContent).toContain('disabled');
+    expect(tableContent).toContain('size');
+
+    // Description
+    expect(tableContent).toContain('Description');
+    expect(tableContent).toContain('Whether to disable the button');
+    expect(tableContent).toContain('- This is extra line a');
+    expect(tableContent).toContain('- This is extra line b');
+    expect(tableContent).toContain('Type of Button');
+
+    // Type
+    expect(tableContent).toContain('Type');
+    expect(tableContent).toContain('boolean');
+    expect(tableContent).toContain('"mini" | "small" | "default" | "large"');
+
+    // Default Value
+    expect(tableContent).toContain('Default Value');
+    expect(tableContent).toContain('-');
+    expect(tableContent).toContain("'default'");
+  });
+});

e2e/tests/basic.test.ts

@@ -23,7 +23,7 @@ test.describe('basic test', async () => {
     await page.goto(`http://localhost:${appPort}`);
     const h1 = await page.$('h1');
     const text = await page.evaluate(h1 => h1?.textContent, h1);
-    await expect(text).toContain('Hello World');
+    expect(text).toContain('Hello World');
     // expect the .header-anchor to be rendered and take the correct href
     const headerAnchor = await page.$('.header-anchor');
     const href = await page.evaluate(
@@ -33,17 +33,6 @@ test.describe('basic test', async () => {
     expect(href).toBe('#hello-world');
   });
 
-  test('Guide page', async ({ page }) => {
-    await page.goto(`http://localhost:${appPort}/guide`, {
-      waitUntil: 'networkidle',
-    });
-    const h1 = await page.$('h1');
-    const className = await page.evaluate(h1 => h1?.className, h1);
-    expect(className).toContain('title_3b154'); // hash in css module should stable
-    const text = await page.evaluate(h1 => h1?.textContent, h1);
-    expect(text).toContain('Guide');
-  });
-
   test('404 page', async ({ page }) => {
     await page.goto(`http://localhost:${appPort}/404`, {
       waitUntil: 'networkidle',

e2e/tests/custom-id.test.ts

@@ -0,0 +1,33 @@
+import { expect, test } from '@playwright/test';
+import path from 'path';
+import { getPort, killProcess, runDevCommand } from '../utils/runCommands';
+
+const fixtureDir = path.resolve(__dirname, '../fixtures');
+
+test.describe('custom-id test', async () => {
+  let appPort;
+  let app;
+  test.beforeAll(async () => {
+    const appDir = path.join(fixtureDir, 'custom-id');
+    appPort = await getPort();
+    app = await runDevCommand(appDir, appPort);
+  });
+
+  test.afterAll(async () => {
+    if (app) {
+      await killProcess(app);
+    }
+  });
+
+  test('Guide page', async ({ page }) => {
+    await page.goto(`http://localhost:${appPort}/guide`, {
+      waitUntil: 'networkidle',
+    });
+    const h1 = await page.$('h1');
+    const className = await page.evaluate(h1 => h1?.className, h1);
+    expect(className).toContain('title_3b154'); // hash in css module should stable
+    const text = await page.evaluate(h1 => h1?.textContent, h1);
+    expect(text).toContain('Guide');
+  });
+
+});