test: use Rstest as Rspress's test framework

.github/workflows/test-Windows.yml

@@ -1,4 +1,4 @@
-name: Test (vitest & playwright - Windows)
+name: Test (Windows)
 
 concurrency:
   group: windows-test-${{ github.head_ref }}

.github/workflows/test-macOS.yml

@@ -1,4 +1,4 @@
-name: Test (vitest & playwright - macOS)
+name: Test (macOS)
 
 concurrency:
   group: macos-test-${{ github.head_ref }}

AGENTS.md

@@ -23,7 +23,7 @@
 
 ## Testing guidelines
 
-- Unit: `vitest`; E2E: `@playwright/test`.
+- Unit: `rstest`; E2E: `@playwright/test`.
 - Naming: `*.test.ts`/`*.test.tsx`; snapshots in `__snapshots__/`.
 - Placement: unit under `packages/*/tests`; e2e under `e2e/`.
 

package.json

@@ -17,7 +17,7 @@
     "preview:website": "cd website && npm run preview",
     "test": "pnpm test:unit && pnpm test:e2e",
     "test:e2e": "playwright test",
-    "test:unit": "vitest run",
+    "test:unit": "rstest run",
     "update:rsbuild": "npx taze minor --include /rsbuild/ -w -r -l"
   },
   "lint-staged": {
@@ -35,6 +35,7 @@
     "@changesets/cli": "^2.29.7",
     "@playwright/test": "1.56.1",
     "@rspress/config": "workspace:*",
+    "@rstest/core": "https://pkg.pr.new/web-infra-dev/rstest/@rstest/core@375186a",
     "@types/cross-spawn": "^6.0.6",
     "@types/node": "^22.8.1",
     "check-dependency-version-consistency": "^5.0.1",
@@ -52,7 +53,6 @@
     "prettier": "3.6.2",
     "prettier-plugin-packagejson": "^2.5.19",
     "tree-kill": "^1.2.2",
-    "vitest": "2.1.9",
     "zx": "^8.8.5"
   },
   "packageManager": "[email protected]",

packages/core/src/node/auto-nav-sidebar/locales.test.ts

