Update to Docusaurus 3.6 (#294)

cloud-annotations · Jan 2, 2025 · c39166a · c39166a
1 parent aafdc8a
commit c39166a
Show file tree

Hide file tree

Showing 13 changed files with 2,416 additions and 692 deletions.
diff --git a/demo/docusaurus.config.js b/demo/docusaurus.config.js
@@ -26,6 +26,10 @@ const config = {
     },
   },
 
+  future: {
+    experimental_faster: true,
+  },
+
   presets: [
     [
       "docusaurus-preset-openapi",

diff --git a/demo/package.json b/demo/package.json
@@ -14,7 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.2.0",
+    "@docusaurus/core": "^3.6.0",
+    "@docusaurus/faster": "^3.6.0",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.2.1",
     "docusaurus-preset-openapi": "^0.7.5",

diff --git a/packages/create-docusaurus-openapi/package.json b/packages/create-docusaurus-openapi/package.json
@@ -23,7 +23,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/logger": "^3.2.0",
+    "@docusaurus/logger": "^3.6.0",
     "commander": "^5.1.0",
     "fs-extra": "^11.0.0",
     "lodash": "^4.17.20",

diff --git a/packages/docusaurus-plugin-openapi/package.json b/packages/docusaurus-plugin-openapi/package.json
@@ -21,20 +21,20 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.2.0",
-    "@docusaurus/types": "^3.2.0",
+    "@docusaurus/module-type-aliases": "^3.6.0",
+    "@docusaurus/types": "^3.6.0",
     "@types/js-yaml": "^4.0.5",
     "@types/json-schema": "^7.0.9",
     "@types/lodash": "^4.14.176",
     "@types/postman-collection": "^3.5.3",
     "utility-types": "^3.10.0"
   },
   "dependencies": {
-    "@docusaurus/mdx-loader": "^3.2.0",
-    "@docusaurus/plugin-content-docs": "^3.2.0",
-    "@docusaurus/utils": "^3.2.0",
-    "@docusaurus/utils-common": "^3.2.0",
-    "@docusaurus/utils-validation": "^3.2.0",
+    "@docusaurus/mdx-loader": "^3.6.0",
+    "@docusaurus/plugin-content-docs": "^3.6.0",
+    "@docusaurus/utils": "^3.6.0",
+    "@docusaurus/utils-common": "^3.6.0",
+    "@docusaurus/utils-validation": "^3.6.0",
     "chalk": "^4.1.2",
     "clsx": "^1.2.1",
     "js-yaml": "^4.1.0",
@@ -43,7 +43,7 @@
     "lodash": "^4.17.20",
     "openapi-to-postmanv2": "^4.20.1",
     "postman-collection": "^4.1.0",
-    "webpack": "^5.88.1"
+    "webpack": "^5.95.0"
   },
   "peerDependencies": {
     "react": "^18.0.0",

diff --git a/packages/docusaurus-plugin-openapi/src/index.ts b/packages/docusaurus-plugin-openapi/src/index.ts
@@ -8,6 +8,7 @@
 import { readFile } from "node:fs/promises";
 import { join, relative, resolve } from "node:path";
 
+import type { Options as MDXLoaderOptions } from "@docusaurus/mdx-loader";
 import type {
   LoadContext,
   Plugin,
@@ -245,12 +246,13 @@ export default function pluginOpenAPI(
 
     configureWebpack(
       _config: Configuration,
-      isServer: boolean,
-      { getJSLoader }: ConfigureWebpackUtils
+      _isServer: boolean,
+      _configureWebpackUtils: ConfigureWebpackUtils
     ) {
       const {
         rehypePlugins,
         remarkPlugins,
+        recmaPlugins,
         beforeDefaultRehypePlugins,
         beforeDefaultRemarkPlugins,
       } = options;
@@ -267,15 +269,19 @@ export default function pluginOpenAPI(
               test: /(\.mdx?)$/,
               include: [dataDir, contentPath].map(addTrailingPathSeparator),
               use: [
-                getJSLoader({ isServer }),
                 {
                   loader: require.resolve("@docusaurus/mdx-loader"),
                   options: {
                     admonitions: options.admonitions,
                     remarkPlugins,
                     rehypePlugins,
+                    recmaPlugins,
                     beforeDefaultRehypePlugins,
                     beforeDefaultRemarkPlugins,
+                    staticDirs: siteConfig.staticDirectories.map((dir) =>
+                      resolve(siteDir, dir)
+                    ),
+                    siteDir,
                     markdownConfig: siteConfig.markdown ?? { mdx1Compat: {} },
                     metadataPath: (mdxPath: string) => {
                       if (mdxPath.startsWith(dataDir)) {
@@ -287,7 +293,7 @@ export default function pluginOpenAPI(
                         return join(dataDir, `${docuHash(aliasedSource)}.json`);
                       }
                     },
-                  },
+                  } satisfies MDXLoaderOptions,
                 },
               ].filter(Boolean),
             },

diff --git a/packages/docusaurus-plugin-openapi/src/options.ts b/packages/docusaurus-plugin-openapi/src/options.ts
@@ -10,6 +10,7 @@ import {
   Joi,
   RemarkPluginsSchema,
   RehypePluginsSchema,
+  RecmaPluginsSchema,
   AdmonitionsSchema,
 } from "@docusaurus/utils-validation";
 import chalk from "chalk";
@@ -23,14 +24,17 @@ export const DEFAULT_OPTIONS: Omit<PluginOptions, "id" | "sidebarPath"> = {
   apiItemComponent: "@theme/ApiItem",
   remarkPlugins: [],
   rehypePlugins: [],
+  recmaPlugins: [],
   beforeDefaultRemarkPlugins: [],
   beforeDefaultRehypePlugins: [],
   admonitions: true,
   sidebarCollapsible: true,
   sidebarCollapsed: true,
+  onInlineTags: "warn",
+  tags: undefined,
 };
 
-export const OptionsSchema = Joi.object({
+export const OptionsSchema = Joi.object<PluginOptions>({
   path: Joi.string().default(DEFAULT_OPTIONS.path),
   routeBasePath: Joi.string()
     // '' not allowed, see /~https://github.com/facebook/docusaurus/issues/3374
@@ -42,6 +46,7 @@ export const OptionsSchema = Joi.object({
   apiItemComponent: Joi.string().default(DEFAULT_OPTIONS.apiItemComponent),
   remarkPlugins: RemarkPluginsSchema.default(DEFAULT_OPTIONS.remarkPlugins),
   rehypePlugins: RehypePluginsSchema.default(DEFAULT_OPTIONS.rehypePlugins),
+  recmaPlugins: RecmaPluginsSchema.default(DEFAULT_OPTIONS.recmaPlugins),
   beforeDefaultRemarkPlugins: RemarkPluginsSchema.default(
     DEFAULT_OPTIONS.beforeDefaultRemarkPlugins
   ),
@@ -51,6 +56,13 @@ export const OptionsSchema = Joi.object({
   admonitions: Joi.alternatives()
     .try(AdmonitionsSchema, Joi.boolean().invalid(true))
     .default(DEFAULT_OPTIONS.admonitions),
+  onInlineTags: Joi.string()
+    .equal("ignore", "log", "warn", "throw")
+    .default(DEFAULT_OPTIONS.onInlineTags),
+  tags: Joi.string()
+    .disallow("")
+    .allow(null, false)
+    .default(() => DEFAULT_OPTIONS.tags),
 });
 
 export function validateOptions({

diff --git a/packages/docusaurus-plugin-openapi/src/types.ts b/packages/docusaurus-plugin-openapi/src/types.ts
@@ -6,6 +6,7 @@
  * ========================================================================== */
 
 import type { MDXOptions } from "@docusaurus/mdx-loader";
+import type { TagsPluginOptions } from "@docusaurus/utils";
 import type { Request } from "postman-collection";
 
 import {
@@ -20,7 +21,7 @@ export type {
   PropSidebar,
   PropSidebarItem,
 } from "@docusaurus/plugin-content-docs-types";
-export interface PluginOptions extends MDXOptions {
+export interface PluginOptions extends MDXOptions, TagsPluginOptions {
   id: string;
   path: string;
   routeBasePath: string;

diff --git a/packages/docusaurus-plugin-proxy/package.json b/packages/docusaurus-plugin-proxy/package.json
@@ -21,7 +21,7 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/types": "^3.2.0",
+    "@docusaurus/types": "^3.6.0",
     "@types/webpack-dev-server": "^4.7.2"
   },
   "engines": {

diff --git a/packages/docusaurus-preset-openapi/package.json b/packages/docusaurus-preset-openapi/package.json
@@ -28,10 +28,10 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/types": "^3.2.0"
+    "@docusaurus/types": "^3.6.0"
   },
   "dependencies": {
-    "@docusaurus/preset-classic": "^3.2.0",
+    "@docusaurus/preset-classic": "^3.6.0",
     "docusaurus-plugin-openapi": "^0.7.5",
     "docusaurus-plugin-proxy": "^0.7.5",
     "docusaurus-theme-openapi": "^0.7.5"

diff --git a/packages/docusaurus-template-openapi/template.json b/packages/docusaurus-template-openapi/template.json
@@ -15,7 +15,7 @@
       "write-heading-ids": "docusaurus write-heading-ids"
     },
     "dependencies": {
-      "@docusaurus/core": "^3.2.0",
+      "@docusaurus/core": "^3.6.0",
       "docusaurus-preset-openapi": "0.7.5",
       "@mdx-js/react": "^3.0.0",
       "clsx": "^1.2.1",

diff --git a/packages/docusaurus-theme-openapi/package.json b/packages/docusaurus-theme-openapi/package.json
@@ -24,8 +24,8 @@
     "format:lib-next": "prettier --config ../../.prettierrc.json --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.2.0",
-    "@docusaurus/types": "^3.2.0",
+    "@docusaurus/module-type-aliases": "^3.6.0",
+    "@docusaurus/types": "^3.6.0",
     "@types/concurrently": "^6.3.0",
     "@types/crypto-js": "^4.1.0",
     "@types/lodash": "^4.14.176",
@@ -35,7 +35,7 @@
     "concurrently": "^5.2.0"
   },
   "dependencies": {
-    "@docusaurus/theme-common": "^3.2.0",
+    "@docusaurus/theme-common": "^3.6.0",
     "@mdx-js/react": "^3.0.0",
     "@monaco-editor/react": "^4.3.1",
     "@reduxjs/toolkit": "^1.7.1",
@@ -56,7 +56,7 @@
     "redux-devtools-extension": "^2.13.8",
     "refractor": "^4.8.1",
     "striptags": "^3.2.0",
-    "webpack": "^5.88.1"
+    "webpack": "^5.95.0"
   },
   "peerDependencies": {
     "react": "^18.0.0",

diff --git a/packages/docusaurus-theme-openapi/src/index.ts b/packages/docusaurus-theme-openapi/src/index.ts
@@ -7,8 +7,8 @@
 
 import path from "path";
 
-import type { Plugin } from "@docusaurus/types";
-import { ProvidePlugin } from "webpack";
+import type { ConfigureWebpackUtils, Plugin } from "@docusaurus/types";
+import type { Configuration as WebpackConfiguration } from "webpack";
 
 export default function docusaurusThemeOpenAPI(): Plugin<void> {
   return {
@@ -22,10 +22,15 @@ export default function docusaurusThemeOpenAPI(): Plugin<void> {
       return path.resolve(__dirname, "..", "src", "theme");
     },
 
-    configureWebpack() {
+    configureWebpack(
+      _config: WebpackConfiguration,
+      _isServer: boolean,
+      { currentBundler }: ConfigureWebpackUtils
+    ) {
+      const bundler = currentBundler.instance ?? require("webpack");
       return {
         plugins: [
-          new ProvidePlugin({
+          new bundler.ProvidePlugin({
             Buffer: [require.resolve("buffer/"), "Buffer"],
             process: require.resolve("process/browser"),
           }),