@docusaurus/plugin-content-blog 2.2.0 → 2.3.0

package/lib/feed.js

@@ -33,17 +33,30 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, locale
         favicon: favicon ? (0, utils_1.normalizeUrl)([siteUrl, baseUrl, favicon]) : undefined,
         copyright: feedOptions.copyright,
     });
+    const createFeedItems = options.feedOptions.createFeedItems ?? defaultCreateFeedItems;
+    const feedItems = await createFeedItems({
+        blogPosts,
+        siteConfig,
+        outDir,
+        defaultCreateFeedItems,
+    });
+    feedItems.forEach(feed.addItem);
+    return feed;
+}
+async function defaultCreateFeedItems({ blogPosts, siteConfig, outDir, }) {
+    const { url: siteUrl } = siteConfig;
     function toFeedAuthor(author) {
         return { name: author.name, link: author.url, email: author.email };
     }
-    await Promise.all(blogPosts.map(async (post) => {
-        const { id, metadata: { title: metadataTitle, permalink, date, description, authors, tags, }, } = post;
+    return Promise.all(blogPosts.map(async (post) => {
+        const { metadata: { title: metadataTitle, permalink, date, description, authors, tags, }, } = post;
         const content = await (0, utils_1.readOutputHTMLFile)(permalink.replace(siteConfig.baseUrl, ''), outDir, siteConfig.trailingSlash);
         const $ = (0, cheerio_1.load)(content);
+        const link = (0, utils_1.normalizeUrl)([siteUrl, permalink]);
         const feedItem = {
             title: metadataTitle,
-            id,
-            link: (0, utils_1.normalizeUrl)([siteUrl, permalink]),
+            id: link,
+            link,
             date,
             description,
             // Atom feed demands the "term", while other feeds use "name"
@@ -57,8 +70,7 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, locale
             feedItem.author = feedItemAuthors;
         }
         return feedItem;
-    })).then((items) => items.forEach(feed.addItem));
-    return feed;
+    }));
 }
 async function createBlogFeedFile({ feed, feedType, generatePath, }) {
     const [feedContent, feedPath] = (() => {

package/lib/options.js

@@ -94,6 +94,7 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
                 .default(exports.DEFAULT_OPTIONS.feedOptions.copyright),
         }),
         language: utils_validation_1.Joi.string(),
+        createFeedItems: utils_validation_1.Joi.function(),
     }).default(exports.DEFAULT_OPTIONS.feedOptions),
     authorsMapPath: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.authorsMapPath),
     readingTime: utils_validation_1.Joi.function().default(() => exports.DEFAULT_OPTIONS.readingTime),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,13 +18,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.2.0",
-    "@docusaurus/logger": "2.2.0",
-    "@docusaurus/mdx-loader": "2.2.0",
-    "@docusaurus/types": "2.2.0",
-    "@docusaurus/utils": "2.2.0",
-    "@docusaurus/utils-common": "2.2.0",
-    "@docusaurus/utils-validation": "2.2.0",
+    "@docusaurus/core": "2.3.0",
+    "@docusaurus/logger": "2.3.0",
+    "@docusaurus/mdx-loader": "2.3.0",
+    "@docusaurus/types": "2.3.0",
+    "@docusaurus/utils": "2.3.0",
+    "@docusaurus/utils-common": "2.3.0",
+    "@docusaurus/utils-validation": "2.3.0",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^10.1.0",
@@ -35,9 +35,6 @@
     "utility-types": "^3.10.0",
     "webpack": "^5.73.0"
   },
-  "devDependencies": {
-    "escape-string-regexp": "^4.0.0"
-  },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
@@ -45,5 +42,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "a308fb7c81832cca354192fe2984f52749441249"
+  "gitHead": "ad477781bdca6a11fa9c6daef5048bdcec0ee37e"
 }

package/src/feed.ts

@@ -8,7 +8,7 @@
 import path from 'path';
 import fs from 'fs-extra';
 import logger from '@docusaurus/logger';
-import {Feed, type Author as FeedAuthor, type Item as FeedItem} from 'feed';
+import {Feed, type Author as FeedAuthor} from 'feed';
 import {normalizeUrl, readOutputHTMLFile} from '@docusaurus/utils';
 import {blogPostContainerID} from '@docusaurus/utils-common';
 import {load as cheerioLoad} from 'cheerio';