@@ -1,5 +1,5 @@
 import path from 'node:path';
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it } from '@rstest/core';
 import {
   getRoutePathParts,
   normalizeRoutePath,

packages/core/src/node/auto-nav-sidebar/walk.test.ts

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import { DEFAULT_PAGE_EXTENSIONS } from '@rspress/shared/constants';
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it } from '@rstest/core';
 import {
   getRoutePathParts,
   normalizeRoutePath,

packages/core/src/node/mdx/rehypePlugins/__snapshots__/headerAnchor.test.ts.snap

@@ -1,4 +1,4 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+// Rstest Snapshot v1
 
 exports[`rehypeHeadAnchor > basic 1`] = `
 "/*prettier-ignore-start*/

packages/core/src/node/mdx/rehypePlugins/headerAnchor.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it } from '@rstest/core';
 import { compile } from '../processor';
 
 describe('rehypeHeadAnchor', () => {

packages/core/src/node/mdx/remarkPlugins/__snapshots__/containerSyntax.test.ts.snap

@@ -1,4 +1,4 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+// Rstest Snapshot v1
 
 exports[`remark-container > Has space before ::: 1`] = `
 "import {jsx as _jsx} from "react/jsx-runtime";

packages/core/src/node/mdx/remarkPlugins/__snapshots__/fileCodeBlock.test.ts.snap

@@ -1,4 +1,4 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+// Rstest Snapshot v1
 
 exports[`remarkFileCodeBlock > basic 1`] = `
 "import {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from "react/jsx-runtime";

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

@@ -1,4 +1,4 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+// Rstest Snapshot v1
 
 exports[`mdx > basic 1`] = `
 "import {Fragment as _Fragment, jsx as _jsx, jsxs as _jsxs} from "react/jsx-runtime";

packages/core/src/node/mdx/remarkPlugins/__snapshots__/link.test.ts.snap

@@ -1,4 +1,4 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+// Rstest Snapshot v1
 
 exports[`mdx > basic 1`] = `
 "/*jsx link will not be transformed*/

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

@@ -1,4 +1,4 @@
-import { describe, expect, test } from 'vitest';
+import { describe, expect, test } from '@rstest/core';
 import { compile } from '../processor';
 
 describe('remark-container', async () => {

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

@@ -1,9 +1,8 @@
+import { describe, expect, it, rs } from '@rstest/core';
 import { fs, vol } from 'memfs';
-
-import { describe, expect, it, vi } from 'vitest';
 import { compile } from '../processor';
 
-vi.mock('node:fs/promises', () => {
+rs.mock('node:fs/promises', () => {
   return { readFile: fs.promises.readFile };
 });
 
@@ -25,7 +24,7 @@ describe('remarkFileCodeBlock', () => {
       filepath: '/usr/rspress-project/docs/index.mdx',
       config: null,
       pluginDriver: null,
-      routeService: null,
+      routeSerrsce: null,
     });
     expect(result).toMatchSnapshot();
   });

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

@@ -1,4 +1,4 @@
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it } from '@rstest/core';
 import { compile } from '../processor';
 
 describe('mdx', () => {

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

@@ -1,4 +1,4 @@
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it } from '@rstest/core';
 import { compile } from '../processor';
 
 describe('mdx', () => {

packages/core/src/node/route/RouteService.test.ts

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import type { UserConfig } from '@rspress/shared';
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it } from '@rstest/core';
 import { RouteService } from './RouteService';
 
 const BASIC_DIR = path.join(__dirname, 'fixtures', 'basic');

packages/core/src/node/route/extractPageData.test.ts

@@ -1,5 +1,5 @@
 import { join } from 'node:path';
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it } from '@rstest/core';
 import { extractPageData, getPageIndexInfoByRoute } from './extractPageData';
 import type { RouteService } from './RouteService';
 

packages/core/src/node/route/normalizeRoutePath.test.ts

@@ -1,4 +1,4 @@
-import { expect, test } from 'vitest';
+import { expect, test } from '@rstest/core';
 import { getRoutePathParts, normalizeRoutePath } from './normalizeRoutePath';
 
 test('getRoutePathParts', () => {

packages/core/src/node/utils/checkLanguageParity.test.ts

@@ -1,25 +1,25 @@
 import type { UserConfig } from '@rspress/shared';
 import { logger } from '@rspress/shared/logger';
+import { beforeEach, describe, expect, it, rs } from '@rstest/core';
 import { fs, vol } from 'memfs';
-import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { checkLanguageParity } from './checkLanguageParity';
 
-vi.mock('node:fs/promises', () => {
+rs.mock('node:fs/promises', () => {
   return { default: fs.promises };
 });
-vi.mock('@rspress/shared/logger', () => ({
+rs.mock('@rspress/shared/logger', () => ({
   logger: {
-    info: vi.fn(),
-    warn: vi.fn(),
-    error: vi.fn(),
-    success: vi.fn(),
+    info: rs.fn(),
+    warn: rs.fn(),
+    error: rs.fn(),
+    success: rs.fn(),
   },
 }));
 
 describe('checkLanguageParity', () => {
   beforeEach(() => {
     vol.reset();
-    vi.clearAllMocks();
+    rs.clearAllMocks();
   });
 
   // base config

packages/core/src/node/utils/flattenMdxContent.ts

@@ -73,7 +73,7 @@ export async function flattenMdxContent(
   let result = content;
 
   try {
-    ast = processor.parse(content);
+    ast = processor.parse(content) as Root;
   } catch (e) {
     // Fallback: if mdx parse failed, just return the content
     logger.debug('flattenMdxContent parse failed: \n', e);

packages/core/tests/cli/hint.test.ts

@@ -1,17 +1,17 @@
 import { logger } from '@rspress/shared/logger';
+import { describe, expect, it, rs } from '@rstest/core';
 import { fs, vol } from 'memfs';
-import { describe, expect, it, vi } from 'vitest';
 import { hintThemeBreakingChange } from '../../src/node/logger/hint';
 
-vi.mock('node:fs/promises', () => {
+rs.mock('node:fs/promises', () => {
   return { default: fs.promises, ...fs.promises };
 });
-vi.mock('@rspress/shared/logger', () => ({
+rs.mock('@rspress/shared/logger', () => ({
   logger: {
-    info: vi.fn(),
-    warn: vi.fn(),
-    error: vi.fn(),
-    success: vi.fn(),
+    info: rs.fn(),
+    warn: rs.fn(),
+    error: rs.fn(),
+    success: rs.fn(),
   },
 }));
 

packages/core/tests/config/config-basic.test.ts

@@ -1,5 +1,5 @@
 import path from 'node:path';
-import { describe, expect, test } from 'vitest';
+import { describe, expect, test } from '@rstest/core';
 import { loadConfigFile } from '../../src/cli/config/loadConfigFile';
 import { normalizePath } from '../../src/node/utils/normalizePath';
 

packages/plugin-algolia/tests/locales.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from 'vitest';
+import { describe, expect, test } from '@rstest/core';
 import { ZH_LOCALES } from '../src/runtime/locales';
 
 describe('Docsearch v4 Locales', () => {

packages/runtime/src/getSidebarDataGroup.test.ts

@@ -1,20 +1,20 @@
-import { describe, expect, it, vi } from 'vitest';
+import { describe, expect, it, rs } from '@rstest/core';
 import { getSidebarDataGroup } from './hooks/useSidebar';
 import { isActive } from './route';
 
-vi.mock('virtual-i18n-text', () => {
+rs.mock('virtual-i18n-text', () => {
   return { default: {} };
 });
 
-vi.mock('virtual-site-data', () => {
+rs.mock('virtual-site-data', () => {
   return {
     default: {
       base: '/',
     },
   };
 });
 
-vi.mock('virtual-routes', () => {
+rs.mock('virtual-routes', () => {
   return { routes: [] };
 });
 

packages/runtime/src/route.test.ts

@@ -1,8 +1,8 @@
-import { describe, expect, it, vi } from 'vitest';
+import { describe, expect, it, rs } from '@rstest/core';
 import { isActive, matchPath, pathnameToRouteService } from './route';
 
-vi.mock('virtual-routes', () => {
-  const element = vi.fn();
+rs.mock('virtual-routes', () => {
+  const element = rs.fn();
   const routes = [
     {
       path: '/api/config',

packages/shared/src/runtime-utils/utils.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from 'vitest';
+import { describe, expect, test } from '@rstest/core';
 import {
   normalizeHref,
   normalizePosixPath,

packages/theme-default/src/components/Search/logic/util.test.ts

@@ -1,5 +1,5 @@
 import type { Header } from '@rspress/shared';
-import { describe, expect, test } from 'vitest';
+import { describe, expect, test } from '@rstest/core';
 import { backTrackHeaders } from './util';
 
 describe('utils logic', () => {