Upgrade Docusaurus - enable Docusaurus Faster (#385)

- Upgrade website to Docusaurus v3.6 - Make this plugin compatible with Docusaurus Faster - Keep retro-compatibility with lower versions --------- Co-authored-by: Rohit Gohri <[email protected]>
rohit-gohri · Nov 8, 2024 · a986be6 · a986be6
1 parent ec090ef
commit a986be6
Show file tree

Hide file tree

Showing 19 changed files with 2,373 additions and 437 deletions.
diff --git a/.changeset/small-ligers-doubt.md b/.changeset/small-ligers-doubt.md
@@ -0,0 +1,6 @@
+---
+"docusaurus-theme-redoc": minor
+"redocusaurus": patch
+---
+
+Upgrade Docusaurus - add support for Docusaurus Faster (RsPack)
diff --git a/.gitignore b/.gitignore
@@ -139,3 +139,5 @@ static/openapi
 .pnp.*
 
 website/version.json
+
+.idea
diff --git a/packages/docusaurus-plugin-redoc/package.json b/packages/docusaurus-plugin-redoc/package.json
@@ -33,8 +33,8 @@
     "redoc": "2.1.5"
   },
   "devDependencies": {
-    "@docusaurus/types": "^3.4.0",
-    "@docusaurus/utils": "^3.4.0",
+    "@docusaurus/types": "^3.6.0",
+    "@docusaurus/utils": "^3.6.0",
     "core-js": "^3.36.0",
     "mobx": "^6.12.4",
     "react": "^18.3.1",

diff --git a/packages/docusaurus-theme-redoc/package.json b/packages/docusaurus-theme-redoc/package.json
@@ -42,10 +42,10 @@
     "styled-components": "^6.1.11"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.4.0",
-    "@docusaurus/theme-classic": "^3.4.0",
-    "@docusaurus/theme-common": "^3.4.0",
-    "@docusaurus/types": "^3.4.0",
+    "@docusaurus/module-type-aliases": "^3.6.0",
+    "@docusaurus/theme-classic": "^3.6.0",
+    "@docusaurus/theme-common": "^3.6.0",
+    "@docusaurus/types": "^3.6.0",
     "@types/lodash": "^4.14.200",
     "@types/postcss-prefix-selector": "^1",
     "@types/react": "^18.3.3",

diff --git a/packages/docusaurus-theme-redoc/src/index.ts b/packages/docusaurus-theme-redoc/src/index.ts
@@ -1,10 +1,9 @@
 import path from 'path';
 import type { LoadContext, Plugin } from '@docusaurus/types';
-import { ThemeOptions, GlobalData } from './types/options';
+import type { ThemeOptions, GlobalData } from './types/options';
 import { getGlobalData } from './redocData';
 
 // eslint-disable-next-line import/no-extraneous-dependencies, import/order
-import webpack from 'webpack';
 
 export type { ThemeOptions, GlobalData };
 
@@ -14,14 +13,15 @@ export default function redocTheme(
 ): Plugin<null> {
   return {
     name: 'docusaurus-theme-redoc',
-    configureWebpack(_config, isServer) {
+    configureWebpack(_config, isServer,{currentBundler}) {
+      const bundler = currentBundler.instance ?? require("webpack")
       return {
         plugins: [
-          new webpack.NormalModuleReplacementPlugin(
+          new bundler.NormalModuleReplacementPlugin(
             /^tty$/,
             require.resolve('./tty'),
           ),
-          new webpack.DefinePlugin({
+          new bundler.DefinePlugin({
             'process.versions.node': JSON.stringify(
               process.versions.node || '0.0.0',
             ),
@@ -33,7 +33,7 @@ export default function redocTheme(
           }),
           ...(isServer
             ? [
-                new webpack.NormalModuleReplacementPlugin(
+                new bundler.NormalModuleReplacementPlugin(
                   /theme\/Redoc\/Styles/,
                   path.join(__dirname, 'theme', 'Redoc', 'ServerStyles.js'),
                 ),

diff --git a/packages/docusaurus-theme-redoc/src/redocData.ts b/packages/docusaurus-theme-redoc/src/redocData.ts
@@ -1,7 +1,11 @@
 import type { RedocRawOptions } from 'redoc';
 import merge from 'lodash/merge';
 import { Config, loadConfig } from '@redocly/openapi-core';
-import { GlobalData, RedocThemeOverrides, ThemeOptions } from './types/options';
+import type {
+  GlobalData,
+  RedocThemeOverrides,
+  ThemeOptions,
+} from './types/options';
 
 const defaultOptions: Partial<RedocRawOptions> = {
   scrollYOffset: 'nav.navbar',

diff --git a/packages/docusaurus-theme-redoc/src/theme/ApiDoc/ApiDoc.tsx b/packages/docusaurus-theme-redoc/src/theme/ApiDoc/ApiDoc.tsx
@@ -1,7 +1,7 @@
 import React from 'react';
 import Layout from '@theme/Layout';
 import Redoc from '@theme/Redoc';
-import { ApiDocProps as Props } from '../../types/common';
+import type { ApiDocProps as Props } from '../../types/common';
 
 function ApiDoc({ layoutProps, specProps }: Props): JSX.Element {
   const defaultTitle = specProps.spec?.info?.title || 'API Docs';

diff --git a/packages/docusaurus-theme-redoc/src/theme/ApiDocMdx/ApiDocMdx.tsx b/packages/docusaurus-theme-redoc/src/theme/ApiDocMdx/ApiDocMdx.tsx
@@ -1,7 +1,7 @@
 import React, { useMemo } from 'react';
 import Redoc from '@theme/Redoc';
 import useSpecData from '@theme/useSpecData';
-import { MdxProps as Props } from '../../types/common';
+import type { MdxProps as Props } from '../../types/common';
 import '../ApiSchema/styles.css';
 
 const ApiDocMdx: React.FC<Props> = ({ id }: Props): JSX.Element => {

diff --git a/packages/docusaurus-theme-redoc/src/theme/ApiSchema/ApiSchema.tsx b/packages/docusaurus-theme-redoc/src/theme/ApiSchema/ApiSchema.tsx
@@ -5,7 +5,7 @@ import '../../global';
 import { SchemaDefinition } from 'redoc';
 import { useSpec } from '../../utils/useSpec';
 import { useSpecData } from '../useSpecData';
-import { ApiSchemaProps as Props } from '../../types/common';
+import type { ApiSchemaProps as Props } from '../../types/common';
 import '../Redoc/styles.css';
 import './styles.css';
 

diff --git a/packages/docusaurus-theme-redoc/src/theme/Redoc/Redoc.tsx b/packages/docusaurus-theme-redoc/src/theme/Redoc/Redoc.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 import clsx from 'clsx';
 import '../../global';
 import { RedocStandalone, RedocRawOptions } from 'redoc';
-import { SpecProps } from '../../types/common';
+import type { SpecProps } from '../../types/common';
 import { useSpecOptions } from '../../utils/useSpecOptions';
 import './styles.css';
 import ServerRedoc from './ServerRedoc';

diff --git a/packages/docusaurus-theme-redoc/src/theme/Redoc/ServerRedoc.tsx b/packages/docusaurus-theme-redoc/src/theme/Redoc/ServerRedoc.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 import clsx from 'clsx';
 import '../../global';
 import { Redoc as RedocComponent, RedocRawOptions } from 'redoc';
-import { SpecProps } from '../../types/common';
+import type { SpecProps } from '../../types/common';
 import { useSpec } from '../../utils/useSpec';
 import { ServerStyles } from './Styles';
 import './styles.css';

diff --git a/packages/docusaurus-theme-redoc/src/theme/useSpecData.ts b/packages/docusaurus-theme-redoc/src/theme/useSpecData.ts
@@ -1,5 +1,5 @@
 import { useAllPluginInstancesData } from '@docusaurus/useGlobalData';
-import { SpecProps } from '../types/common';
+import type { SpecProps } from '../types/common';
 
 /**
  *

diff --git a/packages/docusaurus-theme-redoc/src/utils/useSpec.ts b/packages/docusaurus-theme-redoc/src/utils/useSpec.ts
@@ -4,7 +4,7 @@ import useIsBrowser from '@docusaurus/useIsBrowser';
 import { useColorMode } from '@docusaurus/theme-common';
 import '../global';
 import { AppStore, RedocRawOptions } from 'redoc';
-import { SpecProps } from '../types/common';
+import type { SpecProps } from '../types/common';
 import { useSpecOptions } from './useSpecOptions';
 
 // the current store singleton in the app's instance

diff --git a/packages/docusaurus-theme-redoc/src/utils/useSpecOptions.ts b/packages/docusaurus-theme-redoc/src/utils/useSpecOptions.ts
@@ -7,8 +7,8 @@ import {
 import { useColorMode } from '@docusaurus/theme-common';
 import merge from 'lodash/merge';
 import '../global';
-import { RedocRawOptions } from 'redoc';
-import { SpecProps } from '../types/common';
+import type { RedocRawOptions } from 'redoc';
+import type { SpecProps } from '../types/common';
 import { GlobalData } from '../types/options';
 
 /**

diff --git a/packages/redocusaurus/package.json b/packages/redocusaurus/package.json
@@ -52,8 +52,8 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "@docusaurus/theme-common": "^3.4.0",
-    "@docusaurus/utils": "^3.4.0",
+    "@docusaurus/theme-common": "^3.6.0",
+    "@docusaurus/utils": "^3.6.0",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "react": "^18.3.1",

diff --git a/website/babel.config.js b/website/babel.config.js
diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts
@@ -10,6 +10,10 @@ if (process.env.VERCEL_URL) {
 }
 
 const config: Config = {
+  future: {
+    // See https://docusaurus.io/blog/releases/3.6
+    experimental_faster: true,
+  },
   title: 'Redocusaurus',
   tagline: 'OpenAPI solution for Docusaurus docs with Redoc',
   customFields: {

diff --git a/website/package.json b/website/package.json
@@ -22,10 +22,11 @@
     "test": "percy snapshot snapshots.js"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.4.0",
-    "@docusaurus/preset-classic": "^3.4.0",
-    "@docusaurus/theme-common": "^3.4.0",
-    "@docusaurus/utils": "^3.4.0",
+    "@docusaurus/core": "^3.6.0",
+    "@docusaurus/faster": "^3.6.0",
+    "@docusaurus/preset-classic": "^3.6.0",
+    "@docusaurus/theme-common": "^3.6.0",
+    "@docusaurus/utils": "^3.6.0",
     "clsx": "^1.2.1",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -139,3 +139,5 @@ static/openapi
		.pnp.*

		website/version.json

		.idea