@docusaurus/plugin-content-docs 0.0.0-6058 → 0.0.0-6061

package/lib/index.js

@@ -14,6 +14,7 @@ const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
+const mdx_loader_1 = require("@docusaurus/mdx-loader");
 const sidebars_1 = require("./sidebars");
 const generator_1 = require("./sidebars/generator");
 const docs_1 = require("./docs");
@@ -58,6 +59,51 @@ async function pluginContentDocs(context, options) {
     // TODO env should be injected into all plugins
     const env = process.env.NODE_ENV;
     const sourceToPermalinkHelper = createSourceToPermalinkHelper();
+    async function createDocsMDXLoaderRule() {
+        const { rehypePlugins, remarkPlugins, recmaPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
+        const contentDirs = versionsMetadata
+            .flatMap(utils_1.getContentPathList)
+            // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
+            .map(utils_1.addTrailingPathSeparator);
+        const loaderOptions = {
+            admonitions: options.admonitions,
+            remarkPlugins,
+            rehypePlugins,
+            recmaPlugins,
+            beforeDefaultRehypePlugins,
+            beforeDefaultRemarkPlugins,
+            staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
+            siteDir,
+            isMDXPartial: (0, utils_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
+            metadataPath: (mdxPath) => {
+                // Note that metadataPath must be the same/in-sync as
+                // the path from createData for each MDX.
+                const aliasedPath = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
+                return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
+            },
+            // Assets allow to convert some relative images paths to
+            // require(...) calls
+            createAssets: ({ frontMatter }) => ({
+                image: frontMatter.image,
+            }),
+            markdownConfig: siteConfig.markdown,
+            resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
+                const version = (0, versions_1.getVersionFromSourceFilePath)(sourceFilePath, versionsMetadata);
+                const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
+                    sourceFilePath,
+                    sourceToPermalink: sourceToPermalinkHelper.get(),
+                    siteDir,
+                    contentPaths: version,
+                });
+                if (permalink === null) {
+                    logger_1.default.report(siteConfig.onBrokenMarkdownLinks) `Docs markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath} for version number=${version.versionName}`;
+                }
+                return permalink;
+            },
+        };
+        return (0, mdx_loader_1.createMDXLoaderRule)({ include: contentDirs, options: loaderOptions });
+    }
+    const docsMDXLoaderRule = await createDocsMDXLoaderRule();
     return {
         name: 'docusaurus-plugin-content-docs',
         extendCli(cli) {
@@ -190,54 +236,7 @@ async function pluginContentDocs(context, options) {
                 breadcrumbs: options.breadcrumbs,
             });
         },
