@docusaurus/plugin-rsdoctor 4.0.0-canary-6980 → 4.0.0-canary-6985

package/README.md

@@ -1,6 +1,6 @@
 # `@docusaurus/plugin-rsdoctor`
 
-[Rsdoctor](https://rsdoctor.dev/) plugin for Docusaurus.
+[Rsdoctor](https://rsdoctor.rs/) plugin for Docusaurus.
 
 ## Usage
 

package/lib/index.js

@@ -7,35 +7,41 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
-const rspack_plugin_1 = require("@rsdoctor/rspack-plugin");
-const webpack_plugin_1 = require("@rsdoctor/webpack-plugin");
-function getRsdoctorPlugin(currentBundlerName) {
+// Rsdoctor v2 only supports Rspack, Webpack sites keep using Rsdoctor v1
+// Each Rsdoctor package is imported lazily, only for the current bundler
+async function getCreateBundlerConfig({ currentBundlerName, rsdoctorOptions, }) {
     return currentBundlerName === 'rspack'
-        ? rspack_plugin_1.RsdoctorRspackMultiplePlugin
-        : // Cast fixes "error TS2321: Excessive stack depth"
-            // This may be a temporary TS 7.0 issue?
-            webpack_plugin_1.RsdoctorWebpackMultiplePlugin;
+        ? getCreateRspackConfig(rsdoctorOptions)
+        : getCreateWebpackConfig(rsdoctorOptions);
 }
-function createRsdoctorBundlerPlugin({ isServer, currentBundler, options, }) {
-    const RsdoctorPlugin = getRsdoctorPlugin(currentBundler.name);
-    return new RsdoctorPlugin({
-        name: isServer ? 'server' : 'client',
-        ...options.rsdoctorOptions,
+async function getCreateRspackConfig(rsdoctorOptions) {
+    const { RsdoctorRspackPlugin, migrateRsdoctorOptions } = await import('@rsdoctor/core');
+    // Rsdoctor v1 options keep working, with a warning to migrate them
+    // A single instance applied to both compilers merges them in one report
+    const plugin = new RsdoctorRspackPlugin(migrateRsdoctorOptions(rsdoctorOptions));
+    return ({ name }) => ({
+        // Rsdoctor v2 names each compiler report after the compiler name
+        name,
+        plugins: [plugin],
+    });
+}
+async function getCreateWebpackConfig(rsdoctorOptions) {
+    const { RsdoctorWebpackMultiplePlugin } = await import('@rsdoctor/webpack-plugin');
+    return ({ name }) => ({
+        plugins: [
+            new RsdoctorWebpackMultiplePlugin({ name, ...rsdoctorOptions }),
+        ],
     });
 }
 exports.default = (async function pluginRsdoctor(context, options) {
+    const createBundlerConfig = await getCreateBundlerConfig({
+        currentBundlerName: context.currentBundler.name,
+        rsdoctorOptions: options.rsdoctorOptions,
+    });
     return {
         name: 'docusaurus-plugin-rsdoctor',
         configureWebpack: (__config, isServer) => {
-            return {
-                plugins: [
-                    createRsdoctorBundlerPlugin({
-                        isServer,
-                        currentBundler: context.currentBundler,
-                        options,
-                    }),
-                ],
-            };
+            return createBundlerConfig({ name: isServer ? 'server' : 'client' });
         },
     };
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-rsdoctor",
-  "version": "4.0.0-canary-6980",
+  "version": "4.0.0-canary-6985",
   "description": "Rsdoctor plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -14,15 +14,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "4.0.0-canary-6980",
-    "@docusaurus/types": "4.0.0-canary-6980",
-    "@docusaurus/utils-validation": "4.0.0-canary-6980",
-    "@rsdoctor/rspack-plugin": "^1.6.3",
+    "@docusaurus/core": "4.0.0-canary-6985",
+    "@docusaurus/types": "4.0.0-canary-6985",
+    "@docusaurus/utils-validation": "4.0.0-canary-6985",
+    "@rsdoctor/core": "^2.0.0",
     "@rsdoctor/webpack-plugin": "^1.6.3",
     "tslib": "^2.8.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "4.0.0-canary-6980"
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6985"
   },
   "peerDependencies": {
     "react": "^19.3.0",

package/src/index.ts

@@ -5,60 +5,71 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {RsdoctorRspackMultiplePlugin} from '@rsdoctor/rspack-plugin';
-import {RsdoctorWebpackMultiplePlugin} from '@rsdoctor/webpack-plugin';
 import type {ConfigureWebpackResult} from '@docusaurus/types/src/plugin';
 import type {CurrentBundler, LoadContext, Plugin} from '@docusaurus/types';
 import type {PluginOptions, Options} from './options';
 
-type RsdoctorPluginType = typeof RsdoctorRspackMultiplePlugin;
+type BundlerConfig = ConfigureWebpackResult;
 
-function getRsdoctorPlugin(
-  currentBundlerName: CurrentBundler['name'],
-): RsdoctorPluginType {
-  return currentBundlerName === 'rspack'
-    ? RsdoctorRspackMultiplePlugin
-    : // Cast fixes "error TS2321: Excessive stack depth"
-      // This may be a temporary TS 7.0 issue?
-      (RsdoctorWebpackMultiplePlugin as unknown as RsdoctorPluginType);
-}
+type RsdoctorOptions = PluginOptions['rsdoctorOptions'];
+
+type CreateBundlerConfig = (params: {name: string}) => BundlerConfig;
 
-function createRsdoctorBundlerPlugin({
-  isServer,
-  currentBundler,
-  options,
+// Rsdoctor v2 only supports Rspack, Webpack sites keep using Rsdoctor v1
+// Each Rsdoctor package is imported lazily, only for the current bundler
+async function getCreateBundlerConfig({
+  currentBundlerName,
+  rsdoctorOptions,
 }: {
-  isServer: boolean;
-  currentBundler: CurrentBundler;
-  options: PluginOptions;
-}) {
-  const RsdoctorPlugin = getRsdoctorPlugin(currentBundler.name);
+  currentBundlerName: CurrentBundler['name'];
+  rsdoctorOptions: RsdoctorOptions;
+}): Promise<CreateBundlerConfig> {
+  return currentBundlerName === 'rspack'
+    ? getCreateRspackConfig(rsdoctorOptions)
+    : getCreateWebpackConfig(rsdoctorOptions);
+}
 
-  // Little type incompatibility?
-  type WebpackPlugin = NonNullable<ConfigureWebpackResult['plugins']>[number];
+async function getCreateRspackConfig(
+  rsdoctorOptions: RsdoctorOptions,
+): Promise<CreateBundlerConfig> {
+  const {RsdoctorRspackPlugin, migrateRsdoctorOptions} =
+    await import('@rsdoctor/core');
+  // Rsdoctor v1 options keep working, with a warning to migrate them
+  // A single instance applied to both compilers merges them in one report
+  const plugin = new RsdoctorRspackPlugin(
+    migrateRsdoctorOptions(rsdoctorOptions),
+  );
+  return ({name}) => ({
+    // Rsdoctor v2 names each compiler report after the compiler name
+    name,
+    plugins: [plugin] as unknown as BundlerConfig['plugins'],
+  });
+}
 
-  return new RsdoctorPlugin({
-    name: isServer ? 'server' : 'client',
-    ...options.rsdoctorOptions,
-  }) as unknown as WebpackPlugin;
+async function getCreateWebpackConfig(
+  rsdoctorOptions: RsdoctorOptions,
+): Promise<CreateBundlerConfig> {
+  const {RsdoctorWebpackMultiplePlugin} =
+    await import('@rsdoctor/webpack-plugin');
+  return ({name}) => ({
+    plugins: [
+      new RsdoctorWebpackMultiplePlugin({name, ...rsdoctorOptions}),
+    ] as unknown as BundlerConfig['plugins'],
+  });
 }
 
 export default (async function pluginRsdoctor(
   context: LoadContext,
   options: PluginOptions,
 ): Promise<Plugin | null> {
+  const createBundlerConfig = await getCreateBundlerConfig({
+    currentBundlerName: context.currentBundler.name,
+    rsdoctorOptions: options.rsdoctorOptions,
+  });
   return {
     name: 'docusaurus-plugin-rsdoctor',
     configureWebpack: (__config, isServer) => {
-      return {
-        plugins: [
-          createRsdoctorBundlerPlugin({
-            isServer,
-            currentBundler: context.currentBundler,
-            options,
-          }),
-        ],
-      };
+      return createBundlerConfig({name: isServer ? 'server' : 'client'});
     },
   };
 });