@@ -18,6 +18,7 @@ import type {
   PluginOptions,
   Author,
   BlogPost,
+  BlogFeedItem,
 } from '@docusaurus/plugin-content-blog';
 
 async function generateBlogFeed({
@@ -54,14 +55,39 @@ async function generateBlogFeed({
     copyright: feedOptions.copyright,
   });
 
+  const createFeedItems =
+    options.feedOptions.createFeedItems ?? defaultCreateFeedItems;
+
+  const feedItems = await createFeedItems({
+    blogPosts,
+    siteConfig,
+    outDir,
+    defaultCreateFeedItems,
+  });
+
+  feedItems.forEach(feed.addItem);
+
+  return feed;
+}
+
+async function defaultCreateFeedItems({
+  blogPosts,
+  siteConfig,
+  outDir,
+}: {
+  blogPosts: BlogPost[];
+  siteConfig: DocusaurusConfig;
+  outDir: string;
+}): Promise<BlogFeedItem[]> {
+  const {url: siteUrl} = siteConfig;
+
   function toFeedAuthor(author: Author): FeedAuthor {
     return {name: author.name, link: author.url, email: author.email};
   }
 
-  await Promise.all(
+  return Promise.all(
     blogPosts.map(async (post) => {
       const {
-        id,
         metadata: {
           title: metadataTitle,
           permalink,
@@ -79,10 +105,11 @@ async function generateBlogFeed({
       );
       const $ = cheerioLoad(content);
 
-      const feedItem: FeedItem = {
+      const link = normalizeUrl([siteUrl, permalink]);
+      const feedItem: BlogFeedItem = {
         title: metadataTitle,
-        id,
-        link: normalizeUrl([siteUrl, permalink]),
+        id: link,
+        link,
         date,
         description,
         // Atom feed demands the "term", while other feeds use "name"
@@ -99,9 +126,7 @@ async function generateBlogFeed({
 
       return feedItem;
     }),
-  ).then((items) => items.forEach(feed.addItem));
-
-  return feed;
+  );
 }
 
 async function createBlogFeedFile({

package/src/options.ts

@@ -124,6 +124,7 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
         .default(DEFAULT_OPTIONS.feedOptions.copyright),
     }),
     language: Joi.string(),
+    createFeedItems: Joi.function(),
   }).default(DEFAULT_OPTIONS.feedOptions),
   authorsMapPath: Joi.string().default(DEFAULT_OPTIONS.authorsMapPath),
   readingTime: Joi.function().default(() => DEFAULT_OPTIONS.readingTime),

package/src/plugin-content-blog.d.ts

@@ -9,12 +9,19 @@ declare module '@docusaurus/plugin-content-blog' {
   import type {LoadedMDXContent} from '@docusaurus/mdx-loader';
   import type {MDXOptions} from '@docusaurus/mdx-loader';
   import type {FrontMatterTag, Tag} from '@docusaurus/utils';
-  import type {Plugin, LoadContext} from '@docusaurus/types';
+  import type {DocusaurusConfig, Plugin, LoadContext} from '@docusaurus/types';
+  import type {Item as FeedItem} from 'feed';
   import type {Overwrite} from 'utility-types';
 
   export type Assets = {
     /**
-     * If `metadata.image` is a collocated image path, this entry will be the
+     * If `metadata.yarn workspace website typecheck
+4
+yarn workspace v1.22.19yarn workspace website typecheck
+4
+yarn workspace v1.22.19yarn workspace website typecheck
+4
+yarn workspace v1.22.19image` is a collocated image path, this entry will be the
      * bundler-generated image path. Otherwise, it's empty, and the image URL
      * should be accessed through `frontMatter.image`.
      */
@@ -255,6 +262,24 @@ declare module '@docusaurus/plugin-content-blog' {
     copyright: string;
     /** Language of the feed. */
     language?: string;
+    /** Allow control over the construction of BlogFeedItems */
+    createFeedItems?: CreateFeedItemsFn;
+  };
+
+  type DefaultCreateFeedItemsParams = {
+    blogPosts: BlogPost[];
+    siteConfig: DocusaurusConfig;
+    outDir: string;
+  };
+
+  type CreateFeedItemsFn = (
+    params: CreateFeedItemsParams,
+  ) => Promise<BlogFeedItem[]>;
+
+  type CreateFeedItemsParams = DefaultCreateFeedItemsParams & {
+    defaultCreateFeedItems: (
+      params: DefaultCreateFeedItemsParams,
+    ) => Promise<BlogFeedItem[]>;
   };
 
   /**
@@ -436,6 +461,8 @@ declare module '@docusaurus/plugin-content-blog' {
     content: string;
   };
 
+  export type BlogFeedItem = FeedItem;
+
   export type BlogPaginatedMetadata = {
     /** Title of the entire blog. */
     readonly blogTitle: string;