-        configureWebpack(_config, isServer, utils, content) {
-            const { rehypePlugins, remarkPlugins, recmaPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
-            const contentDirs = versionsMetadata
-                .flatMap(utils_1.getContentPathList)
-                // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
-                .map(utils_1.addTrailingPathSeparator);
-            function createMDXLoader() {
-                const loaderOptions = {
-                    admonitions: options.admonitions,
-                    remarkPlugins,
-                    rehypePlugins,
-                    recmaPlugins,
-                    beforeDefaultRehypePlugins,
-                    beforeDefaultRemarkPlugins,
-                    staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
-                    siteDir,
-                    isMDXPartial: (0, utils_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
-                    metadataPath: (mdxPath) => {
-                        // Note that metadataPath must be the same/in-sync as
-                        // the path from createData for each MDX.
-                        const aliasedPath = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
-                        return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
-                    },
-                    // Assets allow to convert some relative images paths to
-                    // require(...) calls
-                    createAssets: ({ frontMatter }) => ({
-                        image: frontMatter.image,
-                    }),
-                    markdownConfig: siteConfig.markdown,
-                    resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
-                        const version = (0, versions_1.getVersionFromSourceFilePath)(sourceFilePath, content.loadedVersions);
-                        const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
-                            sourceFilePath,
-                            sourceToPermalink: sourceToPermalinkHelper.get(),
-                            siteDir,
-                            contentPaths: version,
-                        });
-                        if (permalink === null) {
-                            logger_1.default.report(siteConfig.onBrokenMarkdownLinks) `Docs markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath} for version number=${version.versionName}`;
-                        }
-                        return permalink;
-                    },
-                };
-                return {
-                    loader: require.resolve('@docusaurus/mdx-loader'),
-                    options: loaderOptions,
-                };
-            }
+        configureWebpack() {
             return {
                 ignoreWarnings: [
                     // Suppress warnings about non-existing of versions file.
@@ -250,13 +249,7 @@ async function pluginContentDocs(context, options) {
                     },
                 },
                 module: {
-                    rules: [
-                        {
-                            test: /\.mdx?$/i,
-                            include: contentDirs,
-                            use: [createMDXLoader()],
-                        },
-                    ],
+                    rules: [docsMDXLoaderRule],
                 },
             };
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-6058",
+  "version": "0.0.0-6061",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,15 +35,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-6058",
-    "@docusaurus/logger": "0.0.0-6058",
-    "@docusaurus/mdx-loader": "0.0.0-6058",
-    "@docusaurus/module-type-aliases": "0.0.0-6058",
-    "@docusaurus/theme-common": "0.0.0-6058",
-    "@docusaurus/types": "0.0.0-6058",
-    "@docusaurus/utils": "0.0.0-6058",
-    "@docusaurus/utils-common": "0.0.0-6058",
-    "@docusaurus/utils-validation": "0.0.0-6058",
+    "@docusaurus/core": "0.0.0-6061",
+    "@docusaurus/logger": "0.0.0-6061",
+    "@docusaurus/mdx-loader": "0.0.0-6061",
+    "@docusaurus/module-type-aliases": "0.0.0-6061",
+    "@docusaurus/theme-common": "0.0.0-6061",
+    "@docusaurus/types": "0.0.0-6061",
+    "@docusaurus/utils": "0.0.0-6061",
+    "@docusaurus/utils-common": "0.0.0-6061",
+    "@docusaurus/utils-validation": "0.0.0-6061",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "1108fcbe4d387e2e3d0195d91157a968275970b3"
+  "gitHead": "3e2c2a06f0d0400f0adf145fd24ba37776c65dbf"
 }

package/src/index.ts

@@ -26,6 +26,10 @@ import {
   getTagsFile,
   getTagsFilePathsToWatch,
 } from '@docusaurus/utils-validation';
