@docusaurus/core 0.0.0-6049 → 0.0.0-6052

package/lib/commands/build.js

@@ -202,7 +202,9 @@ async function getBuildClientConfig({ props, cliOptions, }) {
         plugins,
         config,
         isServer: false,
-        jsLoader: props.siteConfig.webpack?.jsLoader,
+        utils: await (0, configure_1.createConfigureWebpackUtils)({
+            siteConfig: props.siteConfig,
+        }),
     });
     return { clientConfig: config, clientManifestPath: result.clientManifestPath };
 }
@@ -216,7 +218,9 @@ async function getBuildServerConfig({ props }) {
         plugins,
         config,
         isServer: true,
-        jsLoader: props.siteConfig.webpack?.jsLoader,
+        utils: await (0, configure_1.createConfigureWebpackUtils)({
+            siteConfig: props.siteConfig,
+        }),
     });
     return { serverConfig: config, serverBundlePath: result.serverBundlePath };
 }

package/lib/commands/start/webpack.js

@@ -108,7 +108,7 @@ async function getStartClientConfig({ props, minify, poll, }) {
         plugins,
         config,
         isServer: false,
-        jsLoader: siteConfig.webpack?.jsLoader,
+        utils: await (0, configure_1.createConfigureWebpackUtils)({ siteConfig }),
     });
     return config;
 }

package/lib/faster.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 type { ConfigureWebpackUtils } from '@docusaurus/types';
+export declare function getSwcJsLoaderFactory(): Promise<ConfigureWebpackUtils['getJSLoader']>;

package/lib/faster.js

@@ -0,0 +1,24 @@
+"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.getSwcJsLoaderFactory = getSwcJsLoaderFactory;
+async function importFaster() {
+    return import('@docusaurus/faster');
+}
+async function ensureFaster() {
+    try {
+        return await importFaster();
+    }
+    catch (error) {
+        throw new Error('Your Docusaurus site need to add the @docusaurus/faster package as a dependency.', { cause: error });
+    }
+}
+async function getSwcJsLoaderFactory() {
+    const faster = await ensureFaster();
+    return faster.getSwcJsLoaderFactory;
+}

package/lib/server/configValidation.d.ts

@@ -5,10 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-import type { FutureConfig, StorageConfig } from '@docusaurus/types/src/config';
+import type { FasterConfig, FutureConfig, StorageConfig } from '@docusaurus/types/src/config';
 import type { DocusaurusConfig, I18nConfig, MarkdownConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
 export declare const DEFAULT_STORAGE_CONFIG: StorageConfig;
+export declare const DEFAULT_FASTER_CONFIG: FasterConfig;
+export declare const DEFAULT_FASTER_CONFIG_TRUE: FasterConfig;
 export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
 export declare const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig;
 export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;

package/lib/server/configValidation.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
+exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
 exports.validateConfig = validateConfig;
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
@@ -22,7 +22,15 @@ exports.DEFAULT_STORAGE_CONFIG = {
     type: 'localStorage',
     namespace: false,
 };
+exports.DEFAULT_FASTER_CONFIG = {
+    swcJsLoader: false,
+};
+// When using the "faster: true" shortcut
+exports.DEFAULT_FASTER_CONFIG_TRUE = {
+    swcJsLoader: true,
+};
 exports.DEFAULT_FUTURE_CONFIG = {
+    experimental_faster: exports.DEFAULT_FASTER_CONFIG,
     experimental_storage: exports.DEFAULT_STORAGE_CONFIG,
     experimental_router: 'browser',
 };
@@ -130,6 +138,14 @@ const I18N_CONFIG_SCHEMA = utils_validation_1.Joi.object({
 })
     .optional()
     .default(exports.DEFAULT_I18N_CONFIG);
+const FASTER_CONFIG_SCHEMA = utils_validation_1.Joi.alternatives()
+    .try(utils_validation_1.Joi.object({
+    swcJsLoader: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FASTER_CONFIG.swcJsLoader),
+}), utils_validation_1.Joi.boolean()
+    .required()
+    .custom((bool) => bool ? exports.DEFAULT_FASTER_CONFIG_TRUE : exports.DEFAULT_FASTER_CONFIG))
+    .optional()
+    .default(exports.DEFAULT_FASTER_CONFIG);
 const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     type: utils_validation_1.Joi.string()
         .equal('localStorage', 'sessionStorage')
@@ -141,6 +157,7 @@ const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
     .optional()
     .default(exports.DEFAULT_STORAGE_CONFIG);
 const FUTURE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
