@docusaurus/bundler 3.5.2

package/README.md

@@ -0,0 +1,3 @@
+# `@docusaurus/bundler`
+
+Docusaurus util package to abstract the current bundler.

package/lib/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import WebpackBar from 'webpackbar';
+import MiniCssExtractPlugin from 'mini-css-extract-plugin';
+import CopyWebpackPlugin from 'copy-webpack-plugin';
+import type { CurrentBundler, DocusaurusConfig } from '@docusaurus/types';
+type SiteConfigSlice = {
+    future: {
+        experimental_faster: Pick<DocusaurusConfig['future']['experimental_faster'], 'rspackBundler'>;
+    };
+};
+export declare function getCurrentBundler({ siteConfig, }: {
+    siteConfig: SiteConfigSlice;
+}): Promise<CurrentBundler>;
+export declare function getCSSExtractPlugin({ currentBundler, }: {
+    currentBundler: CurrentBundler;
+}): Promise<typeof MiniCssExtractPlugin>;
+export declare function getCopyPlugin({ currentBundler, }: {
+    currentBundler: CurrentBundler;
+}): Promise<typeof CopyWebpackPlugin>;
+export declare function getProgressBarPlugin({ currentBundler, }: {
+    currentBundler: CurrentBundler;
+}): Promise<typeof WebpackBar>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,UAAU,MAAM,YAAY,CAAC;AACpC,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAEpD,OAAO,KAAK,EAAC,cAAc,EAAE,gBAAgB,EAAC,MAAM,mBAAmB,CAAC;AAGxE,KAAK,eAAe,GAAG;IACrB,MAAM,EAAE;QACN,mBAAmB,EAAE,IAAI,CACvB,gBAAgB,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,EACjD,eAAe,CAChB,CAAC;KACH,CAAC;CACH,CAAC;AAMF,wBAAsB,iBAAiB,CAAC,EACtC,UAAU,GACX,EAAE;IACD,UAAU,EAAE,eAAe,CAAC;CAC7B,GAAG,OAAO,CAAC,cAAc,CAAC,CAW1B;AAED,wBAAsB,mBAAmB,CAAC,EACxC,cAAc,GACf,EAAE;IACD,cAAc,EAAE,cAAc,CAAC;CAChC,GAAG,OAAO,CAAC,OAAO,oBAAoB,CAAC,CAKvC;AAED,wBAAsB,aAAa,CAAC,EAClC,cAAc,GACf,EAAE;IACD,cAAc,EAAE,cAAc,CAAC;CAChC,GAAG,OAAO,CAAC,OAAO,iBAAiB,CAAC,CAMpC;AAED,wBAAsB,oBAAoB,CAAC,EACzC,cAAc,GACf,EAAE;IACD,cAAc,EAAE,cAAc,CAAC;CAChC,GAAG,OAAO,CAAC,OAAO,UAAU,CAAC,CAgB7B"}

package/lib/index.js

