feat!: migrate to rspress v2 (#28)

Author: JounQin

.changeset/pre.json

@@ -0,0 +1,8 @@
+{
+  "mode": "pre",
+  "tag": "next",
+  "initialVersions": {
+    "@alauda/doom": "0.23.5"
+  },
+  "changesets": []
+}

.changeset/rotten-cows-cough.md

@@ -0,0 +1,5 @@
+---
+"@alauda/doom": major
+---
+
+feat!: migrate to rspress v2

package.json

@@ -56,25 +56,26 @@
     "version": "changeset version && yarn --no-immutable"
   },
   "dependencies": {
-    "@cspell/eslint-plugin": "^9.0.1",
+    "@cspell/eslint-plugin": "^9.0.2",
     "@eslint-react/eslint-plugin": "^1.49.0",
     "@inquirer/prompts": "^7.5.1",
     "@openapi-contrib/openapi-schema-to-json-schema": "^5.1.0",
     "@playwright/browser-chromium": "^1.52.0",
+    "@rsbuild/plugin-sass": "^1.3.1",
     "@rsbuild/plugin-yaml": "^1.0.2",
-    "@rspress/core": "1.44.0",
+    "@rspress/core": "2.0.0-beta.6",
     "@shikijs/transformers": "^3.4.2",
     "chokidar": "^4.0.3",
     "cli-progress": "^3.12.0",
     "clsx": "^2.1.1",
-    "commander": "^13.1.0",
+    "commander": "^14.0.0",
     "ejs": "^3.1.10",
-    "es-toolkit": "^1.37.2",
-    "eslint": "^9.26.0",
+    "es-toolkit": "^1.38.0",
+    "eslint": "^9.27.0",
     "eslint-plugin-mdx": "^3.4.2",
     "html-tag-names": "^2.1.0",
-    "mdast-util-mdx": "^2.0.1",
-    "mdast-util-mdx-jsx": "^2.1.4",
+    "mdast-util-mdx": "^3.0.0",
+    "mdast-util-mdx-jsx": "^3.2.0",
     "mermaid": "^11.6.0",
     "openai": "^5.0.0-beta.0",
     "openapi-types": "^12.1.3",
@@ -83,13 +84,13 @@
     "pdf-merger-js": "^5.1.2",
     "picomatch": "^4.0.2",
     "playwright": "^1.52.0",
-    "react-markdown": "^8.0.7",
-    "rehype-raw": "^6.1.1",
-    "remark-directive": "^2.0.1",
-    "remark-frontmatter": "^4.0.1",
-    "remark-gfm": "^3.0.1",
-    "remark-mdx": "^2.3.0",
-    "remark-stringify": "^10.0.3",
+    "react-markdown": "^10.1.0",
+    "rehype-raw": "^7.0.0",
+    "remark-directive": "^4.0.0",
+    "remark-frontmatter": "^5.0.0",
+    "remark-gfm": "^4.0.1",
+    "remark-mdx": "^3.1.0",
+    "remark-stringify": "^11.0.0",
     "shiki": "^3.4.2",
     "simple-git": "^3.27.0",
     "swagger2openapi": "^7.0.8",
@@ -103,23 +104,23 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.1",
     "@changesets/cli": "^2.29.4",
-    "@eslint/js": "^9.26.0",
+    "@eslint/js": "^9.27.0",
     "@swc-node/register": "^1.10.10",
     "@swc/core": "1.11.24",
     "@total-typescript/ts-reset": "^0.6.1",
     "@types/cli-progress": "^3.11.6",
     "@types/ejs": "^3.1.5",
-    "@types/node": "^18.19.100",
+    "@types/node": "^22.15.21",
     "@types/picomatch": "^4.0.0",
-    "@types/react": "^18.3.21",
-    "@types/react-dom": "^18.3.7",
+    "@types/react": "^19.1.4",
+    "@types/react-dom": "^19.1.5",
     "@types/swagger2openapi": "^7.0.4",
     "@unts/patch-package": "^8.1.1",
     "clean-pkg-json": "^1.3.0",
-    "eslint-import-resolver-typescript": "^4.3.4",
-    "eslint-plugin-import-x": "^4.11.1",
+    "eslint-import-resolver-typescript": "^4.3.5",
+    "eslint-plugin-import-x": "^4.12.2",
     "nano-staged": "^0.8.0",
-    "npm-run-all2": "^7.0.2",
+    "npm-run-all2": "^8.0.3",
     "prettier": "^3.5.3",
     "prettier-plugin-pkg": "^0.19.1",
     "prettier-plugin-properties": "^0.3.0",

patches/unist-util-visit-parents+5.1.3.patch

@@ -220,7 +220,6 @@ program
     const runBuild = () =>
       build({
         config,
-        appDirectory: CWD,
         docDirectory,
       })
 

src/cli/index.ts

@@ -2,6 +2,7 @@ import fs from 'node:fs/promises'
 import path from 'node:path'
 
 import { nodeTypes } from '@mdx-js/mdx'
+import { pluginSass } from '@rsbuild/plugin-sass'
 import { pluginYaml } from '@rsbuild/plugin-yaml'
 import {
   addLeadingSlash,
@@ -36,7 +37,6 @@ import {
   mermaidPlugin,
   permissionPlugin,
   replacePlugin,
-  shikiPlugin,
 } from '../plugins/index.js'
 import {
   isExplicitlyUnversioned,
@@ -225,12 +225,23 @@ const getCommonConfig = async ({
     },
     markdown: {
       checkDeadLinks: true,
-      highlightLanguages: [['jsonc', 'json']],
-      mdxRs: false,
       rehypePlugins: [[rehypeRaw, { passThrough: nodeTypes }]],
-    },
-    ssg: {
-      strict: true,
+      shiki: {
+        transformers: [
+          // builtin transformers
+          transformerMetaHighlight(),
+          transformerMetaWordHighlight(),
+          transformerNotationDiff(),
+          transformerNotationErrorLevel(),
+          transformerNotationFocus(),
+          transformerNotationHighlight(),
+          transformerNotationWordHighlight(),
+          transformerRemoveNotationEscape(),
+
+          // custom transformers
+          createTransformerCallouts(),
+        ],
+      },
     },
     themeConfig: {
       enableScrollToTop: true,
@@ -263,43 +274,12 @@ const getCommonConfig = async ({
         localBasePath,
         force,
       }),
-      shikiPlugin({
-        theme: config.shiki?.theme,
-        langs: [
-          'dockerfile',
-          'dotenv',
-          'html',
-          'go',
-          'jsonc',
-          'mermaid',
-          'java',
-          'python',
-          'toml',
-          ...(config.shiki?.langs ?? []),
-        ],
-        transformers: [
-          // builtin transformers
-          transformerMetaHighlight(),
-          transformerMetaWordHighlight(),
-          transformerNotationDiff(),
-          transformerNotationErrorLevel(),
-          transformerNotationFocus(),
-          transformerNotationHighlight(),
-          transformerNotationWordHighlight(),
-          transformerRemoveNotationEscape(),
-
-          // custom transformers
-          createTransformerCallouts(),
-
-          ...(config.shiki?.transformers ?? []),
-        ],
-      }),
     ],
     builderConfig: {
       dev: {
         lazyCompilation: lazy,
       },
-      plugins: [pluginYaml()],
+      plugins: [pluginSass(), pluginYaml()],
       server: {
         open,
       },

src/cli/load-config.ts

@@ -32,7 +32,7 @@ export const remarkAutoToc: Plugin<[], Root> = function () {
           {
             type: 'mdxJsxAttribute',
             name: 'className',
-            value: 'doom-auto-toc',
+            value: 'doom-auto-toc rspress-toc-exclude',
           },
         ],
         children: [

src/plugins/auto-toc/remark-auto-toc.ts

@@ -17,6 +17,18 @@ export * from './normalize-img-src.js'
 export type * from './types.js'
 export * from './utils.js'
 
+declare module 'unified' {
+  interface Data {
+    pageMeta: Record<string, unknown>
+  }
+}
+
+declare module 'mdast' {
+  interface Data {
+    _mdxExplicitJsx?: boolean
+  }
+}
+
 export const replacePlugin = ({
   lang,
   localBasePath,

src/plugins/replace/index.ts

@@ -3,7 +3,7 @@ import path from 'node:path'
 
 import { isExternalUrl, removeLeadingSlash } from '@rspress/core'
 import { cloneDeep } from 'es-toolkit'
-import type { Content } from 'mdast'
+import type { RootContent } from 'mdast'
 import type { MdxJsxFlowElement, MdxJsxTextElement } from 'mdast-util-mdx-jsx'
 import { visit } from 'unist-util-visit'
 
@@ -25,7 +25,7 @@ export interface NormalizeImgSrcOptions {
 }
 
 export const normalizeImgSrc = (
-  content: Content,
+  content: RootContent,
   {
     refSource,
     localPublicBase,

src/plugins/replace/normalize-img-src.ts

@@ -48,7 +48,7 @@ export const rehypeNormalizeLink: Plugin<[], Root> = () => {
         return
       }
 
-      const { alt, src } = node.properties || {}
+      const { alt, src } = node.properties
 
       if (typeof src !== 'string') {
         return