@docusaurus/plugin-content-blog 0.0.0-6056 → 0.0.0-6060

package/lib/index.js

@@ -13,6 +13,7 @@ const path_1 = tslib_1.__importDefault(require("path"));
 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 blogUtils_1 = require("./blogUtils");
 const footnoteIDFixer_1 = tslib_1.__importDefault(require("./remark/footnoteIDFixer"));
 const translations_1 = require("./translations");
@@ -69,6 +70,73 @@ async function pluginContentBlog(context, options) {
         contentPaths,
     });
     const sourceToPermalinkHelper = createSourceToPermalinkHelper();
+    async function createBlogMDXLoaderRule() {
+        const { admonitions, rehypePlugins, remarkPlugins, recmaPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
+        const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
+        const loaderOptions = {
+            admonitions,
+            remarkPlugins,
+            rehypePlugins,
+            recmaPlugins,
+            beforeDefaultRemarkPlugins: [
+                footnoteIDFixer_1.default,
+                ...beforeDefaultRemarkPlugins,
+            ],
+            beforeDefaultRehypePlugins,
+            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`);
+            },
+            // For blog posts a title in markdown is always removed
+            // Blog posts title are rendered separately
+            removeContentTitle: true,
+            // Assets allow to convert some relative images paths to
+            // require() calls
+            // @ts-expect-error: TODO fix typing issue
+            createAssets: ({ frontMatter, metadata, }) => ({
+                image: frontMatter.image,
+                authorsImageUrls: metadata.authors.map((author) => author.imageURL),
+            }),
+            markdownConfig: siteConfig.markdown,
+            resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
+                const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
+                    sourceFilePath,
+                    sourceToPermalink: sourceToPermalinkHelper.get(),
+                    siteDir,
+                    contentPaths,
+                });
+                if (permalink === null) {
+                    logger_1.default.report(onBrokenMarkdownLinks) `Blog markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath}`;
+                }
+                return permalink;
+            },
+        };
+        function createBlogMarkdownLoader() {
+            const markdownLoaderOptions = {
+                truncateMarker,
+            };
+            return {
+                loader: path_1.default.resolve(__dirname, './markdownLoader.js'),
+                options: markdownLoaderOptions,
+            };
+        }
+        return {
+            test: /\.mdx?$/i,
+            include: contentDirs
+                // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
+                .map(utils_1.addTrailingPathSeparator),
+            use: [
+                await (0, mdx_loader_1.createMDXLoaderItem)(loaderOptions),
+                createBlogMarkdownLoader(),
+            ],
+        };
+    }
+    const blogMDXLoaderRule = await createBlogMDXLoaderRule();
     return {
         name: PluginName,
         getPathsToWatch() {
@@ -179,66 +247,6 @@ async function pluginContentBlog(context, options) {
             return (0, translations_1.translateContent)(content, translationFiles);
         },
         configureWebpack() {
-            const { admonitions, rehypePlugins, remarkPlugins, recmaPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
-            const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
-            function createMDXLoader() {
-                const loaderOptions = {
-                    admonitions,
-                    remarkPlugins,
-                    rehypePlugins,
-                    recmaPlugins,
-                    beforeDefaultRemarkPlugins: [
-                        footnoteIDFixer_1.default,
-                        ...beforeDefaultRemarkPlugins,
-                    ],
-                    beforeDefaultRehypePlugins,
-                    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`);
-                    },
-                    // For blog posts a title in markdown is always removed
-                    // Blog posts title are rendered separately
-                    removeContentTitle: true,
-                    // Assets allow to convert some relative images paths to
-                    // require() calls
-                    // @ts-expect-error: TODO fix typing issue
-                    createAssets: ({ frontMatter, metadata, }) => ({
-                        image: frontMatter.image,
-                        authorsImageUrls: metadata.authors.map((author) => author.imageURL),
-                    }),
-                    markdownConfig: siteConfig.markdown,
-                    resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
-                        const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
-                            sourceFilePath,
-                            sourceToPermalink: sourceToPermalinkHelper.get(),
-                            siteDir,
-                            contentPaths,
-                        });
-                        if (permalink === null) {
-                            logger_1.default.report(onBrokenMarkdownLinks) `Blog markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath}`;
-                        }
-                        return permalink;
-                    },
-                };
-                return {
-                    loader: require.resolve('@docusaurus/mdx-loader'),
-                    options: loaderOptions,
-                };
-            }
-            function createBlogMarkdownLoader() {
-                const loaderOptions = {
-                    truncateMarker,
-                };
-                return {
-                    loader: path_1.default.resolve(__dirname, './markdownLoader.js'),
-                    options: loaderOptions,
-                };
-            }
             return {
                 resolve: {
                     alias: {
@@ -246,15 +254,7 @@ async function pluginContentBlog(context, options) {
                     },
                 },
                 module: {
-                    rules: [
-                        {
-                            test: /\.mdx?$/i,
-                            include: contentDirs
-                                // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
-                                .map(utils_1.addTrailingPathSeparator),
-                            use: [createMDXLoader(), createBlogMarkdownLoader()],
-                        },
-                    ],
+                    rules: [blogMDXLoaderRule],
                 },
             };
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-6056",
+  "version": "0.0.0-6060",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,14 +31,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-6056",
-    "@docusaurus/logger": "0.0.0-6056",
-    "@docusaurus/mdx-loader": "0.0.0-6056",
-    "@docusaurus/theme-common": "0.0.0-6056",
-    "@docusaurus/types": "0.0.0-6056",
-    "@docusaurus/utils": "0.0.0-6056",
-    "@docusaurus/utils-common": "0.0.0-6056",
-    "@docusaurus/utils-validation": "0.0.0-6056",
+    "@docusaurus/core": "0.0.0-6060",
+    "@docusaurus/logger": "0.0.0-6060",
+    "@docusaurus/mdx-loader": "0.0.0-6060",
+    "@docusaurus/theme-common": "0.0.0-6060",
+    "@docusaurus/types": "0.0.0-6060",
+    "@docusaurus/utils": "0.0.0-6060",
+    "@docusaurus/utils-common": "0.0.0-6060",
+    "@docusaurus/utils-validation": "0.0.0-6060",
     "cheerio": "1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -62,5 +62,5 @@
     "@total-typescript/shoehorn": "^0.1.2",
     "tree-node-cli": "^1.6.0"
   },