@@ -0,0 +1,61 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurrentBundler = getCurrentBundler;
+exports.getCSSExtractPlugin = getCSSExtractPlugin;
+exports.getCopyPlugin = getCopyPlugin;
+exports.getProgressBarPlugin = getProgressBarPlugin;
+const tslib_1 = require("tslib");
+const webpack_1 = tslib_1.__importDefault(require("webpack"));
+const webpackbar_1 = tslib_1.__importDefault(require("webpackbar"));
+const mini_css_extract_plugin_1 = tslib_1.__importDefault(require("mini-css-extract-plugin"));
+const copy_webpack_plugin_1 = tslib_1.__importDefault(require("copy-webpack-plugin"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+function isRspack(siteConfig) {
+    return siteConfig.future.experimental_faster.rspackBundler;
+}
+async function getCurrentBundler({ siteConfig, }) {
+    if (isRspack(siteConfig)) {
+        // TODO add support for Rspack
+        logger_1.default.error('Rspack bundler is not supported yet, will use Webpack instead');
+    }
+    return {
+        name: 'webpack',
+        instance: webpack_1.default,
+    };
+}
+async function getCSSExtractPlugin({ currentBundler, }) {
+    if (currentBundler.name === 'rspack') {
+        throw new Error('Rspack bundler is not supported yet');
+    }
+    return mini_css_extract_plugin_1.default;
+}
+async function getCopyPlugin({ currentBundler, }) {
+    if (currentBundler.name === 'rspack') {
+        throw new Error('Rspack bundler is not supported yet');
+    }
+    // https://github.com/webpack-contrib/copy-webpack-plugin
+    return copy_webpack_plugin_1.default;
+}
+async function getProgressBarPlugin({ currentBundler, }) {
+    if (currentBundler.name === 'rspack') {
+        class CustomRspackProgressPlugin extends currentBundler.instance
+            .ProgressPlugin {
+            constructor({ name }) {
+                // TODO add support for color
+                // Unfortunately the rspack.ProgressPlugin does not have a name option
+                // See https://rspack.dev/plugins/webpack/progress-plugin
+                // @ts-expect-error: adapt Rspack ProgressPlugin constructor
+                super({ prefix: name });
+            }
+        }
+        return CustomRspackProgressPlugin;
+    }
+    return webpackbar_1.default;
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAuBH,8CAeC;AAED,kDASC;AAED,sCAUC;AAED,oDAoBC;;AAjFD,8DAA8B;AAC9B,oEAAoC;AACpC,8FAA2D;AAC3D,sFAAoD;AACpD,wEAAwC;AAaxC,SAAS,QAAQ,CAAC,UAA2B;IAC3C,OAAO,UAAU,CAAC,MAAM,CAAC,mBAAmB,CAAC,aAAa,CAAC;AAC7D,CAAC;AAEM,KAAK,UAAU,iBAAiB,CAAC,EACtC,UAAU,GAGX;IACC,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACzB,8BAA8B;QAC9B,gBAAM,CAAC,KAAK,CACV,+DAA+D,CAChE,CAAC;IACJ,CAAC;IACD,OAAO;QACL,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,iBAAO;KAClB,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,mBAAmB,CAAC,EACxC,cAAc,GAGf;IACC,IAAI,cAAc,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,iCAAoB,CAAC;AAC9B,CAAC;AAEM,KAAK,UAAU,aAAa,CAAC,EAClC,cAAc,GAGf;IACC,IAAI,cAAc,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IACD,yDAAyD;IACzD,OAAO,6BAAiB,CAAC;AAC3B,CAAC;AAEM,KAAK,UAAU,oBAAoB,CAAC,EACzC,cAAc,GAGf;IACC,IAAI,cAAc,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,0BAA2B,SAAQ,cAAc,CAAC,QAAQ;aAC7D,cAAc;YACf,YAAY,EAAC,IAAI,EAAiB;gBAChC,6BAA6B;gBAC7B,sEAAsE;gBACtE,yDAAyD;gBACzD,4DAA4D;gBAC5D,KAAK,CAAC,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAC;YACxB,CAAC;SACF;QACD,OAAO,0BAA+C,CAAC;IACzD,CAAC;IAED,OAAO,oBAAU,CAAC;AACpB,CAAC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@docusaurus/bundler",
+  "version": "3.5.2",
+  "description": "Docusaurus util package to abstract the current bundler.",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/facebook/docusaurus.git",
+    "directory": "packages/docusaurus-bundler"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@docusaurus/logger": "3.5.2",
+    "@docusaurus/types": "3.5.2",
+    "copy-webpack-plugin": "^11.0.0",
+    "mini-css-extract-plugin": "^2.9.1",
+    "tslib": "^2.6.0",
+    "webpack": "^5.88.1",
+    "webpackbar": "^6.0.1"
+  },
+  "engines": {
+    "node": ">=18.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,89 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import webpack from 'webpack';
+import WebpackBar from 'webpackbar';
+import MiniCssExtractPlugin from 'mini-css-extract-plugin';
+import CopyWebpackPlugin from 'copy-webpack-plugin';
+import logger from '@docusaurus/logger';
+import type {CurrentBundler, DocusaurusConfig} from '@docusaurus/types';
+
+// We inject a site config slice because the Rspack flag might change place
+type SiteConfigSlice = {
+  future: {
+    experimental_faster: Pick<
+      DocusaurusConfig['future']['experimental_faster'],
+      'rspackBundler'
+    >;
+  };
+};
+
+function isRspack(siteConfig: SiteConfigSlice): boolean {
+  return siteConfig.future.experimental_faster.rspackBundler;
+}
+
+export async function getCurrentBundler({
+  siteConfig,
+}: {
+  siteConfig: SiteConfigSlice;
+}): Promise<CurrentBundler> {
+  if (isRspack(siteConfig)) {
+    // TODO add support for Rspack
+    logger.error(
+      'Rspack bundler is not supported yet, will use Webpack instead',
+    );
+  }
+  return {
+    name: 'webpack',
+    instance: webpack,
+  };
+}
+
+export async function getCSSExtractPlugin({
+  currentBundler,
+}: {
+  currentBundler: CurrentBundler;
+}): Promise<typeof MiniCssExtractPlugin> {
+  if (currentBundler.name === 'rspack') {
+    throw new Error('Rspack bundler is not supported yet');
+  }
+  return MiniCssExtractPlugin;
+}
+
+export async function getCopyPlugin({
+  currentBundler,
+}: {
+  currentBundler: CurrentBundler;
+}): Promise<typeof CopyWebpackPlugin> {
+  if (currentBundler.name === 'rspack') {
+    throw new Error('Rspack bundler is not supported yet');
+  }
+  // https://github.com/webpack-contrib/copy-webpack-plugin
+  return CopyWebpackPlugin;
+}
+
+export async function getProgressBarPlugin({
+  currentBundler,
+}: {
+  currentBundler: CurrentBundler;
+}): Promise<typeof WebpackBar> {
+  if (currentBundler.name === 'rspack') {
+    class CustomRspackProgressPlugin extends currentBundler.instance
+      .ProgressPlugin {
+      constructor({name}: {name: string}) {
+        // TODO add support for color
+        // Unfortunately the rspack.ProgressPlugin does not have a name option
+        // See https://rspack.dev/plugins/webpack/progress-plugin
+        // @ts-expect-error: adapt Rspack ProgressPlugin constructor
+        super({prefix: name});
+      }
+    }
+    return CustomRspackProgressPlugin as typeof WebpackBar;
+  }
+
+  return WebpackBar;
+}