@docusaurus/plugin-content-blog 0.0.0-5955 → 0.0.0-5957

package/lib/blogUtils.d.ts

@@ -7,7 +7,7 @@
 /// <reference path="../src/plugin-content-blog.d.ts" />
 import type { LoadContext } from '@docusaurus/types';
 import type { PluginOptions, BlogPost, BlogTags, BlogPaginated } from '@docusaurus/plugin-content-blog';
-import type { BlogContentPaths, BlogMarkdownLoaderOptions } from './types';
+import type { BlogContentPaths } from './types';
 export declare function truncate(fileString: string, truncateMarker: RegExp): string;
 export declare function getSourceToPermalink(blogPosts: BlogPost[]): {
     [aliasedPath: string]: string;
@@ -35,11 +35,6 @@ type ParsedBlogFileName = {
 };
 export declare function parseBlogFileName(blogSourceRelative: string): ParsedBlogFileName;
 export declare function generateBlogPosts(contentPaths: BlogContentPaths, context: LoadContext, options: PluginOptions): Promise<BlogPost[]>;
-export type LinkifyParams = {
-    filePath: string;
-    fileString: string;
-} & Pick<BlogMarkdownLoaderOptions, 'sourceToPermalink' | 'siteDir' | 'contentPaths' | 'onBrokenMarkdownLink'>;
-export declare function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalink, onBrokenMarkdownLink, }: LinkifyParams): string;
 export declare function applyProcessBlogPosts({ blogPosts, processBlogPosts, }: {
     blogPosts: BlogPost[];
     processBlogPosts: PluginOptions['processBlogPosts'];

package/lib/blogUtils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyProcessBlogPosts = exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.shouldBeListed = exports.paginateBlogPosts = exports.getSourceToPermalink = exports.truncate = void 0;
+exports.applyProcessBlogPosts = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.shouldBeListed = exports.paginateBlogPosts = exports.getSourceToPermalink = exports.truncate = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -252,18 +252,6 @@ async function generateBlogPosts(contentPaths, context, options) {
     return blogPosts;
 }
 exports.generateBlogPosts = generateBlogPosts;
-function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalink, onBrokenMarkdownLink, }) {
-    const { newContent, brokenMarkdownLinks } = (0, utils_1.replaceMarkdownLinks)({
-        siteDir,
-        fileString,
-        filePath,
-        contentPaths,
-        sourceToPermalink,
-    });
-    brokenMarkdownLinks.forEach((l) => onBrokenMarkdownLink(l));
-    return newContent;
-}
-exports.linkify = linkify;
 async function applyProcessBlogPosts({ blogPosts, processBlogPosts, }) {
     const processedBlogPosts = await processBlogPosts({ blogPosts });
     if (Array.isArray(processedBlogPosts)) {

package/lib/index.js

@@ -130,19 +130,65 @@ async function pluginContentBlog(context, options) {
         },
         configureWebpack(_config, isServer, utils, content) {
             const { admonitions, rehypePlugins, remarkPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
-            const markdownLoaderOptions = {
-                siteDir,
-                contentPaths,
-                truncateMarker,
-                sourceToPermalink: (0, blogUtils_1.getSourceToPermalink)(content.blogPosts),
-                onBrokenMarkdownLink: (brokenMarkdownLink) => {
-                    if (onBrokenMarkdownLinks === 'ignore') {
-                        return;
-                    }
-                    logger_1.default.report(onBrokenMarkdownLinks) `Blog markdown link couldn't be resolved: (url=${brokenMarkdownLink.link}) in path=${brokenMarkdownLink.filePath}`;
-                },
-            };
+            const sourceToPermalink = (0, blogUtils_1.getSourceToPermalink)(content.blogPosts);
             const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
+            function createMDXLoader() {
+                const loaderOptions = {
+                    admonitions,
+                    remarkPlugins,
+                    rehypePlugins,
+                    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,
+                            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: {
@@ -156,44 +202,7 @@ async function pluginContentBlog(context, options) {
                             include: contentDirs
                                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                                 .map(utils_1.addTrailingPathSeparator),
-                            use: [
-                                {
-                                    loader: require.resolve('@docusaurus/mdx-loader'),
-                                    options: {
-                                        admonitions,
-                                        remarkPlugins,
-                                        rehypePlugins,
-                                        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
-                                        createAssets: ({ frontMatter, metadata, }) => ({
-                                            image: frontMatter.image,
-                                            authorsImageUrls: metadata.authors.map((author) => author.imageURL),
-                                        }),
-                                        markdownConfig: siteConfig.markdown,
-                                    },
-                                },
-                                {
-                                    loader: path_1.default.resolve(__dirname, './markdownLoader.js'),
-                                    options: markdownLoaderOptions,
-                                },
-                            ].filter(Boolean),
+                            use: [createMDXLoader(), createBlogMarkdownLoader()],
                         },
                     ],
                 },

package/lib/markdownLoader.js

@@ -8,20 +8,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const blogUtils_1 = require("./blogUtils");
 function markdownLoader(source) {
-    const filePath = this.resourcePath;
     const fileString = source;
     const callback = this.async();
     const markdownLoaderOptions = this.getOptions();
     // Linkify blog posts
-    let finalContent = (0, blogUtils_1.linkify)({
-        fileString,
-        filePath,
-        ...markdownLoaderOptions,
-    });
+    let finalContent = fileString;
     // Truncate content if requested (e.g: file.md?truncated=true).
     const truncated = this.resourceQuery
         ? !!new URLSearchParams(this.resourceQuery.slice(1)).get('truncated')
         : undefined;
+    // TODO truncate with the AST instead of the string ?
     if (truncated) {
         finalContent = (0, blogUtils_1.truncate)(finalContent, markdownLoaderOptions.truncateMarker);
     }

package/lib/types.d.ts

@@ -4,15 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BrokenMarkdownLink, ContentPaths } from '@docusaurus/utils';
+import type { ContentPaths } from '@docusaurus/utils';
 export type BlogContentPaths = ContentPaths;
-export type BlogBrokenMarkdownLink = BrokenMarkdownLink<BlogContentPaths>;
 export type BlogMarkdownLoaderOptions = {
-    siteDir: string;
-    contentPaths: BlogContentPaths;
     truncateMarker: RegExp;
-    sourceToPermalink: {
-        [aliasedPath: string]: string;
-    };
-    onBrokenMarkdownLink: (brokenMarkdownLink: BlogBrokenMarkdownLink) => void;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-5955",
+  "version": "0.0.0-5957",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,13 +31,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5955",
-    "@docusaurus/logger": "0.0.0-5955",
-    "@docusaurus/mdx-loader": "0.0.0-5955",
-    "@docusaurus/types": "0.0.0-5955",
-    "@docusaurus/utils": "0.0.0-5955",
-    "@docusaurus/utils-common": "0.0.0-5955",
-    "@docusaurus/utils-validation": "0.0.0-5955",
+    "@docusaurus/core": "0.0.0-5957",
+    "@docusaurus/logger": "0.0.0-5957",
+    "@docusaurus/mdx-loader": "0.0.0-5957",
+    "@docusaurus/types": "0.0.0-5957",
+    "@docusaurus/utils": "0.0.0-5957",
+    "@docusaurus/utils-common": "0.0.0-5957",
+    "@docusaurus/utils-validation": "0.0.0-5957",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -59,5 +59,5 @@
   "devDependencies": {
     "@total-typescript/shoehorn": "^0.1.2"
   },
-  "gitHead": "c8e95ee9d05bde7247861eda7582356a97a0d5ef"
+  "gitHead": "edb3a453b0b3a853eadfc4e9ec44d47ea76d5002"
 }

package/src/blogUtils.ts

@@ -17,7 +17,6 @@ import {
   getEditUrl,
   getFolderContainingFile,
   posixPath,
-  replaceMarkdownLinks,
   Globby,
   normalizeFrontMatterTags,
   groupTaggedItems,
@@ -38,7 +37,7 @@ import type {
   BlogTags,
   BlogPaginated,
 } from '@docusaurus/plugin-content-blog';
-import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
+import type {BlogContentPaths} from './types';
 
 export function truncate(fileString: string, truncateMarker: RegExp): string {
   return fileString.split(truncateMarker, 1).shift()!;
@@ -403,35 +402,6 @@ export async function generateBlogPosts(
   return blogPosts;
 }
 
-export type LinkifyParams = {
-  filePath: string;
-  fileString: string;
-} & Pick<
-  BlogMarkdownLoaderOptions,
-  'sourceToPermalink' | 'siteDir' | 'contentPaths' | 'onBrokenMarkdownLink'
->;
-
-export function linkify({
-  filePath,
-  contentPaths,
-  fileString,
-  siteDir,
-  sourceToPermalink,
-  onBrokenMarkdownLink,
-}: LinkifyParams): string {
-  const {newContent, brokenMarkdownLinks} = replaceMarkdownLinks({
-    siteDir,
-    fileString,
-    filePath,
-    contentPaths,
-    sourceToPermalink,
-  });
-
-  brokenMarkdownLinks.forEach((l) => onBrokenMarkdownLink(l));
-
-  return newContent;
-}
-
 export async function applyProcessBlogPosts({
   blogPosts,
   processBlogPosts,

package/src/index.ts

@@ -18,6 +18,7 @@ import {
   getContentPathList,
   getDataFilePath,
   DEFAULT_PLUGIN_ID,
+  resolveMarkdownLinkPathname,
 } from '@docusaurus/utils';
 import {
   getSourceToPermalink,
@@ -43,6 +44,8 @@ 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';
 
 const PluginName = 'docusaurus-plugin-content-blog';
 
@@ -213,22 +216,81 @@ export default async function pluginContentBlog(
         beforeDefaultRehypePlugins,
       } = options;
 
-      const markdownLoaderOptions: BlogMarkdownLoaderOptions = {
-        siteDir,
-        contentPaths,
-        truncateMarker,
-        sourceToPermalink: getSourceToPermalink(content.blogPosts),
-        onBrokenMarkdownLink: (brokenMarkdownLink) => {
-          if (onBrokenMarkdownLinks === 'ignore') {
-            return;
-          }
-          logger.report(
-            onBrokenMarkdownLinks,
-          )`Blog markdown link couldn't be resolved: (url=${brokenMarkdownLink.link}) in path=${brokenMarkdownLink.filePath}`;
-        },
-      };
-
+      const sourceToPermalink = getSourceToPermalink(content.blogPosts);
       const contentDirs = getContentPathList(contentPaths);
+
+      function createMDXLoader(): RuleSetUseItem {
+        const loaderOptions: MDXLoaderOptions = {
+          admonitions,
+          remarkPlugins,
+          rehypePlugins,
+          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,
+              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: {
@@ -242,61 +304,7 @@ export default async function pluginContentBlog(
               include: contentDirs
                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                 .map(addTrailingPathSeparator),
-              use: [
-                {
-                  loader: require.resolve('@docusaurus/mdx-loader'),
-                  options: {
-                    admonitions,
-                    remarkPlugins,
-                    rehypePlugins,
-                    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
-                    createAssets: ({
-                      frontMatter,
-                      metadata,
-                    }: {
-                      frontMatter: BlogPostFrontMatter;
-                      metadata: BlogPostMetadata;
-                    }): Assets => ({
-                      image: frontMatter.image,
-                      authorsImageUrls: metadata.authors.map(
-                        (author) => author.imageURL,
-                      ),
-                    }),
-                    markdownConfig: siteConfig.markdown,
-                  },
-                },
-                {
-                  loader: path.resolve(__dirname, './markdownLoader.js'),
-                  options: markdownLoaderOptions,
-                },
-              ].filter(Boolean),
+              use: [createMDXLoader(), createBlogMarkdownLoader()],
             },
           ],
         },

package/src/markdownLoader.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {truncate, linkify} from './blogUtils';
+import {truncate} from './blogUtils';
 import type {BlogMarkdownLoaderOptions} from './types';
 import type {LoaderContext} from 'webpack';
 
@@ -13,23 +13,19 @@ export default function markdownLoader(
   this: LoaderContext<BlogMarkdownLoaderOptions>,
   source: string,
 ): void {
-  const filePath = this.resourcePath;
   const fileString = source;
   const callback = this.async();
   const markdownLoaderOptions = this.getOptions();
 
   // Linkify blog posts
-  let finalContent = linkify({
-    fileString,
-    filePath,
-    ...markdownLoaderOptions,
-  });
+  let finalContent = fileString;
 
   // Truncate content if requested (e.g: file.md?truncated=true).
   const truncated: boolean | undefined = this.resourceQuery
     ? !!new URLSearchParams(this.resourceQuery.slice(1)).get('truncated')
     : undefined;
 
+  // TODO truncate with the AST instead of the string ?
   if (truncated) {
     finalContent = truncate(finalContent, markdownLoaderOptions.truncateMarker);
   }

package/src/types.ts

@@ -5,15 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {BrokenMarkdownLink, ContentPaths} from '@docusaurus/utils';
+import type {ContentPaths} from '@docusaurus/utils';
 
 export type BlogContentPaths = ContentPaths;
 
-export type BlogBrokenMarkdownLink = BrokenMarkdownLink<BlogContentPaths>;
 export type BlogMarkdownLoaderOptions = {
-  siteDir: string;
-  contentPaths: BlogContentPaths;
   truncateMarker: RegExp;
-  sourceToPermalink: {[aliasedPath: string]: string};
-  onBrokenMarkdownLink: (brokenMarkdownLink: BlogBrokenMarkdownLink) => void;
 };