+import {
+  createMDXLoaderRule,
+  type Options as MDXLoaderOptions,
+} from '@docusaurus/mdx-loader';
 import {loadSidebars, resolveSidebarPathOption} from './sidebars';
 import {CategoryMetadataFilenamePattern} from './sidebars/generator';
 import {
@@ -49,7 +53,6 @@ import {
 } from './translations';
 import {createAllRoutes} from './routes';
 import {createSidebarsUtils} from './sidebars/utils';
-import type {Options as MDXLoaderOptions} from '@docusaurus/mdx-loader';
 
 import type {
   PluginOptions,
@@ -61,7 +64,7 @@ import type {
 } from '@docusaurus/plugin-content-docs';
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {DocFile, FullVersion} from './types';
-import type {RuleSetUseItem} from 'webpack';
+import type {RuleSetRule} from 'webpack';
 
 // TODO this is bad, we should have a better way to do this (new lifecycle?)
 //  The source to permalink is currently a mutable map passed to the mdx loader
@@ -114,6 +117,68 @@ export default async function pluginContentDocs(
 
   const sourceToPermalinkHelper = createSourceToPermalinkHelper();
 
+  async function createDocsMDXLoaderRule(): Promise<RuleSetRule> {
+    const {
+      rehypePlugins,
+      remarkPlugins,
+      recmaPlugins,
+      beforeDefaultRehypePlugins,
+      beforeDefaultRemarkPlugins,
+    } = options;
+    const contentDirs = versionsMetadata
+      .flatMap(getContentPathList)
+      // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
+      .map(addTrailingPathSeparator);
+
+    const loaderOptions: MDXLoaderOptions = {
+      admonitions: options.admonitions,
+      remarkPlugins,
+      rehypePlugins,
+      recmaPlugins,
+      beforeDefaultRehypePlugins,
+      beforeDefaultRemarkPlugins,
+      staticDirs: siteConfig.staticDirectories.map((dir) =>
+        path.resolve(siteDir, dir),
+      ),
+      siteDir,
+      isMDXPartial: createAbsoluteFilePathMatcher(options.exclude, contentDirs),
+      metadataPath: (mdxPath: string) => {
+        // Note that metadataPath must be the same/in-sync as
+        // the path from createData for each MDX.
+        const aliasedPath = aliasedSitePath(mdxPath, siteDir);
+        return path.join(dataDir, `${docuHash(aliasedPath)}.json`);
+      },
+      // Assets allow to convert some relative images paths to
+      // require(...) calls
+      createAssets: ({frontMatter}: {frontMatter: DocFrontMatter}) => ({
+        image: frontMatter.image,
+      }),
+      markdownConfig: siteConfig.markdown,
+      resolveMarkdownLink: ({linkPathname, sourceFilePath}) => {
+        const version = getVersionFromSourceFilePath(
+          sourceFilePath,
+          versionsMetadata,
+        );
+        const permalink = resolveMarkdownLinkPathname(linkPathname, {
+          sourceFilePath,
+          sourceToPermalink: sourceToPermalinkHelper.get(),
+          siteDir,
+          contentPaths: version,
+        });
+        if (permalink === null) {
+          logger.report(
+            siteConfig.onBrokenMarkdownLinks,
+          )`Docs markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath} for version number=${version.versionName}`;
+        }
+        return permalink;
+      },
+    };
+
+    return createMDXLoaderRule({include: contentDirs, options: loaderOptions});
+  }
+
+  const docsMDXLoaderRule = await createDocsMDXLoaderRule();
+
   return {
     name: 'docusaurus-plugin-content-docs',
 
@@ -289,74 +354,7 @@ export default async function pluginContentDocs(
       });
     },
 
-    configureWebpack(_config, isServer, utils, content) {
-      const {
-        rehypePlugins,
-        remarkPlugins,
-        recmaPlugins,
-        beforeDefaultRehypePlugins,
-        beforeDefaultRemarkPlugins,
-      } = options;
-
-      const contentDirs = versionsMetadata
-        .flatMap(getContentPathList)
-        // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
-        .map(addTrailingPathSeparator);
-
-      function createMDXLoader(): RuleSetUseItem {
-        const loaderOptions: MDXLoaderOptions = {
-          admonitions: options.admonitions,
-          remarkPlugins,
-          rehypePlugins,
-          recmaPlugins,
-          beforeDefaultRehypePlugins,
-          beforeDefaultRemarkPlugins,
-          staticDirs: siteConfig.staticDirectories.map((dir) =>
-            path.resolve(siteDir, dir),
-          ),
-          siteDir,
-          isMDXPartial: createAbsoluteFilePathMatcher(
-            options.exclude,
-            contentDirs,
-          ),
-          metadataPath: (mdxPath: string) => {
-            // Note that metadataPath must be the same/in-sync as
-            // the path from createData for each MDX.
-            const aliasedPath = aliasedSitePath(mdxPath, siteDir);
-            return path.join(dataDir, `${docuHash(aliasedPath)}.json`);
-          },
-          // Assets allow to convert some relative images paths to
-          // require(...) calls
-          createAssets: ({frontMatter}: {frontMatter: DocFrontMatter}) => ({
-            image: frontMatter.image,
-          }),
-          markdownConfig: siteConfig.markdown,
-          resolveMarkdownLink: ({linkPathname, sourceFilePath}) => {
-            const version = getVersionFromSourceFilePath(
-              sourceFilePath,
-              content.loadedVersions,
-            );
-            const permalink = resolveMarkdownLinkPathname(linkPathname, {
-              sourceFilePath,
-              sourceToPermalink: sourceToPermalinkHelper.get(),
-              siteDir,
-              contentPaths: version,
-            });
-            if (permalink === null) {
-              logger.report(
-                siteConfig.onBrokenMarkdownLinks,
-              )`Docs markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath} for version number=${version.versionName}`;
-            }
-            return permalink;
-          },
-        };
-
-        return {
-          loader: require.resolve('@docusaurus/mdx-loader'),
-          options: loaderOptions,
-        };
-      }
-
+    configureWebpack() {
       return {
         ignoreWarnings: [
           // Suppress warnings about non-existing of versions file.
@@ -370,13 +368,7 @@ export default async function pluginContentDocs(
           },
         },
         module: {
-          rules: [
-            {
-              test: /\.mdx?$/i,
-              include: contentDirs,
-              use: [createMDXLoader()],
-            },
-          ],
+          rules: [docsMDXLoaderRule],
         },
       };
     },