+    experimental_faster: FASTER_CONFIG_SCHEMA,
     experimental_storage: STORAGE_CONFIG_SCHEMA,
     experimental_router: utils_validation_1.Joi.string()
         .equal('browser', 'hash')

package/lib/webpack/base.js

@@ -51,6 +51,7 @@ async function createBaseConfig({ props, isServer, minify, }) {
     const name = isServer ? 'server' : 'client';
     const mode = isProd ? 'production' : 'development';
     const themeAliases = await (0, aliases_1.loadThemeAliases)({ siteDir, plugins });
+    const createJsLoader = await (0, utils_2.createJsLoaderFactory)({ siteConfig });
     return {
         mode,
         name,
@@ -175,7 +176,7 @@ async function createBaseConfig({ props, isServer, minify, }) {
                     test: /\.[jt]sx?$/i,
                     exclude: excludeJS,
                     use: [
-                        (0, utils_2.getCustomizableJSLoader)(siteConfig.webpack?.jsLoader)({
+                        createJsLoader({
                             isServer,
                             babelOptions: await (0, utils_2.getCustomBabelConfigFilePath)(siteDir),
                         }),

package/lib/webpack/configure.d.ts

@@ -4,22 +4,36 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { Configuration, RuleSetRule } from 'webpack';
-import type { Plugin, LoadedPlugin } from '@docusaurus/types';
+import { createJsLoaderFactory } from './utils';
+import type { Configuration } from 'webpack';
+import type { Plugin, ConfigureWebpackUtils, LoadedPlugin } from '@docusaurus/types';
+/**
+ * Creates convenient utils to inject into the configureWebpack() lifecycle
+ * @param config the Docusaurus config
+ */
+export declare function createConfigureWebpackUtils({ siteConfig, }: {
+    siteConfig: Parameters<typeof createJsLoaderFactory>[0]['siteConfig'];
+}): Promise<ConfigureWebpackUtils>;
 /**
  * Helper function to modify webpack config
  * @param configureWebpack a webpack config or a function to modify config
  * @param config initial webpack config
  * @param isServer indicates if this is a server webpack configuration
- * @param jsLoader custom js loader config
+ * @param utils the <code>ConfigureWebpackUtils</code> utils to inject into the configureWebpack() lifecycle
  * @param content content loaded by the plugin
  * @returns final/ modified webpack config
  */
-export declare function applyConfigureWebpack(configureWebpack: NonNullable<Plugin['configureWebpack']>, config: Configuration, isServer: boolean, jsLoader: 'babel' | ((isServer: boolean) => RuleSetRule) | undefined, content: unknown): Configuration;
+export declare function applyConfigureWebpack({ configureWebpack, config, isServer, utils, content, }: {
+    configureWebpack: NonNullable<Plugin['configureWebpack']>;
+    config: Configuration;
+    isServer: boolean;
+    utils: ConfigureWebpackUtils;
+    content: unknown;
+}): Configuration;
 export declare function applyConfigurePostCss(configurePostCss: NonNullable<Plugin['configurePostCss']>, config: Configuration): Configuration;
-export declare function executePluginsConfigureWebpack({ plugins, config, isServer, jsLoader, }: {
+export declare function executePluginsConfigureWebpack({ plugins, config: configInput, isServer, utils, }: {
     plugins: LoadedPlugin[];
     config: Configuration;
     isServer: boolean;
-    jsLoader: 'babel' | ((isServer: boolean) => RuleSetRule) | undefined;
+    utils: ConfigureWebpackUtils;
 }): Configuration;

package/lib/webpack/configure.js

@@ -6,26 +6,32 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConfigureWebpackUtils = createConfigureWebpackUtils;
 exports.applyConfigureWebpack = applyConfigureWebpack;
 exports.applyConfigurePostCss = applyConfigurePostCss;
 exports.executePluginsConfigureWebpack = executePluginsConfigureWebpack;
 const webpack_merge_1 = require("webpack-merge");
 const utils_1 = require("./utils");
+/**
+ * Creates convenient utils to inject into the configureWebpack() lifecycle
+ * @param config the Docusaurus config
+ */
+async function createConfigureWebpackUtils({ siteConfig, }) {
+    return {
+        getStyleLoaders: utils_1.getStyleLoaders,
+        getJSLoader: await (0, utils_1.createJsLoaderFactory)({ siteConfig }),
+    };
+}
 /**
  * Helper function to modify webpack config
  * @param configureWebpack a webpack config or a function to modify config
  * @param config initial webpack config
  * @param isServer indicates if this is a server webpack configuration
- * @param jsLoader custom js loader config
+ * @param utils the <code>ConfigureWebpackUtils</code> utils to inject into the configureWebpack() lifecycle
  * @param content content loaded by the plugin
  * @returns final/ modified webpack config
  */
-function applyConfigureWebpack(configureWebpack, config, isServer, jsLoader, content) {
-    // Export some utility functions
-    const utils = {
-        getStyleLoaders: utils_1.getStyleLoaders,
-        getJSLoader: (0, utils_1.getCustomizableJSLoader)(jsLoader),
-    };
+function applyConfigureWebpack({ configureWebpack, config, isServer, utils, content, }) {
     if (typeof configureWebpack === 'function') {
         const { mergeStrategy, ...res } = configureWebpack(config, isServer, utils, content) ?? {};
         const customizeRules = mergeStrategy ?? {};
@@ -74,14 +80,19 @@ function executePluginsConfigurePostCss({ plugins, config, }) {
     return resultConfig;
 }
 // Plugin Lifecycle - configureWebpack()
-function executePluginsConfigureWebpack({ plugins, config, isServer, jsLoader, }) {
+function executePluginsConfigureWebpack({ plugins, config: configInput, isServer, utils, }) {
+    let config = configInput;
     // Step1 - Configure Webpack
-    let resultConfig = config;
     plugins.forEach((plugin) => {
         const { configureWebpack } = plugin;
         if (configureWebpack) {
-            resultConfig = applyConfigureWebpack(configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`.
-            resultConfig, isServer, jsLoader, plugin.content);
+            config = applyConfigureWebpack({
+                configureWebpack: configureWebpack.bind(plugin), // The plugin lifecycle may reference `this`.
+                config,
+                isServer,
+                utils,
+                content: plugin.content,
+            });
         }
     });
     // Step2 - For client code, configure PostCSS
@@ -90,10 +101,10 @@ function executePluginsConfigureWebpack({ plugins, config, isServer, jsLoader, }
     // See https://github.com/facebook/docusaurus/issues/10106
     // Note: it's useless to configure postCSS for the server
     if (!isServer) {
-        resultConfig = executePluginsConfigurePostCss({
+        config = executePluginsConfigurePostCss({
             plugins,
-            config: resultConfig,
+            config,
         });
     }
-    return resultConfig;
+    return config;
 }

package/lib/webpack/utils.d.ts

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import webpack, { type Configuration, type RuleSetRule } from 'webpack';
+import type { ConfigureWebpackUtils, DocusaurusConfig } from '@docusaurus/types';
 import type { TransformOptions } from '@babel/core';
 export declare function formatStatsErrorMessage(statsJson: ReturnType<webpack.Stats['toJson']> | undefined): string | undefined;
 export declare function printStatsWarnings(statsJson: ReturnType<webpack.Stats['toJson']> | undefined): void;
@@ -16,10 +17,14 @@ export declare function getBabelOptions({ isServer, babelOptions, }?: {
     isServer?: boolean;
     babelOptions?: TransformOptions | string;
 }): TransformOptions;
-export declare const getCustomizableJSLoader: (jsLoader?: "babel" | ((isServer: boolean) => RuleSetRule)) => ({ isServer, babelOptions, }: {
-    isServer: boolean;
-    babelOptions?: TransformOptions | string;
-}) => RuleSetRule;
+export declare function createJsLoaderFactory({ siteConfig, }: {
+    siteConfig: {
+        webpack?: DocusaurusConfig['webpack'];
+        future?: {
+            experimental_faster: DocusaurusConfig['future']['experimental_faster'];
+        };
+    };
+}): Promise<ConfigureWebpackUtils['getJSLoader']>;
 declare global {
     interface Error {
         /** @see https://webpack.js.org/api/node/#error-handling */

package/lib/webpack/utils.js

@@ -6,12 +6,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCustomizableJSLoader = void 0;
 exports.formatStatsErrorMessage = formatStatsErrorMessage;
 exports.printStatsWarnings = printStatsWarnings;
 exports.getStyleLoaders = getStyleLoaders;
 exports.getCustomBabelConfigFilePath = getCustomBabelConfigFilePath;
 exports.getBabelOptions = getBabelOptions;
+exports.createJsLoaderFactory = createJsLoaderFactory;
 exports.compile = compile;
 exports.getHttpsConfig = getHttpsConfig;
 const tslib_1 = require("tslib");
@@ -23,6 +23,7 @@ const utils_1 = require("@docusaurus/utils");
 const mini_css_extract_plugin_1 = tslib_1.__importDefault(require("mini-css-extract-plugin"));
 const webpack_1 = tslib_1.__importDefault(require("webpack"));
 const formatWebpackMessages_1 = tslib_1.__importDefault(require("react-dev-utils/formatWebpackMessages"));
+const faster_1 = require("../faster");
 function formatStatsErrorMessage(statsJson) {
     if (statsJson?.errors?.length) {
         // TODO formatWebpackMessages does not print stack-traces
@@ -123,18 +124,32 @@ function getBabelOptions({ isServer, babelOptions, } = {}) {
         caller: { name: isServer ? 'server' : 'client' },
     };
 }
-// Name is generic on purpose
-// we want to support multiple js loader implementations (babel + esbuild)
-function getDefaultBabelLoader({ isServer, babelOptions, }) {
+const BabelJsLoaderFactory = ({ isServer, babelOptions, }) => {
     return {
         loader: require.resolve('babel-loader'),
         options: getBabelOptions({ isServer, babelOptions }),
     };
+};
+// Confusing: function that creates a function that creates actual js loaders
+// This is done on purpose because the js loader factory is a public API
+// It is injected in configureWebpack plugin lifecycle for plugin authors
+async function createJsLoaderFactory({ siteConfig, }) {
+    const jsLoader = siteConfig.webpack?.jsLoader ?? 'babel';
+    if (jsLoader instanceof Function &&
+        siteConfig.future?.experimental_faster.swcJsLoader) {
+        throw new Error("You can't use a custom webpack.jsLoader and experimental_faster.swcJsLoader at the same time");
+    }
+    if (jsLoader instanceof Function) {
+        return ({ isServer }) => jsLoader(isServer);
+    }
+    if (siteConfig.future?.experimental_faster.swcJsLoader) {
+        return (0, faster_1.getSwcJsLoaderFactory)();
+    }
+    if (jsLoader === 'babel') {
+        return BabelJsLoaderFactory;
+    }
+    throw new Error(`Docusaurus bug: unexpected jsLoader value${jsLoader}`);
 }
-const getCustomizableJSLoader = (jsLoader = 'babel') => ({ isServer, babelOptions, }) => jsLoader === 'babel'
-    ? getDefaultBabelLoader({ isServer, babelOptions })
-    : jsLoader(isServer);
-exports.getCustomizableJSLoader = getCustomizableJSLoader;
 function compile(config) {
     return new Promise((resolve, reject) => {
         const compiler = (0, webpack_1.default)(config);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-6049",
+  "version": "0.0.0-6052",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,12 +43,12 @@
     "@babel/runtime": "^7.22.6",
     "@babel/runtime-corejs3": "^7.22.6",
     "@babel/traverse": "^7.22.8",
-    "@docusaurus/cssnano-preset": "0.0.0-6049",
-    "@docusaurus/logger": "0.0.0-6049",
-    "@docusaurus/mdx-loader": "0.0.0-6049",
-    "@docusaurus/utils": "0.0.0-6049",
-    "@docusaurus/utils-common": "0.0.0-6049",
-    "@docusaurus/utils-validation": "0.0.0-6049",
+    "@docusaurus/cssnano-preset": "0.0.0-6052",
+    "@docusaurus/logger": "0.0.0-6052",
+    "@docusaurus/mdx-loader": "0.0.0-6052",
+    "@docusaurus/utils": "0.0.0-6052",
+    "@docusaurus/utils-common": "0.0.0-6052",
+    "@docusaurus/utils-validation": "0.0.0-6052",
     "autoprefixer": "^10.4.14",
     "babel-loader": "^9.1.3",
     "babel-plugin-dynamic-import-node": "^2.3.3",
@@ -103,8 +103,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-6049",
-    "@docusaurus/types": "0.0.0-6049",
+    "@docusaurus/module-type-aliases": "0.0.0-6052",
+    "@docusaurus/types": "0.0.0-6052",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -118,12 +118,18 @@
     "tree-node-cli": "^1.6.0"
   },
   "peerDependencies": {
+    "@docusaurus/faster": "3.5.2",
     "@mdx-js/react": "^3.0.0",
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
+  "peerDependenciesMeta": {
+    "@docusaurus/faster": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "f6855e0f81535a12a66babb934ad8dcf6e9361b2"
+  "gitHead": "ff41451cf14cc627f2c0e002edc580ae91732eaf"
 }