remove remarkLinkRewriteOptions from buildDynamicMDX (shuding#1906)

filiphuhta · May 25, 2023 · 891972f · 891972f
1 parent 093afbd
commit 891972f
Show file tree

Hide file tree

Showing 8 changed files with 140 additions and 97 deletions.
diff --git a/.changeset/tame-pandas-exist.md b/.changeset/tame-pandas-exist.md
@@ -0,0 +1,5 @@
+---
+'nextra': patch
+---
+
+remove `remarkLinkRewriteOptions` from `buildDynamicMDX`
diff --git a/examples/swr-site/pages/remote/graphql-eslint/[[...slug]].mdx b/examples/swr-site/pages/remote/graphql-eslint/[[...slug]].mdx
@@ -1,11 +1,12 @@
 import fs from 'fs/promises'
-import { buildDynamicMDX, buildDynamicMeta } from 'nextra/remote'
-import { RemoteContent } from 'nextra/data'
-import { Callout } from 'nextra/components'
 import {
   findPathWithExtension,
   findStaticPaths
 } from '@components/remote-utils'
+import { Callout } from 'nextra/components'
+import { RemoteContent } from 'nextra/data'
+import { remarkLinkRewrite } from 'nextra/mdx-plugins'
+import { buildDynamicMDX, buildDynamicMeta } from 'nextra/remote'
 
 export const getStaticProps = async ({ params }) => {
   const filePath = await findPathWithExtension({
@@ -18,9 +19,16 @@ export const getStaticProps = async ({ params }) => {
     props: {
       ...(await buildDynamicMDX(content, {
         defaultShowCopyCode: true,
-        remarkLinkRewriteOptions: {
-          pattern: /^\/docs(\/.*)?$/,
-          replace: '/docs/2.0.0$1'
+        mdxOptions: {
+          remarkPlugins: [
+            [
+              remarkLinkRewrite,
+              {
+                pattern: /^\/docs(\/.*)?$/,
+                replace: '/docs/2.0.0$1'
+              }
+            ]
+          ]
         }
       })),
       ...(await buildDynamicMeta())

diff --git a/examples/swr-site/pages/remote/graphql-yoga/[[...slug]].mdx b/examples/swr-site/pages/remote/graphql-yoga/[[...slug]].mdx
@@ -5,6 +5,7 @@ import {
 } from '@components/remote-utils'
 import { Callout, Tab, Tabs } from 'nextra-theme-docs'
 import { RemoteContent } from 'nextra/data'
+import { remarkLinkRewrite } from 'nextra/mdx-plugins'
 import { buildDynamicMDX, buildDynamicMeta } from 'nextra/remote'
 
 export const getStaticProps = async ({ params }) => {
@@ -18,9 +19,16 @@ export const getStaticProps = async ({ params }) => {
     props: {
       ...(await buildDynamicMDX(content, {
         defaultShowCopyCode: true,
-        remarkLinkRewriteOptions: {
-          pattern: /^\/docs(\/.*)?$/,
-          replace: '/docs/3.0.0$1'
+        mdxOptions: {
+          remarkPlugins: [
+            [
+              remarkLinkRewrite,
+              {
+                pattern: /^\/docs(\/.*)?$/,
+                replace: '/docs/3.0.0$1'
+              }
+            ]
+          ]
         }
       })),
       ...(await buildDynamicMeta())

diff --git a/package.json b/package.json
@@ -48,7 +48,7 @@
       "vitest": "^0.27.1",
       "react": "^18.2.0",
       "react-dom": "^18.2.0",
-      "@mdx-js/react": "^2.2.1",
+      "@mdx-js/react": "^2.3.0",
       "next-themes": "^0.2.1",
       "next": "^13.3.1",
       "@types/react": "^18.0.15",

diff --git a/packages/nextra/package.json b/packages/nextra/package.json
@@ -37,6 +37,10 @@
       "import": "./dist/components/index.js",
       "types": "./dist/components/index.d.ts"
     },
+    "./mdx-plugins": {
+      "import": "./dist/mdx-plugins/index.mjs",
+      "types": "./dist/mdx-plugins/index.d.ts"
+    },
     "./hooks": {
       "import": "./dist/hooks/index.js",
       "types": "./dist/hooks/index.d.ts"
@@ -91,6 +95,9 @@
       ],
       "normalize-pages": [
         "./dist/normalize-pages.d.ts"
+      ],
+      "mdx-plugins": [
+        "./dist/mdx-plugins/index.d.ts"
       ]
     }
   },
@@ -120,13 +127,13 @@
     "@napi-rs/simple-git": "^0.1.8",
     "clsx": "^1.2.1",
     "github-slugger": "^2.0.0",
-    "graceful-fs": "^4.2.10",
+    "graceful-fs": "^4.2.11",
     "gray-matter": "^4.0.3",
-    "katex": "^0.16.4",
+    "katex": "^0.16.7",
     "lodash.get": "^4.4.2",
     "next-mdx-remote": "^4.2.1",
     "p-limit": "^3.1.0",
-    "rehype-katex": "^6.0.2",
+    "rehype-katex": "^6.0.3",
     "rehype-pretty-code": "0.9.4",
     "remark-gfm": "^3.0.1",
     "remark-math": "^5.1.1",

diff --git a/packages/nextra/src/compile.ts b/packages/nextra/src/compile.ts
@@ -66,6 +66,10 @@ const cachedCompilerForFormat: Record<
 type MdxOptions = LoaderOptions['mdxOptions'] &
   Pick<ProcessorOptions, 'jsx' | 'outputFormat'>
 
+// @ts-expect-error -- Without bind is unable to use `remarkLinkRewrite` with `buildDynamicMDX`
+// because we already use `remarkLinkRewrite` function to remove .mdx? extensions
+const clonedRemarkLinkRewrite = remarkLinkRewrite.bind(null)
+
 export async function compileMdx(
   source: string,
   loaderOptions: Pick<
@@ -153,7 +157,7 @@ export async function compileMdx(
         isFileOutsideCWD && remarkReplaceImports,
         // Remove the markdown file extension from links
         [
-          remarkLinkRewrite,
+          clonedRemarkLinkRewrite,
           {
             pattern: MARKDOWN_URL_EXTENSION_REGEX,
             replace: '',

diff --git a/packages/nextra/src/remote.ts b/packages/nextra/src/remote.ts
@@ -1,28 +1,33 @@
 import { compileMdx } from './compile'
-import type { RemarkLinkRewriteOptions } from './mdx-plugins'
-import { remarkLinkRewrite } from './mdx-plugins'
-import { truthy } from './utils'
 
-export const buildDynamicMDX = async (
+export async function buildDynamicMDX(
   content: string,
-  {
-    remarkLinkRewriteOptions,
-    ...loaderOptions
-  }: Parameters<typeof compileMdx>[1] & {
-    remarkLinkRewriteOptions?: RemarkLinkRewriteOptions
-  } = {}
-) => {
-  const { result, headings, frontMatter, title } = await compileMdx(content, {
-    ...loaderOptions,
-    mdxOptions: {
-      ...loaderOptions.mdxOptions,
-      remarkPlugins: [
-        ...(loaderOptions.mdxOptions?.remarkPlugins || []),
-        remarkLinkRewriteOptions &&
-          ([remarkLinkRewrite, remarkLinkRewriteOptions] as any)
-      ].filter(truthy)
-    }
-  })
+  loaderOptions: Parameters<typeof compileMdx>[1]
+) {
+  if (loaderOptions && 'remarkLinkRewriteOptions' in loaderOptions) {
+    throw new Error(`\`remarkLinkRewriteOptions\` was removed. For overriding internal links use \`remarkLinkRewrite\` instead.
+
+import { remarkLinkRewrite } from 'nextra/mdx-plugins'
+
+// ...
+
+const result = await buildDynamicMDX(rawMdx, {
+  mdxOptions: {
+    remarkPlugins: [
+      [remarkLinkRewrite, {
+        pattern: /^\\/docs(\\/.*)?$/,
+        replace: '/docs/2.0.0$1'
+      }]
+    ]
+  }
+})
+`)
+  }
+
+  const { result, headings, frontMatter, title } = await compileMdx(
+    content,
+    loaderOptions
+  )
 
   return {
     __nextra_dynamic_mdx: result,
@@ -34,8 +39,8 @@ export const buildDynamicMDX = async (
   }
 }
 
-export const buildDynamicMeta = async () => {
-  const resolvePageMap = (globalThis as any).__nextra_resolvePageMap
+export async function buildDynamicMeta() {
+  const resolvePageMap = globalThis.__nextra_resolvePageMap
   if (resolvePageMap) {
     return {
       __nextra_pageMap: await resolvePageMap()