@docusaurus/plugin-content-blog 0.0.0-5633 → 0.0.0-5635

package/lib/feed.js

@@ -22,7 +22,10 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, locale
     const { feedOptions, routeBasePath } = options;
     const { url: siteUrl, baseUrl, title, favicon } = siteConfig;
     const blogBaseUrl = (0, utils_1.normalizeUrl)([siteUrl, baseUrl, routeBasePath]);
-    const updated = blogPosts[0]?.metadata.date;
+    const blogPostsForFeed = feedOptions.limit === false || feedOptions.limit === null
+        ? blogPosts
+        : blogPosts.slice(0, feedOptions.limit);
+    const updated = blogPostsForFeed[0]?.metadata.date;
     const feed = new feed_1.Feed({
         id: blogBaseUrl,
         title: feedOptions.title ?? `${title} Blog`,
@@ -35,7 +38,7 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, locale
     });
     const createFeedItems = options.feedOptions.createFeedItems ?? defaultCreateFeedItems;
     const feedItems = await createFeedItems({
-        blogPosts,
+        blogPosts: blogPostsForFeed,
         siteConfig,
         outDir,
         defaultCreateFeedItems,

package/lib/options.js

@@ -10,7 +10,7 @@ exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
 exports.DEFAULT_OPTIONS = {
-    feedOptions: { type: ['rss', 'atom'], copyright: '' },
+    feedOptions: { type: ['rss', 'atom'], copyright: '', limit: 20 },
     beforeDefaultRehypePlugins: [],
     beforeDefaultRemarkPlugins: [],
     admonitions: true,
@@ -92,6 +92,9 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
         }),
         language: utils_validation_1.Joi.string(),
         createFeedItems: utils_validation_1.Joi.function(),
+        limit: utils_validation_1.Joi.alternatives()
+            .try(utils_validation_1.Joi.number(), utils_validation_1.Joi.valid(null), utils_validation_1.Joi.valid(false))
+            .default(exports.DEFAULT_OPTIONS.feedOptions.limit),
     }).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,12 +1,13 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-5633",
+  "version": "0.0.0-5635",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
   "scripts": {
     "build": "tsc",
-    "watch": "tsc --watch"
+    "watch": "tsc --watch",
+    "test:generate-build-snap": "yarn docusaurus build src/__tests__/__fixtures__/website --out-dir build-snap && yarn rimraf src/__tests__/__fixtures__/website/.docusaurus && yarn rimraf src/__tests__/__fixtures__/website/build-snap/assets && git add src/__tests__/__fixtures__/website/build-snap"
   },
   "repository": {
     "type": "git",
@@ -18,13 +19,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5633",
-    "@docusaurus/logger": "0.0.0-5633",
-    "@docusaurus/mdx-loader": "0.0.0-5633",
-    "@docusaurus/types": "0.0.0-5633",
-    "@docusaurus/utils": "0.0.0-5633",
-    "@docusaurus/utils-common": "0.0.0-5633",
-    "@docusaurus/utils-validation": "0.0.0-5633",
+    "@docusaurus/core": "0.0.0-5635",
+    "@docusaurus/logger": "0.0.0-5635",
+    "@docusaurus/mdx-loader": "0.0.0-5635",
+    "@docusaurus/types": "0.0.0-5635",
+    "@docusaurus/utils": "0.0.0-5635",
+    "@docusaurus/utils-common": "0.0.0-5635",
+    "@docusaurus/utils-validation": "0.0.0-5635",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -42,5 +43,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "dc4b230629c0d1ef453ee300216be2f5ec91014a"
+  "gitHead": "b9b37df155d491fa570c242f7c151c7b5e4fb7e6"
 }

package/src/feed.ts

@@ -42,7 +42,12 @@ async function generateBlogFeed({
   const {url: siteUrl, baseUrl, title, favicon} = siteConfig;
   const blogBaseUrl = normalizeUrl([siteUrl, baseUrl, routeBasePath]);
 
-  const updated = blogPosts[0]?.metadata.date;
+  const blogPostsForFeed =
+    feedOptions.limit === false || feedOptions.limit === null
+      ? blogPosts
+      : blogPosts.slice(0, feedOptions.limit);
+
+  const updated = blogPostsForFeed[0]?.metadata.date;
 
   const feed = new Feed({
     id: blogBaseUrl,
@@ -59,7 +64,7 @@ async function generateBlogFeed({
     options.feedOptions.createFeedItems ?? defaultCreateFeedItems;
 
   const feedItems = await createFeedItems({
-    blogPosts,
+    blogPosts: blogPostsForFeed,
     siteConfig,
     outDir,
     defaultCreateFeedItems,

package/src/options.ts

@@ -22,7 +22,7 @@ import type {
 import type {OptionValidationContext} from '@docusaurus/types';
 
 export const DEFAULT_OPTIONS: PluginOptions = {
-  feedOptions: {type: ['rss', 'atom'], copyright: ''},
+  feedOptions: {type: ['rss', 'atom'], copyright: '', limit: 20},
   beforeDefaultRehypePlugins: [],
   beforeDefaultRemarkPlugins: [],
   admonitions: true,
@@ -123,6 +123,9 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
     }),
     language: Joi.string(),
     createFeedItems: Joi.function(),
+    limit: Joi.alternatives()
+      .try(Joi.number(), Joi.valid(null), Joi.valid(false))
+      .default(DEFAULT_OPTIONS.feedOptions.limit),
   }).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

@@ -272,6 +272,8 @@ yarn workspace v1.22.19image` is a collocated image path, this entry will be the
     language?: string;
     /** Allow control over the construction of BlogFeedItems */
     createFeedItems?: CreateFeedItemsFn;
+    /** Limits the feed to the specified number of posts, false|null for all */
+    limit?: number | false | null;
   };
 
   type DefaultCreateFeedItemsParams = {