-  "gitHead": "acf50a339a52a999dd474ff7e5b610b4227b8362"
+  "gitHead": "75cf549134cde8901d2598e6c6d2439a334512ff"
 }

package/src/index.ts

@@ -22,6 +22,10 @@ import {
   type SourceToPermalink,
 } from '@docusaurus/utils';
 import {getTagsFilePathsToWatch} from '@docusaurus/utils-validation';
+import {
+  createMDXLoaderItem,
+  type Options as MDXLoaderOptions,
+} from '@docusaurus/mdx-loader';
 import {
   getBlogTags,
   paginateBlogPosts,
@@ -47,8 +51,7 @@ import type {
   BlogContent,
   BlogPaginated,
 } from '@docusaurus/plugin-content-blog';
-import type {Options as MDXLoaderOptions} from '@docusaurus/mdx-loader/lib/loader';
-import type {RuleSetUseItem} from 'webpack';
+import type {RuleSetRule, RuleSetUseItem} from 'webpack';
 
 const PluginName = 'docusaurus-plugin-content-blog';
 
@@ -127,6 +130,97 @@ export default async function pluginContentBlog(
 
   const sourceToPermalinkHelper = createSourceToPermalinkHelper();
 
+  async function createBlogMDXLoaderRule(): Promise<RuleSetRule> {
+    const {
+      admonitions,
+      rehypePlugins,
+      remarkPlugins,
+      recmaPlugins,
+      truncateMarker,
+      beforeDefaultRemarkPlugins,
+      beforeDefaultRehypePlugins,
+    } = options;
+
+    const contentDirs = getContentPathList(contentPaths);
+
+    const loaderOptions: MDXLoaderOptions = {
+      admonitions,
+      remarkPlugins,
+      rehypePlugins,
+      recmaPlugins,
+      beforeDefaultRemarkPlugins: [
+        footnoteIDFixer,
+        ...beforeDefaultRemarkPlugins,
+      ],
+      beforeDefaultRehypePlugins,
+      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`);
+      },
+      // For blog posts a title in markdown is always removed
+      // Blog posts title are rendered separately
+      removeContentTitle: true,
+      // Assets allow to convert some relative images paths to
+      // require() calls
+      // @ts-expect-error: TODO fix typing issue
+      createAssets: ({
+        frontMatter,
+        metadata,
+      }: {
+        frontMatter: BlogPostFrontMatter;
+        metadata: BlogPostMetadata;
+      }): Assets => ({
+        image: frontMatter.image,
+        authorsImageUrls: metadata.authors.map((author) => author.imageURL),
+      }),
+      markdownConfig: siteConfig.markdown,
+      resolveMarkdownLink: ({linkPathname, sourceFilePath}) => {
+        const permalink = resolveMarkdownLinkPathname(linkPathname, {
+          sourceFilePath,
+          sourceToPermalink: sourceToPermalinkHelper.get(),
+          siteDir,
+          contentPaths,
+        });
+        if (permalink === null) {
+          logger.report(
+            onBrokenMarkdownLinks,
+          )`Blog markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath}`;
+        }
+        return permalink;
+      },
+    };
+
+    function createBlogMarkdownLoader(): RuleSetUseItem {
+      const markdownLoaderOptions: BlogMarkdownLoaderOptions = {
+        truncateMarker,
+      };
+      return {
+        loader: path.resolve(__dirname, './markdownLoader.js'),
+        options: markdownLoaderOptions,
+      };
+    }
+
+    return {
+      test: /\.mdx?$/i,
+      include: contentDirs
+        // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
+        .map(addTrailingPathSeparator),
+      use: [
+        await createMDXLoaderItem(loaderOptions),
+        createBlogMarkdownLoader(),
+      ],
+    };
+  }
+
+  const blogMDXLoaderRule = await createBlogMDXLoaderRule();
+
   return {
     name: PluginName,
 
@@ -273,91 +367,6 @@ export default async function pluginContentBlog(
     },
 
     configureWebpack() {
-      const {
-        admonitions,
-        rehypePlugins,
-        remarkPlugins,
-        recmaPlugins,
-        truncateMarker,
-        beforeDefaultRemarkPlugins,
-        beforeDefaultRehypePlugins,
-      } = options;
-
-      const contentDirs = getContentPathList(contentPaths);
-
-      function createMDXLoader(): RuleSetUseItem {
-        const loaderOptions: MDXLoaderOptions = {
-          admonitions,
-          remarkPlugins,
-          rehypePlugins,
-          recmaPlugins,
-          beforeDefaultRemarkPlugins: [
-            footnoteIDFixer,
-            ...beforeDefaultRemarkPlugins,
-          ],
-          beforeDefaultRehypePlugins,
-          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`);
-          },
-          // For blog posts a title in markdown is always removed
-          // Blog posts title are rendered separately
-          removeContentTitle: true,
-          // Assets allow to convert some relative images paths to
-          // require() calls
-          // @ts-expect-error: TODO fix typing issue
-          createAssets: ({
-            frontMatter,
-            metadata,
-          }: {
-            frontMatter: BlogPostFrontMatter;
-            metadata: BlogPostMetadata;
-          }): Assets => ({
-            image: frontMatter.image,
-            authorsImageUrls: metadata.authors.map((author) => author.imageURL),
-          }),
-          markdownConfig: siteConfig.markdown,
-          resolveMarkdownLink: ({linkPathname, sourceFilePath}) => {
-            const permalink = resolveMarkdownLinkPathname(linkPathname, {
-              sourceFilePath,
-              sourceToPermalink: sourceToPermalinkHelper.get(),
-              siteDir,
-              contentPaths,
-            });
-            if (permalink === null) {
-              logger.report(
-                onBrokenMarkdownLinks,
-              )`Blog markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath}`;
-            }
-            return permalink;
-          },
-        };
-        return {
-          loader: require.resolve('@docusaurus/mdx-loader'),
-          options: loaderOptions,
-        };
-      }
-
-      function createBlogMarkdownLoader(): RuleSetUseItem {
-        const loaderOptions: BlogMarkdownLoaderOptions = {
-          truncateMarker,
-        };
-        return {
-          loader: path.resolve(__dirname, './markdownLoader.js'),
-          options: loaderOptions,
-        };
-      }
-
       return {
         resolve: {
           alias: {
@@ -365,15 +374,7 @@ export default async function pluginContentBlog(
           },
         },
         module: {
-          rules: [
-            {
-              test: /\.mdx?$/i,
-              include: contentDirs
-                // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
-                .map(addTrailingPathSeparator),
-              use: [createMDXLoader(), createBlogMarkdownLoader()],
-            },
-          ],
+          rules: [blogMDXLoaderRule],
         },
       };
     },