@rspress/plugin-rss 0.0.0-nightly-20240402160431

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Bytedance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# @rspress/plugin-rss
+
+> RSS plugin for rspress
+
+[Documentation](https://rspress.dev/plugin/official-plugins/rss)

package/dist/index.cjs

@@ -0,0 +1,317 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  PluginComponents: () => PluginComponents,
+  PluginName: () => PluginName,
+  createFeed: () => createFeed,
+  generateFeedItem: () => generateFeedItem,
+  getDefaultFeedOption: () => getDefaultFeedOption,
+  getFeedFileType: () => getFeedFileType,
+  getOutputInfo: () => getOutputInfo,
+  pluginRss: () => pluginRss,
+  testPage: () => testPage
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin-rss.ts
+var import_node_path = __toESM(require("path"));
+var import_node_url3 = require("url");
+var import_feed = require("feed");
+
+// src/exports.ts
+var PluginName = "@rspress/plugin-rss";
+var PluginComponents = {
+  FeedsAnnotations: "@rspress/plugin-rss/FeedsAnnotations"
+};
+
+// src/feed.ts
+var import_node_url = require("url");
+
+// src/internals/lang.ts
+function notNullish(n) {
+  return n !== void 0 && n !== null;
+}
+function concatArray(...arrList) {
+  return arrList.reduce(
+    (arr, item) => arr.concat((Array.isArray(item) ? item : [item]).filter(notNullish)),
+    []
+  );
+}
+function selectNonNullishProperty(...list) {
+  for (const item of list) {
+    if (item === "")
+      return "";
+    if (item === 0)
+      return "0";
+    if (typeof item === "number")
+      return `${item}`;
+    if (typeof item === "string")
+      return item;
+  }
+}
+function toDate(s) {
+  const d = new Date(s);
+  return Number.isNaN(d.getDate()) ? null : d;
+}
+
+// src/internals/node.ts
+var import_promises = require("fs/promises");
+var NodePath = __toESM(require("path"));
+async function writeFile(path, content) {
+  const dir = NodePath.dirname(path);
+  await (0, import_promises.mkdir)(dir, { mode: 493, recursive: true });
+  return (0, import_promises.writeFile)(path, content);
+}
+
+// src/feed.ts
+function generateFeedItem(page, siteUrl) {
+  const { frontmatter: fm } = page;
+  return {
+    id: selectNonNullishProperty(fm.slug, fm.id, page.id) || "",
+    title: selectNonNullishProperty(fm.title, page.title) || "",
+    author: toAuthors(fm.author),
+    link: (0, import_node_url.resolve)(
+      siteUrl,
+      selectNonNullishProperty(fm.permalink, page.routePath) || ""
+    ),
+    description: selectNonNullishProperty(fm.description) || "",
+    content: selectNonNullishProperty(fm.summary, page.content) || "",
+    date: toDate(fm.date || fm.published_at),
+    category: concatArray(fm.categories, fm.category).map(
+      (cat) => ({ name: cat })
+    )
+  };
+}
+function createFeed(options, config) {
+  const { output, item, id, title, ..._options } = options;
+  return {
+    id,
+    copyright: config.themeConfig?.footer?.message || "",
+    description: config.description || "",
+    link: output.url,
+    ..._options,
+    title: title || config.title || ""
+  };
+}
+function toAuthors(author) {
+  const authors = (Array.isArray(author) ? author : [author]).filter(Boolean).map((author2) => ({
+    // email is mandatory for RSS 2.0.
+    ...typeof author2 === "string" ? { name: author2 } : author2
+  }));
+  return authors.length ? authors : void 0;
+}
+
+// src/options.ts
+var import_node_url2 = require("url");
+function testPage(test, page, base = "/") {
+  if (Array.isArray(test)) {
+    return test.some((item) => testPage(item, page, base));
+  }
+  if (typeof test === "function") {
+    return test(page, base);
+  }
+  const routePath = page.routePath;
+  const pureRoutePath = `/${routePath.startsWith(base) ? routePath.slice(base.length) : routePath}`.replace(/^\/+/, "/");
+  if (typeof test === "string") {
+    return [routePath, pureRoutePath].some((path) => path.startsWith(test));
+  }
+  if (test instanceof RegExp) {
+    return [routePath, pureRoutePath].some((path) => test.test(path));
+  }
+  throw new Error(
+    "test must be of `RegExp` or `string` or `(page: PageIndexInfo, base: string) => boolean`"
+  );
+}
+function getDefaultFeedOption() {
+  return { id: "blog", test: "/blog/" };
+}
+function getFeedFileType(type) {
+  switch (type) {
+    case "rss":
+      return {
+        extension: "rss",
+        mime: "application/rss+xml",
+        getContent: (feed) => feed.rss2()
+      };
+    case "json":
+      return {
+        extension: "json",
+        mime: "application/json",
+        getContent: (feed) => feed.json1()
+      };
+    case "atom":
+    default:
+      return {
+        extension: "xml",
+        mime: "application/atom+xml",
+        getContent: (feed) => feed.atom1()
+      };
+  }
+}
+function getOutputInfo({ id, output }, {
+  siteUrl,
+  output: globalOutput
+}) {
+  const type = output?.type || globalOutput?.type || "atom";
+  const { extension, mime, getContent } = getFeedFileType(type);
+  const filename = output?.filename || `${id}.${extension}`;
+  const dir = output?.dir || globalOutput?.dir || "rss";
+  const publicPath = output?.publicPath || globalOutput?.publicPath || siteUrl;
+  const url = [publicPath, `${dir}/`, filename].reduce(
+    (u, part) => u ? (0, import_node_url2.resolve)(u, part) : part
+  );
+  return { type, mime, filename, getContent, dir, publicPath, url };
+}
+
+// src/plugin-rss.ts
+var FeedsSet = class {
+  constructor() {
+    this.feeds = [];
+    this.feedsMapById = /* @__PURE__ */ Object.create(null);
+  }
+  set({ feed, output, siteUrl }, config) {
+    this.feeds = (Array.isArray(feed) ? feed : [{ ...getDefaultFeedOption(), ...feed }]).map((options) => ({
+      title: config.title || "",
+      description: config.description || "",
+      favicon: config.icon && (0, import_node_url3.resolve)(siteUrl, config.icon),
+      copyright: config.themeConfig?.footer?.message || "",
+      link: siteUrl,
+      docs: "",
+      ...options,
+      output: getOutputInfo(options, { siteUrl, output })
+    }));
+    this.feedsMapById = this.feeds.reduce(
+      (m, f) => ({ ...m, [f.id]: f }),
+      /* @__PURE__ */ Object.create(null)
+    );
+  }
+  get(id) {
+    if (id) {
+      return this.feedsMapById[id] || null;
+    }
+    return this.feeds.slice(0);
+  }
+};
+function getRssItems(feeds, page, config, siteUrl) {
+  return Promise.all(
+    feeds.filter((options) => testPage(options.test, page, config.base)).map(async (options) => {
+      const after = options.item || ((feed) => feed);
+      const item = await after(
+        generateFeedItem(page, siteUrl),
+        page,
+        siteUrl
+      );
+      return { ...item, channel: options.id };
+    })
+  );
+}
+function pluginRss(pluginRssOptions) {
+  const feedsSet = new FeedsSet();
+  let _rssWorkaround = null;
+  let _config;
+  return {
+    name: PluginName,
+    globalUIComponents: Object.values(PluginComponents),
+    beforeBuild(config, isProd) {
+      if (!isProd) {
+        _rssWorkaround = null;
+        return;
+      }
+      _rssWorkaround = {};
+      _config = config;
+      feedsSet.set(pluginRssOptions, config);
+    },
+    async extendPageData(_pageData) {
+      if (!_rssWorkaround)
+        return;
+      const pageData = _pageData;
+      _rssWorkaround[pageData.id] = _rssWorkaround[pageData.id] || getRssItems(
+        feedsSet.get(),
+        pageData,
+        _config,
+        pluginRssOptions.siteUrl
+      );
+      const feeds = await _rssWorkaround[pageData.id];
+      const showRssList = new Set(
+        concatArray(pageData.frontmatter["link-rss"])
+      );
+      for (const feed of feeds) {
+        showRssList.add(feed.channel);
+      }
+      pageData.feeds = Array.from(showRssList, (id) => {
+        const { output, language } = feedsSet.get(id);
+        return {
+          url: output.url,
+          mime: output.mime,
+          language: language || pageData.lang
+        };
+      });
+    },
+    async afterBuild(config) {
+      if (!_rssWorkaround)
+        return;
+      const items = concatArray(
+        ...await Promise.all(Object.values(_rssWorkaround))
+      );
+      const feeds = /* @__PURE__ */ Object.create(null);
+      for (const { channel, ...item } of items) {
+        feeds[channel] = feeds[channel] || new import_feed.Feed(createFeed(feedsSet.get(channel), config));
+        feeds[channel].addItem(item);
+      }
+      for (const [channel, feed] of Object.entries(feeds)) {
+        const { output } = feedsSet.get(channel);
+        const path = import_node_path.default.resolve(
+          config.outDir || "doc_build",
+          output.dir,
+          output.filename
+        );
+        await writeFile(path, output.getContent(feed));
+      }
+      _rssWorkaround = null;
+      _config = null;
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginComponents,
+  PluginName,
+  createFeed,
+  generateFeedItem,
+  getDefaultFeedOption,
+  getFeedFileType,
+  getOutputInfo,
+  pluginRss,
+  testPage
+});
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,uBAAqB;AACrB,IAAAA,mBAAsC;AAEtC,kBAAqB;;;ACHd,IAAM,aAAa;AAEnB,IAAM,mBAAmB;AAAA,EAC9B,kBAAkB;AACpB;;;ACJA,sBAAsC;;;ACK/B,SAAS,WAAc,GAAiC;AAC7D,SAAO,MAAM,UAAa,MAAM;AAClC;AACO,SAAS,eAAkB,SAAkC;AAClE,SAAO,QAAQ;AAAA,IACb,CAAC,KAAK,SACJ,IAAI,QAAQ,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI,GAAG,OAAO,UAAU,CAAC;AAAA,IACrE,CAAC;AAAA,EACH;AACF;AAEO,SAAS,4BAA4B,MAAiB;AAC3D,aAAW,QAAQ,MAAM;AACvB,QAAI,SAAS;AAAI,aAAO;AACxB,QAAI,SAAS;AAAG,aAAO;AACvB,QAAI,OAAO,SAAS;AAAU,aAAO,GAAG,IAAI;AAC5C,QAAI,OAAO,SAAS;AAAU,aAAO;AAAA,EACvC;AACF;AAEO,SAAS,OAAO,GAA+B;AACpD,QAAM,IAAI,IAAI,KAAK,CAAC;AACpB,SAAO,OAAO,MAAM,EAAE,QAAQ,CAAC,IAAI,OAAO;AAC5C;;;AC5BA,sBAA+C;AAC/C,eAA0B;AAE1B,eAAsB,UAAU,MAAc,SAA0B;AACtE,QAAM,MAAe,iBAAQ,IAAI;AACjC,YAAM,uBAAM,KAAK,EAAE,MAAM,KAAO,WAAW,KAAK,CAAC;AACjD,aAAO,gBAAAC,WAAW,MAAM,OAAO;AACjC;;;AFSO,SAAS,iBAAiB,MAAqB,SAAiB;AACrE,QAAM,EAAE,aAAa,GAAG,IAAI;AAC5B,SAAO;AAAA,IACL,IAAI,yBAAyB,GAAG,MAAM,GAAG,IAAI,KAAK,EAAE,KAAK;AAAA,IACzD,OAAO,yBAAyB,GAAG,OAAO,KAAK,KAAK,KAAK;AAAA,IACzD,QAAQ,UAAU,GAAG,MAAM;AAAA,IAC3B,UAAM,gBAAAC;AAAA,MACJ;AAAA,MACA,yBAAyB,GAAG,WAAW,KAAK,SAAS,KAAK;AAAA,IAC5D;AAAA,IACA,aAAa,yBAAyB,GAAG,WAAW,KAAK;AAAA,IACzD,SAAS,yBAAyB,GAAG,SAAS,KAAK,OAAO,KAAK;AAAA,IAC/D,MAAM,OAAQ,GAAG,QAAoB,GAAG,YAAuB;AAAA,IAC/D,UAAU,YAAY,GAAG,YAAwB,GAAG,QAAkB,EAAE;AAAA,MACtE,UAAQ,EAAE,MAAM,IAAI;AAAA,IACtB;AAAA,EACF;AACF;AAEO,SAAS,WACd,SAKA,QACa;AACb,QAAM,EAAE,QAAQ,MAAM,IAAI,OAAO,GAAG,SAAS,IAAI;AACjD,SAAO;AAAA,IACL;AAAA,IACA,WAAW,OAAO,aAAa,QAAQ,WAAW;AAAA,IAClD,aAAa,OAAO,eAAe;AAAA,IACnC,MAAM,OAAO;AAAA,IACb,GAAG;AAAA,IACH,OAAO,SAAS,OAAO,SAAS;AAAA,EAClC;AACF;AAEA,SAAS,UAAU,QAAuC;AACxD,QAAM,WAAW,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,MAAM,GACtD,OAAO,OAAO,EACd,IAAI,CAAAC,aAAW;AAAA;AAAA,IAEd,GAAI,OAAOA,YAAW,WAAW,EAAE,MAAMA,QAAO,IAAIA;AAAA,EACtD,EAAE;AACJ,SAAO,QAAQ,SAAS,UAAU;AACpC;;;AG9DA,IAAAH,mBAAsC;AAM/B,SAAS,SACd,MACA,MACA,OAAO,KACE;AACT,MAAI,MAAM,QAAQ,IAAI,GAAG;AACvB,WAAO,KAAK,KAAK,UAAQ,SAAS,MAAM,MAAM,IAAI,CAAC;AAAA,EACrD;AACA,MAAI,OAAO,SAAS,YAAY;AAC9B,WAAO,KAAK,MAAM,IAAI;AAAA,EACxB;AACA,QAAM,YAAY,KAAK;AACvB,QAAM,gBAAgB,IACpB,UAAU,WAAW,IAAI,IAAI,UAAU,MAAM,KAAK,MAAM,IAAI,SAC9D,GAAG,QAAQ,QAAQ,GAAG;AACtB,MAAI,OAAO,SAAS,UAAU;AAC5B,WAAO,CAAC,WAAW,aAAa,EAAE,KAAK,UAAQ,KAAK,WAAW,IAAI,CAAC;AAAA,EACtE;AACA,MAAI,gBAAgB,QAAQ;AAC1B,WAAO,CAAC,WAAW,aAAa,EAAE,KAAK,UAAQ,KAAK,KAAK,IAAI,CAAC;AAAA,EAChE;AAEA,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;AAEO,SAAS,uBAAuB;AACrC,SAAO,EAAE,IAAI,QAAQ,MAAM,SAAS;AACtC;AAEO,SAAS,gBAAgB,MAAsB;AACpD,UAAQ,MAAM;AAAA,IACZ,KAAK;AACH,aAAO;AAAA,QACL,WAAW;AAAA,QACX,MAAM;AAAA,QACN,YAAY,CAAC,SAAe,KAAK,KAAK;AAAA,MACxC;AAAA,IACF,KAAK;AACH,aAAO;AAAA,QACL,WAAW;AAAA,QACX,MAAM;AAAA,QACN,YAAY,CAAC,SAAe,KAAK,MAAM;AAAA,MACzC;AAAA,IACF,KAAK;AAAA,IACL;AACE,aAAO;AAAA,QACL,WAAW;AAAA,QACX,MAAM;AAAA,QACN,YAAY,CAAC,SAAe,KAAK,MAAM;AAAA,MACzC;AAAA,EACJ;AACF;AACO,SAAS,cACd,EAAE,IAAI,OAAO,GACb;AAAA,EACE;AAAA,EACA,QAAQ;AACV,GACgB;AAChB,QAAM,OAAO,QAAQ,QAAQ,cAAc,QAAQ;AACnD,QAAM,EAAE,WAAW,MAAM,WAAW,IAAI,gBAAgB,IAAI;AAC5D,QAAM,WAAW,QAAQ,YAAY,GAAG,EAAE,IAAI,SAAS;AACvD,QAAM,MAAM,QAAQ,OAAO,cAAc,OAAO;AAChD,QAAM,aAAa,QAAQ,cAAc,cAAc,cAAc;AACrE,QAAM,MAAM,CAAC,YAAY,GAAG,GAAG,KAAK,QAAQ,EAAE;AAAA,IAAO,CAAC,GAAG,SACvD,QAAI,iBAAAE,SAAW,GAAG,IAAI,IAAI;AAAA,EAC5B;AACA,SAAO,EAAE,MAAM,MAAM,UAAU,YAAY,KAAK,YAAY,IAAI;AAClE;;;ALzDA,IAAM,WAAN,MAAe;AAAA,EAAf;AACE,iBAAkC,CAAC;AACnC,wBAAuD,uBAAO,OAAO,IAAI;AAAA;AAAA,EACzE,IAAI,EAAE,MAAM,QAAQ,QAAQ,GAAqB,QAAoB;AACnE,SAAK,SACH,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,EAAE,GAAG,qBAAqB,GAAG,GAAG,KAAK,CAAC,GACpE,IAAI,cAAY;AAAA,MAChB,OAAO,OAAO,SAAS;AAAA,MACvB,aAAa,OAAO,eAAe;AAAA,MACnC,SAAS,OAAO,YAAQ,iBAAAA,SAAW,SAAS,OAAO,IAAI;AAAA,MACvD,WAAW,OAAO,aAAa,QAAQ,WAAW;AAAA,MAClD,MAAM;AAAA,MACN,MAAM;AAAA,MACN,GAAG;AAAA,MACH,QAAQ,cAAc,SAAS,EAAE,SAAS,OAAO,CAAC;AAAA,IACpD,EAAE;AAEF,SAAK,eAAe,KAAK,MAAM;AAAA,MAC7B,CAAC,GAAG,OAAO,EAAE,GAAG,GAAG,CAAC,EAAE,EAAE,GAAG,EAAE;AAAA,MAC7B,uBAAO,OAAO,IAAI;AAAA,IACpB;AAAA,EACF;AAAA,EAGA,IAAI,IAAuE;AACzE,QAAI,IAAI;AACN,aAAO,KAAK,aAAa,EAAE,KAAK;AAAA,IAClC;AACA,WAAO,KAAK,MAAM,MAAM,CAAC;AAAA,EAC3B;AACF;AAEA,SAAS,YACP,OACA,MACA,QACA,SACgC;AAChC,SAAO,QAAQ;AAAA,IACb,MACG,OAAO,aAAW,SAAS,QAAQ,MAAM,MAAM,OAAO,IAAI,CAAC,EAC3D,IAAI,OAAM,YAAW;AACpB,YAAM,QAAQ,QAAQ,SAAS,CAAC,SAAmB;AACnD,YAAM,OAAO,MAAM;AAAA,QACjB,iBAAiB,MAAM,OAAO;AAAA,QAC9B;AAAA,QACA;AAAA,MACF;AACA,aAAO,EAAE,GAAG,MAAM,SAAS,QAAQ,GAAG;AAAA,IACxC,CAAC;AAAA,EACL;AACF;AAEO,SAAS,UAAU,kBAAmD;AAC3E,QAAM,WAAW,IAAI,SAAS;AAM9B,MAAI,iBAGA;AACJ,MAAI;AAEJ,SAAO;AAAA,IACL,MAAM;AAAA,IACN,oBAAoB,OAAO,OAAO,gBAAgB;AAAA,IAClD,YAAY,QAAQ,QAAQ;AAC1B,UAAI,CAAC,QAAQ;AACX,yBAAiB;AACjB;AAAA,MACF;AACA,uBAAiB,CAAC;AAClB,gBAAU;AACV,eAAS,IAAI,kBAAkB,MAAM;AAAA,IACvC;AAAA,IACA,MAAM,eAAe,WAAW;AAC9B,UAAI,CAAC;AAAgB;AAErB,YAAM,WAAW;AAIjB,qBAAe,SAAS,EAAE,IACxB,eAAe,SAAS,EAAE,KAC1B;AAAA,QACE,SAAS,IAAI;AAAA,QACb;AAAA,QACA;AAAA,QACA,iBAAiB;AAAA,MACnB;AAEF,YAAM,QAAQ,MAAM,eAAe,SAAS,EAAE;AAC9C,YAAM,cAAc,IAAI;AAAA,QACtB,YAAY,SAAS,YAAY,UAAU,CAAsB;AAAA,MACnE;AACA,iBAAW,QAAQ,OAAO;AACxB,oBAAY,IAAI,KAAK,OAAO;AAAA,MAC9B;AAEA,eAAS,QAAQ,MAAM,KAAK,aAAa,QAAM;AAC7C,cAAM,EAAE,QAAQ,SAAS,IAAI,SAAS,IAAI,EAAE;AAC5C,eAAO;AAAA,UACL,KAAK,OAAO;AAAA,UACZ,MAAM,OAAO;AAAA,UACb,UAAU,YAAY,SAAS;AAAA,QACjC;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IACA,MAAM,WAAW,QAAQ;AACvB,UAAI,CAAC;AAAgB;AAErB,YAAM,QAAQ;AAAA,QACZ,GAAI,MAAM,QAAQ,IAAI,OAAO,OAAO,cAAc,CAAC;AAAA,MACrD;AACA,YAAM,QAA8B,uBAAO,OAAO,IAAI;AAEtD,iBAAW,EAAE,SAAS,GAAG,KAAK,KAAK,OAAO;AACxC,cAAM,OAAO,IACX,MAAM,OAAO,KACb,IAAI,iBAAK,WAAW,SAAS,IAAI,OAAO,GAAI,MAAM,CAAC;AACrD,cAAM,OAAO,EAAE,QAAQ,IAAI;AAAA,MAC7B;AAEA,iBAAW,CAAC,SAAS,IAAI,KAAK,OAAO,QAAQ,KAAK,GAAG;AACnD,cAAM,EAAE,OAAO,IAAI,SAAS,IAAI,OAAO;AAEvC,cAAM,OAAO,iBAAAE,QAAS;AAAA,UACpB,OAAO,UAAU;AAAA,UACjB,OAAO;AAAA,UACP,OAAO;AAAA,QACT;AACA,cAAM,UAAU,MAAM,OAAO,WAAW,IAAI,CAAC;AAAA,MAC/C;AACA,uBAAiB;AACjB,gBAAU;AAAA,IACZ;AAAA,EACF;AACF","names":["import_node_url","_writeFile","resolveUrl","author","NodePath"],"ignoreList":[],"sources":["../src/index.ts","../src/plugin-rss.ts","../src/exports.ts","../src/feed.ts","../src/internals/lang.ts","../src/internals/node.ts","../src/options.ts"],"sourcesContent":["export * from './plugin-rss';\nexport * from './type';\nexport * from './exports';\nexport * from './options';\nexport * from './feed';\n","import NodePath from 'node:path';\nimport { resolve as resolveUrl } from 'node:url';\nimport type { PageIndexInfo, RspressPlugin, UserConfig } from '@rspress/shared';\nimport { Feed } from 'feed';\nimport { PluginComponents, PluginName } from './exports';\nimport { createFeed, generateFeedItem } from './feed';\n\nimport {\n  PageWithFeeds,\n  ResolvedOutput,\n  concatArray,\n  writeFile,\n} from './internals';\nimport { getDefaultFeedOption, getOutputInfo, testPage } from './options';\nimport type { FeedChannel, FeedItem, PluginRssOptions } from './type';\n\ntype FeedItemWithChannel = FeedItem & { channel: string };\ntype TransformedFeedChannel = FeedChannel & { output: ResolvedOutput };\n\nclass FeedsSet {\n  feeds: TransformedFeedChannel[] = [];\n  feedsMapById: Record<string, TransformedFeedChannel> = Object.create(null);\n  set({ feed, output, siteUrl }: PluginRssOptions, config: UserConfig) {\n    this.feeds = (\n      Array.isArray(feed) ? feed : [{ ...getDefaultFeedOption(), ...feed }]\n    ).map(options => ({\n      title: config.title || '',\n      description: config.description || '',\n      favicon: config.icon && resolveUrl(siteUrl, config.icon),\n      copyright: config.themeConfig?.footer?.message || '',\n      link: siteUrl,\n      docs: '',\n      ...options,\n      output: getOutputInfo(options, { siteUrl, output }),\n    }));\n\n    this.feedsMapById = this.feeds.reduce(\n      (m, f) => ({ ...m, [f.id]: f }),\n      Object.create(null),\n    );\n  }\n  get(): TransformedFeedChannel[];\n  get(id: string): TransformedFeedChannel | null;\n  get(id?: string): TransformedFeedChannel[] | TransformedFeedChannel | null {\n    if (id) {\n      return this.feedsMapById[id] || null;\n    }\n    return this.feeds.slice(0);\n  }\n}\n\nfunction getRssItems(\n  feeds: TransformedFeedChannel[],\n  page: PageIndexInfo,\n  config: UserConfig,\n  siteUrl: string,\n): Promise<FeedItemWithChannel[]> {\n  return Promise.all(\n    feeds\n      .filter(options => testPage(options.test, page, config.base))\n      .map(async options => {\n        const after = options.item || ((feed: FeedItem) => feed);\n        const item = await after(\n          generateFeedItem(page, siteUrl),\n          page,\n          siteUrl,\n        );\n        return { ...item, channel: options.id };\n      }),\n  );\n}\n\nexport function pluginRss(pluginRssOptions: PluginRssOptions): RspressPlugin {\n  const feedsSet = new FeedsSet();\n\n  /**\n   * workaround for retrieving data of pages in `afterBuild`\n   * TODO: get pageData list directly in `afterBuild`\n   **/\n  let _rssWorkaround: null | Record<\n    string,\n    PromiseLike<FeedItemWithChannel[]>\n  > = null;\n  let _config: null | UserConfig;\n\n  return {\n    name: PluginName,\n    globalUIComponents: Object.values(PluginComponents),\n    beforeBuild(config, isProd) {\n      if (!isProd) {\n        _rssWorkaround = null;\n        return;\n      }\n      _rssWorkaround = {};\n      _config = config;\n      feedsSet.set(pluginRssOptions, config);\n    },\n    async extendPageData(_pageData) {\n      if (!_rssWorkaround) return;\n\n      const pageData = _pageData as PageWithFeeds;\n\n      // rspress run `extendPageData` for each page\n      //   - let's cache rss items within a complete rspress build\n      _rssWorkaround[pageData.id] =\n        _rssWorkaround[pageData.id] ||\n        getRssItems(\n          feedsSet.get(),\n          pageData,\n          _config!,\n          pluginRssOptions.siteUrl,\n        );\n\n      const feeds = await _rssWorkaround[pageData.id];\n      const showRssList = new Set(\n        concatArray(pageData.frontmatter['link-rss'] as string[] | string),\n      );\n      for (const feed of feeds) {\n        showRssList.add(feed.channel);\n      }\n\n      pageData.feeds = Array.from(showRssList, id => {\n        const { output, language } = feedsSet.get(id)!;\n        return {\n          url: output.url,\n          mime: output.mime,\n          language: language || pageData.lang,\n        };\n      });\n    },\n    async afterBuild(config) {\n      if (!_rssWorkaround) return;\n\n      const items = concatArray(\n        ...(await Promise.all(Object.values(_rssWorkaround))),\n      );\n      const feeds: Record<string, Feed> = Object.create(null);\n\n      for (const { channel, ...item } of items) {\n        feeds[channel] =\n          feeds[channel] ||\n          new Feed(createFeed(feedsSet.get(channel)!, config));\n        feeds[channel].addItem(item);\n      }\n\n      for (const [channel, feed] of Object.entries(feeds)) {\n        const { output } = feedsSet.get(channel)!;\n\n        const path = NodePath.resolve(\n          config.outDir || 'doc_build',\n          output.dir,\n          output.filename,\n        );\n        await writeFile(path, output.getContent(feed));\n      }\n      _rssWorkaround = null;\n      _config = null;\n    },\n  };\n}\n","export const PluginName = '@rspress/plugin-rss';\n\nexport const PluginComponents = {\n  FeedsAnnotations: '@rspress/plugin-rss/FeedsAnnotations',\n} as const;\n","import { resolve as resolveUrl } from 'node:url';\nimport type { PageIndexInfo, UserConfig } from '@rspress/shared';\nimport type { Author, FeedOptions } from 'feed';\nimport {\n  ResolvedOutput,\n  concatArray,\n  selectNonNullishProperty,\n  toDate,\n} from './internals';\nimport type { FeedChannel, FeedItem } from './type';\n\n/**\n * @public\n * @param page Rspress Page Data\n * @param siteUrl\n */\nexport function generateFeedItem(page: PageIndexInfo, siteUrl: string) {\n  const { frontmatter: fm } = page;\n  return {\n    id: selectNonNullishProperty(fm.slug, fm.id, page.id) || '',\n    title: selectNonNullishProperty(fm.title, page.title) || '',\n    author: toAuthors(fm.author),\n    link: resolveUrl(\n      siteUrl,\n      selectNonNullishProperty(fm.permalink, page.routePath) || '',\n    ),\n    description: selectNonNullishProperty(fm.description) || '',\n    content: selectNonNullishProperty(fm.summary, page.content) || '',\n    date: toDate((fm.date as string) || (fm.published_at as string))!,\n    category: concatArray(fm.categories as string[], fm.category as string).map(\n      cat => ({ name: cat }),\n    ),\n  } satisfies FeedItem;\n}\n\nexport function createFeed(\n  options: Omit<FeedChannel, 'test' | 'item' | 'output'> & {\n    item?: any;\n    test?: any;\n    output: ResolvedOutput;\n  },\n  config: UserConfig,\n): FeedOptions {\n  const { output, item, id, title, ..._options } = options;\n  return {\n    id,\n    copyright: config.themeConfig?.footer?.message || '',\n    description: config.description || '',\n    link: output.url,\n    ..._options,\n    title: title || config.title || '',\n  };\n}\n\nfunction toAuthors(author: unknown): Author[] | undefined {\n  const authors = (Array.isArray(author) ? author : [author])\n    .filter(Boolean)\n    .map(author => ({\n      // email is mandatory for RSS 2.0.\n      ...(typeof author === 'string' ? { name: author } : author),\n    }));\n  return authors.length ? authors : undefined;\n}\n","export type PartialPartial<T, K extends keyof T> = Partial<Pick<T, K>> &\n  Omit<T, K>;\n\nexport type ItemOf<T> = T extends Array<infer K> ? K : never;\n\nexport function notNullish<T>(n: T | undefined | null): n is T {\n  return n !== undefined && n !== null;\n}\nexport function concatArray<T>(...arrList: (T[] | T | undefined)[]) {\n  return arrList.reduce<T[]>(\n    (arr, item) =>\n      arr.concat((Array.isArray(item) ? item : [item]).filter(notNullish)),\n    [] as T[],\n  );\n}\n\nexport function selectNonNullishProperty(...list: unknown[]) {\n  for (const item of list) {\n    if (item === '') return '';\n    if (item === 0) return '0';\n    if (typeof item === 'number') return `${item}`;\n    if (typeof item === 'string') return item;\n  }\n}\n\nexport function toDate(s: string | Date): null | Date {\n  const d = new Date(s);\n  return Number.isNaN(d.getDate()) ? null : d;\n}\n","import { mkdir, writeFile as _writeFile } from 'node:fs/promises';\nimport * as NodePath from 'node:path';\n\nexport async function writeFile(path: string, content: string | Buffer) {\n  const dir = NodePath.dirname(path);\n  await mkdir(dir, { mode: 0o755, recursive: true });\n  return _writeFile(path, content);\n}\n","import { resolve as resolveUrl } from 'node:url';\nimport type { PageIndexInfo } from '@rspress/shared';\nimport { Feed } from 'feed';\nimport type { ResolvedOutput } from './internals';\nimport type { FeedChannel, FeedOutputType, PluginRssOptions } from './type';\n\nexport function testPage(\n  test: FeedChannel['test'],\n  page: PageIndexInfo,\n  base = '/',\n): boolean {\n  if (Array.isArray(test)) {\n    return test.some(item => testPage(item, page, base));\n  }\n  if (typeof test === 'function') {\n    return test(page, base);\n  }\n  const routePath = page.routePath;\n  const pureRoutePath = `/${\n    routePath.startsWith(base) ? routePath.slice(base.length) : routePath\n  }`.replace(/^\\/+/, '/');\n  if (typeof test === 'string') {\n    return [routePath, pureRoutePath].some(path => path.startsWith(test));\n  }\n  if (test instanceof RegExp) {\n    return [routePath, pureRoutePath].some(path => test.test(path));\n  }\n\n  throw new Error(\n    'test must be of `RegExp` or `string` or `(page: PageIndexInfo, base: string) => boolean`',\n  );\n}\n\nexport function getDefaultFeedOption() {\n  return { id: 'blog', test: '/blog/' } satisfies FeedChannel;\n}\n\nexport function getFeedFileType(type: FeedOutputType) {\n  switch (type) {\n    case 'rss':\n      return {\n        extension: 'rss',\n        mime: 'application/rss+xml',\n        getContent: (feed: Feed) => feed.rss2(),\n      };\n    case 'json':\n      return {\n        extension: 'json',\n        mime: 'application/json',\n        getContent: (feed: Feed) => feed.json1(),\n      };\n    case 'atom':\n    default:\n      return {\n        extension: 'xml',\n        mime: 'application/atom+xml',\n        getContent: (feed: Feed) => feed.atom1(),\n      };\n  }\n}\nexport function getOutputInfo(\n  { id, output }: Pick<FeedChannel, 'id' | 'output'>,\n  {\n    siteUrl,\n    output: globalOutput,\n  }: Pick<PluginRssOptions, 'output' | 'siteUrl'>,\n): ResolvedOutput {\n  const type = output?.type || globalOutput?.type || 'atom';\n  const { extension, mime, getContent } = getFeedFileType(type);\n  const filename = output?.filename || `${id}.${extension}`;\n  const dir = output?.dir || globalOutput?.dir || 'rss';\n  const publicPath = output?.publicPath || globalOutput?.publicPath || siteUrl;\n  const url = [publicPath, `${dir}/`, filename].reduce((u, part) =>\n    u ? resolveUrl(u, part) : part,\n  );\n  return { type, mime, filename, getContent, dir, publicPath, url };\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,136 @@
+import { PageIndexInfo, RspressPlugin, UserConfig } from '@rspress/shared';
+import { Feed, Item, FeedOptions, Author } from 'feed';
+
+interface ResolvedOutput {
+    type: FeedOutputType;
+    mime: string;
+    filename: string;
+    getContent: (feed: Feed) => string;
+    dir: string;
+    publicPath: string;
+    url: string;
+}
+
+type PartialPartial<T, K extends keyof T> = Partial<Pick<T, K>> & Omit<T, K>;
+
+/**
+ * feed information attached in `PageIndexInfo['feeds']` array
+ */
+interface PageFeedData {
+    url: string;
+    language: string;
+    mime: string;
+}
+type FeedItem = Item;
+/**
+ * output feed file type
+ */
+type FeedOutputType = /** Atom 1.0 Feed */ 'atom' | /** RSS 2.0 Feed */ 'rss' | /** JSON1 Feed */ 'json';
+/**
+ * output config of a feed.
+ * a feed will be written into path `${rspress.outDir || 'doc_build'}/${dir}/${filename}`
+ */
+interface FeedOutputOptions {
+    /**
+     * output dir of feed files, relative to rspress's outDir
+     */
+    dir?: string;
+    /**
+     * type of feed files
+     */
+    type?: FeedOutputType;
+    /**
+     * base filename of feed files. `${id}.${extension by type}` by default.
+     */
+    filename?: string;
+    /**
+     * public path of feed files. siteUrl by default
+     */
+    publicPath?: string;
+}
+interface FeedChannel extends PartialPartial<FeedOptions, 'title' | 'copyright'> {
+    /**
+     * used as the basename of rss file, should be unique
+     **/
+    id: string;
+    /**
+     * to match pages that should be listed in this feed
+     * if RegExp is given, it will match against the route path of each page
+     **/
+    test: RegExp | string | (RegExp | string)[] | ((item: PageIndexInfo, base: string) => boolean);
+    /**
+     * a function to modify feed item
+     * @param item pre-generated feed item
+     * @param page page data
+     * @param base base path of the rspress site
+     * @returns modified feed item
+     */
+    item?: (item: FeedItem, page: PageIndexInfo, base: string) => FeedItem | PromiseLike<FeedItem>;
+    /**
+     * feed level output config
+     */
+    output?: FeedOutputOptions;
+}
+/**
+ * plugin options for `pluginRss`
+ */
+interface PluginRssOptions {
+    /**
+     * site url of this rspress site. it will be used in feed files and feed link.
+     * @requires
+     */
+    siteUrl: string;
+    /**
+     * Feed options for each rss. If array is given, this plugin will produce multiple feed files.
+     * @default {{ id: 'blog', test: /^\/blog\// }}
+     */
+    feed?: PartialPartial<FeedChannel, 'id' | 'test'> | FeedChannel[];
+    /**
+     * output config for all feed files
+     */
+    output?: Omit<FeedOutputOptions, 'filename'>;
+}
+
+declare function pluginRss(pluginRssOptions: PluginRssOptions): RspressPlugin;
+
+declare const PluginName = "@rspress/plugin-rss";
+declare const PluginComponents: {
+    readonly FeedsAnnotations: "@rspress/plugin-rss/FeedsAnnotations";
+};
+
+declare function testPage(test: FeedChannel['test'], page: PageIndexInfo, base?: string): boolean;
+declare function getDefaultFeedOption(): {
+    id: string;
+    test: string;
+};
+declare function getFeedFileType(type: FeedOutputType): {
+    extension: string;
+    mime: string;
+    getContent: (feed: Feed) => string;
+};
+declare function getOutputInfo({ id, output }: Pick<FeedChannel, 'id' | 'output'>, { siteUrl, output: globalOutput, }: Pick<PluginRssOptions, 'output' | 'siteUrl'>): ResolvedOutput;
+
+/**
+ * @public
+ * @param page Rspress Page Data
+ * @param siteUrl
+ */
+declare function generateFeedItem(page: PageIndexInfo, siteUrl: string): {
+    id: string;
+    title: string;
+    author: Author[] | undefined;
+    link: string;
+    description: string;
+    content: string;
+    date: Date;
+    category: {
+        name: string;
+    }[];
+};
+declare function createFeed(options: Omit<FeedChannel, 'test' | 'item' | 'output'> & {
+    item?: any;
+    test?: any;
+    output: ResolvedOutput;
+}, config: UserConfig): FeedOptions;
+
+export { type FeedChannel, type FeedItem, type FeedOutputOptions, type FeedOutputType, type PageFeedData, PluginComponents, PluginName, type PluginRssOptions, createFeed, generateFeedItem, getDefaultFeedOption, getFeedFileType, getOutputInfo, pluginRss, testPage };

package/dist/index.mjs

@@ -0,0 +1,272 @@
+// src/plugin-rss.ts
+import NodePath2 from "path";
+import { resolve as resolveUrl3 } from "url";
+import { Feed } from "feed";
+
+// src/exports.ts
+var PluginName = "@rspress/plugin-rss";
+var PluginComponents = {
+  FeedsAnnotations: "@rspress/plugin-rss/FeedsAnnotations"
+};
+
+// src/feed.ts
+import { resolve as resolveUrl } from "url";
+
+// src/internals/lang.ts
+function notNullish(n) {
+  return n !== void 0 && n !== null;
+}
+function concatArray(...arrList) {
+  return arrList.reduce(
+    (arr, item) => arr.concat((Array.isArray(item) ? item : [item]).filter(notNullish)),
+    []
+  );
+}
+function selectNonNullishProperty(...list) {
+  for (const item of list) {
+    if (item === "")
+      return "";
+    if (item === 0)
+      return "0";
+    if (typeof item === "number")
+      return `${item}`;
+    if (typeof item === "string")
+      return item;
+  }
+}
+function toDate(s) {
+  const d = new Date(s);
+  return Number.isNaN(d.getDate()) ? null : d;
+}
+
+// src/internals/node.ts
+import { mkdir, writeFile as _writeFile } from "fs/promises";
+import * as NodePath from "path";
+async function writeFile(path, content) {
+  const dir = NodePath.dirname(path);
+  await mkdir(dir, { mode: 493, recursive: true });
+  return _writeFile(path, content);
+}
+
+// src/feed.ts
+function generateFeedItem(page, siteUrl) {
+  const { frontmatter: fm } = page;
+  return {
+    id: selectNonNullishProperty(fm.slug, fm.id, page.id) || "",
+    title: selectNonNullishProperty(fm.title, page.title) || "",
+    author: toAuthors(fm.author),
+    link: resolveUrl(
+      siteUrl,
+      selectNonNullishProperty(fm.permalink, page.routePath) || ""
+    ),
+    description: selectNonNullishProperty(fm.description) || "",
+    content: selectNonNullishProperty(fm.summary, page.content) || "",
+    date: toDate(fm.date || fm.published_at),
+    category: concatArray(fm.categories, fm.category).map(
+      (cat) => ({ name: cat })
+    )
+  };
+}
+function createFeed(options, config) {
+  const { output, item, id, title, ..._options } = options;
+  return {
+    id,
+    copyright: config.themeConfig?.footer?.message || "",
+    description: config.description || "",
+    link: output.url,
+    ..._options,
+    title: title || config.title || ""
+  };
+}
+function toAuthors(author) {
+  const authors = (Array.isArray(author) ? author : [author]).filter(Boolean).map((author2) => ({
+    // email is mandatory for RSS 2.0.
+    ...typeof author2 === "string" ? { name: author2 } : author2
+  }));
+  return authors.length ? authors : void 0;
+}
+
+// src/options.ts
+import { resolve as resolveUrl2 } from "url";
+function testPage(test, page, base = "/") {
+  if (Array.isArray(test)) {
+    return test.some((item) => testPage(item, page, base));
+  }
+  if (typeof test === "function") {
+    return test(page, base);
+  }
+  const routePath = page.routePath;
+  const pureRoutePath = `/${routePath.startsWith(base) ? routePath.slice(base.length) : routePath}`.replace(/^\/+/, "/");
+  if (typeof test === "string") {
+    return [routePath, pureRoutePath].some((path) => path.startsWith(test));
+  }
+  if (test instanceof RegExp) {
+    return [routePath, pureRoutePath].some((path) => test.test(path));
+  }
+  throw new Error(
+    "test must be of `RegExp` or `string` or `(page: PageIndexInfo, base: string) => boolean`"
+  );
+}
+function getDefaultFeedOption() {
+  return { id: "blog", test: "/blog/" };
+}
+function getFeedFileType(type) {
+  switch (type) {
+    case "rss":
+      return {
+        extension: "rss",
+        mime: "application/rss+xml",
+        getContent: (feed) => feed.rss2()
+      };
+    case "json":
+      return {
+        extension: "json",
+        mime: "application/json",
+        getContent: (feed) => feed.json1()
+      };
+    case "atom":
+    default:
+      return {
+        extension: "xml",
+        mime: "application/atom+xml",
+        getContent: (feed) => feed.atom1()
+      };
+  }
+}
+function getOutputInfo({ id, output }, {
+  siteUrl,
+  output: globalOutput
+}) {
+  const type = output?.type || globalOutput?.type || "atom";
+  const { extension, mime, getContent } = getFeedFileType(type);
+  const filename = output?.filename || `${id}.${extension}`;
+  const dir = output?.dir || globalOutput?.dir || "rss";
+  const publicPath = output?.publicPath || globalOutput?.publicPath || siteUrl;
+  const url = [publicPath, `${dir}/`, filename].reduce(
+    (u, part) => u ? resolveUrl2(u, part) : part
+  );
+  return { type, mime, filename, getContent, dir, publicPath, url };
+}
+
+// src/plugin-rss.ts
+var FeedsSet = class {
+  constructor() {
+    this.feeds = [];
+    this.feedsMapById = /* @__PURE__ */ Object.create(null);
+  }
+  set({ feed, output, siteUrl }, config) {
+    this.feeds = (Array.isArray(feed) ? feed : [{ ...getDefaultFeedOption(), ...feed }]).map((options) => ({
+      title: config.title || "",
+      description: config.description || "",
+      favicon: config.icon && resolveUrl3(siteUrl, config.icon),
+      copyright: config.themeConfig?.footer?.message || "",
+      link: siteUrl,
+      docs: "",
+      ...options,
+      output: getOutputInfo(options, { siteUrl, output })
+    }));
+    this.feedsMapById = this.feeds.reduce(
+      (m, f) => ({ ...m, [f.id]: f }),
+      /* @__PURE__ */ Object.create(null)
+    );
+  }
+  get(id) {
+    if (id) {
+      return this.feedsMapById[id] || null;
+    }
+    return this.feeds.slice(0);
+  }
+};
+function getRssItems(feeds, page, config, siteUrl) {
+  return Promise.all(
+    feeds.filter((options) => testPage(options.test, page, config.base)).map(async (options) => {
+      const after = options.item || ((feed) => feed);
+      const item = await after(
+        generateFeedItem(page, siteUrl),
+        page,
+        siteUrl
+      );
+      return { ...item, channel: options.id };
+    })
+  );
+}
+function pluginRss(pluginRssOptions) {
+  const feedsSet = new FeedsSet();
+  let _rssWorkaround = null;
+  let _config;
+  return {
+    name: PluginName,
+    globalUIComponents: Object.values(PluginComponents),
+    beforeBuild(config, isProd) {
+      if (!isProd) {
+        _rssWorkaround = null;
+        return;
+      }
+      _rssWorkaround = {};
+      _config = config;
+      feedsSet.set(pluginRssOptions, config);
+    },
+    async extendPageData(_pageData) {
+      if (!_rssWorkaround)
+        return;
+      const pageData = _pageData;
+      _rssWorkaround[pageData.id] = _rssWorkaround[pageData.id] || getRssItems(
+        feedsSet.get(),
+        pageData,
+        _config,
+        pluginRssOptions.siteUrl
+      );
+      const feeds = await _rssWorkaround[pageData.id];
+      const showRssList = new Set(
+        concatArray(pageData.frontmatter["link-rss"])
+      );
+      for (const feed of feeds) {
+        showRssList.add(feed.channel);
+      }
+      pageData.feeds = Array.from(showRssList, (id) => {
+        const { output, language } = feedsSet.get(id);
+        return {
+          url: output.url,
+          mime: output.mime,
+          language: language || pageData.lang
+        };
+      });
+    },
+    async afterBuild(config) {
+      if (!_rssWorkaround)
+        return;
+      const items = concatArray(
+        ...await Promise.all(Object.values(_rssWorkaround))
+      );
+      const feeds = /* @__PURE__ */ Object.create(null);
+      for (const { channel, ...item } of items) {
+        feeds[channel] = feeds[channel] || new Feed(createFeed(feedsSet.get(channel), config));
+        feeds[channel].addItem(item);
+      }
+      for (const [channel, feed] of Object.entries(feeds)) {
+        const { output } = feedsSet.get(channel);
+        const path = NodePath2.resolve(
+          config.outDir || "doc_build",
+          output.dir,
+          output.filename
+        );
+        await writeFile(path, output.getContent(feed));
+      }
+      _rssWorkaround = null;
+      _config = null;
+    }
+  };
+}
+export {
+  PluginComponents,
+  PluginName,
+  createFeed,
+  generateFeedItem,
+  getDefaultFeedOption,
+  getFeedFileType,
+  getOutputInfo,
+  pluginRss,
+  testPage
+};
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"mappings":";AAAA,OAAOA,eAAc;AACrB,SAAS,WAAWC,mBAAkB;AAEtC,SAAS,YAAY;;;ACHd,IAAM,aAAa;AAEnB,IAAM,mBAAmB;AAAA,EAC9B,kBAAkB;AACpB;;;ACJA,SAAS,WAAW,kBAAkB;;;ACK/B,SAAS,WAAc,GAAiC;AAC7D,SAAO,MAAM,UAAa,MAAM;AAClC;AACO,SAAS,eAAkB,SAAkC;AAClE,SAAO,QAAQ;AAAA,IACb,CAAC,KAAK,SACJ,IAAI,QAAQ,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,IAAI,GAAG,OAAO,UAAU,CAAC;AAAA,IACrE,CAAC;AAAA,EACH;AACF;AAEO,SAAS,4BAA4B,MAAiB;AAC3D,aAAW,QAAQ,MAAM;AACvB,QAAI,SAAS;AAAI,aAAO;AACxB,QAAI,SAAS;AAAG,aAAO;AACvB,QAAI,OAAO,SAAS;AAAU,aAAO,GAAG,IAAI;AAC5C,QAAI,OAAO,SAAS;AAAU,aAAO;AAAA,EACvC;AACF;AAEO,SAAS,OAAO,GAA+B;AACpD,QAAM,IAAI,IAAI,KAAK,CAAC;AACpB,SAAO,OAAO,MAAM,EAAE,QAAQ,CAAC,IAAI,OAAO;AAC5C;;;AC5BA,SAAS,OAAO,aAAa,kBAAkB;AAC/C,YAAY,cAAc;AAE1B,eAAsB,UAAU,MAAc,SAA0B;AACtE,QAAM,MAAe,iBAAQ,IAAI;AACjC,QAAM,MAAM,KAAK,EAAE,MAAM,KAAO,WAAW,KAAK,CAAC;AACjD,SAAO,WAAW,MAAM,OAAO;AACjC;;;AFSO,SAAS,iBAAiB,MAAqB,SAAiB;AACrE,QAAM,EAAE,aAAa,GAAG,IAAI;AAC5B,SAAO;AAAA,IACL,IAAI,yBAAyB,GAAG,MAAM,GAAG,IAAI,KAAK,EAAE,KAAK;AAAA,IACzD,OAAO,yBAAyB,GAAG,OAAO,KAAK,KAAK,KAAK;AAAA,IACzD,QAAQ,UAAU,GAAG,MAAM;AAAA,IAC3B,MAAM;AAAA,MACJ;AAAA,MACA,yBAAyB,GAAG,WAAW,KAAK,SAAS,KAAK;AAAA,IAC5D;AAAA,IACA,aAAa,yBAAyB,GAAG,WAAW,KAAK;AAAA,IACzD,SAAS,yBAAyB,GAAG,SAAS,KAAK,OAAO,KAAK;AAAA,IAC/D,MAAM,OAAQ,GAAG,QAAoB,GAAG,YAAuB;AAAA,IAC/D,UAAU,YAAY,GAAG,YAAwB,GAAG,QAAkB,EAAE;AAAA,MACtE,UAAQ,EAAE,MAAM,IAAI;AAAA,IACtB;AAAA,EACF;AACF;AAEO,SAAS,WACd,SAKA,QACa;AACb,QAAM,EAAE,QAAQ,MAAM,IAAI,OAAO,GAAG,SAAS,IAAI;AACjD,SAAO;AAAA,IACL;AAAA,IACA,WAAW,OAAO,aAAa,QAAQ,WAAW;AAAA,IAClD,aAAa,OAAO,eAAe;AAAA,IACnC,MAAM,OAAO;AAAA,IACb,GAAG;AAAA,IACH,OAAO,SAAS,OAAO,SAAS;AAAA,EAClC;AACF;AAEA,SAAS,UAAU,QAAuC;AACxD,QAAM,WAAW,MAAM,QAAQ,MAAM,IAAI,SAAS,CAAC,MAAM,GACtD,OAAO,OAAO,EACd,IAAI,CAAAC,aAAW;AAAA;AAAA,IAEd,GAAI,OAAOA,YAAW,WAAW,EAAE,MAAMA,QAAO,IAAIA;AAAA,EACtD,EAAE;AACJ,SAAO,QAAQ,SAAS,UAAU;AACpC;;;AG9DA,SAAS,WAAWD,mBAAkB;AAM/B,SAAS,SACd,MACA,MACA,OAAO,KACE;AACT,MAAI,MAAM,QAAQ,IAAI,GAAG;AACvB,WAAO,KAAK,KAAK,UAAQ,SAAS,MAAM,MAAM,IAAI,CAAC;AAAA,EACrD;AACA,MAAI,OAAO,SAAS,YAAY;AAC9B,WAAO,KAAK,MAAM,IAAI;AAAA,EACxB;AACA,QAAM,YAAY,KAAK;AACvB,QAAM,gBAAgB,IACpB,UAAU,WAAW,IAAI,IAAI,UAAU,MAAM,KAAK,MAAM,IAAI,SAC9D,GAAG,QAAQ,QAAQ,GAAG;AACtB,MAAI,OAAO,SAAS,UAAU;AAC5B,WAAO,CAAC,WAAW,aAAa,EAAE,KAAK,UAAQ,KAAK,WAAW,IAAI,CAAC;AAAA,EACtE;AACA,MAAI,gBAAgB,QAAQ;AAC1B,WAAO,CAAC,WAAW,aAAa,EAAE,KAAK,UAAQ,KAAK,KAAK,IAAI,CAAC;AAAA,EAChE;AAEA,QAAM,IAAI;AAAA,IACR;AAAA,EACF;AACF;AAEO,SAAS,uBAAuB;AACrC,SAAO,EAAE,IAAI,QAAQ,MAAM,SAAS;AACtC;AAEO,SAAS,gBAAgB,MAAsB;AACpD,UAAQ,MAAM;AAAA,IACZ,KAAK;AACH,aAAO;AAAA,QACL,WAAW;AAAA,QACX,MAAM;AAAA,QACN,YAAY,CAAC,SAAe,KAAK,KAAK;AAAA,MACxC;AAAA,IACF,KAAK;AACH,aAAO;AAAA,QACL,WAAW;AAAA,QACX,MAAM;AAAA,QACN,YAAY,CAAC,SAAe,KAAK,MAAM;AAAA,MACzC;AAAA,IACF,KAAK;AAAA,IACL;AACE,aAAO;AAAA,QACL,WAAW;AAAA,QACX,MAAM;AAAA,QACN,YAAY,CAAC,SAAe,KAAK,MAAM;AAAA,MACzC;AAAA,EACJ;AACF;AACO,SAAS,cACd,EAAE,IAAI,OAAO,GACb;AAAA,EACE;AAAA,EACA,QAAQ;AACV,GACgB;AAChB,QAAM,OAAO,QAAQ,QAAQ,cAAc,QAAQ;AACnD,QAAM,EAAE,WAAW,MAAM,WAAW,IAAI,gBAAgB,IAAI;AAC5D,QAAM,WAAW,QAAQ,YAAY,GAAG,EAAE,IAAI,SAAS;AACvD,QAAM,MAAM,QAAQ,OAAO,cAAc,OAAO;AAChD,QAAM,aAAa,QAAQ,cAAc,cAAc,cAAc;AACrE,QAAM,MAAM,CAAC,YAAY,GAAG,GAAG,KAAK,QAAQ,EAAE;AAAA,IAAO,CAAC,GAAG,SACvD,IAAIA,YAAW,GAAG,IAAI,IAAI;AAAA,EAC5B;AACA,SAAO,EAAE,MAAM,MAAM,UAAU,YAAY,KAAK,YAAY,IAAI;AAClE;;;ALzDA,IAAM,WAAN,MAAe;AAAA,EAAf;AACE,iBAAkC,CAAC;AACnC,wBAAuD,uBAAO,OAAO,IAAI;AAAA;AAAA,EACzE,IAAI,EAAE,MAAM,QAAQ,QAAQ,GAAqB,QAAoB;AACnE,SAAK,SACH,MAAM,QAAQ,IAAI,IAAI,OAAO,CAAC,EAAE,GAAG,qBAAqB,GAAG,GAAG,KAAK,CAAC,GACpE,IAAI,cAAY;AAAA,MAChB,OAAO,OAAO,SAAS;AAAA,MACvB,aAAa,OAAO,eAAe;AAAA,MACnC,SAAS,OAAO,QAAQA,YAAW,SAAS,OAAO,IAAI;AAAA,MACvD,WAAW,OAAO,aAAa,QAAQ,WAAW;AAAA,MAClD,MAAM;AAAA,MACN,MAAM;AAAA,MACN,GAAG;AAAA,MACH,QAAQ,cAAc,SAAS,EAAE,SAAS,OAAO,CAAC;AAAA,IACpD,EAAE;AAEF,SAAK,eAAe,KAAK,MAAM;AAAA,MAC7B,CAAC,GAAG,OAAO,EAAE,GAAG,GAAG,CAAC,EAAE,EAAE,GAAG,EAAE;AAAA,MAC7B,uBAAO,OAAO,IAAI;AAAA,IACpB;AAAA,EACF;AAAA,EAGA,IAAI,IAAuE;AACzE,QAAI,IAAI;AACN,aAAO,KAAK,aAAa,EAAE,KAAK;AAAA,IAClC;AACA,WAAO,KAAK,MAAM,MAAM,CAAC;AAAA,EAC3B;AACF;AAEA,SAAS,YACP,OACA,MACA,QACA,SACgC;AAChC,SAAO,QAAQ;AAAA,IACb,MACG,OAAO,aAAW,SAAS,QAAQ,MAAM,MAAM,OAAO,IAAI,CAAC,EAC3D,IAAI,OAAM,YAAW;AACpB,YAAM,QAAQ,QAAQ,SAAS,CAAC,SAAmB;AACnD,YAAM,OAAO,MAAM;AAAA,QACjB,iBAAiB,MAAM,OAAO;AAAA,QAC9B;AAAA,QACA;AAAA,MACF;AACA,aAAO,EAAE,GAAG,MAAM,SAAS,QAAQ,GAAG;AAAA,IACxC,CAAC;AAAA,EACL;AACF;AAEO,SAAS,UAAU,kBAAmD;AAC3E,QAAM,WAAW,IAAI,SAAS;AAM9B,MAAI,iBAGA;AACJ,MAAI;AAEJ,SAAO;AAAA,IACL,MAAM;AAAA,IACN,oBAAoB,OAAO,OAAO,gBAAgB;AAAA,IAClD,YAAY,QAAQ,QAAQ;AAC1B,UAAI,CAAC,QAAQ;AACX,yBAAiB;AACjB;AAAA,MACF;AACA,uBAAiB,CAAC;AAClB,gBAAU;AACV,eAAS,IAAI,kBAAkB,MAAM;AAAA,IACvC;AAAA,IACA,MAAM,eAAe,WAAW;AAC9B,UAAI,CAAC;AAAgB;AAErB,YAAM,WAAW;AAIjB,qBAAe,SAAS,EAAE,IACxB,eAAe,SAAS,EAAE,KAC1B;AAAA,QACE,SAAS,IAAI;AAAA,QACb;AAAA,QACA;AAAA,QACA,iBAAiB;AAAA,MACnB;AAEF,YAAM,QAAQ,MAAM,eAAe,SAAS,EAAE;AAC9C,YAAM,cAAc,IAAI;AAAA,QACtB,YAAY,SAAS,YAAY,UAAU,CAAsB;AAAA,MACnE;AACA,iBAAW,QAAQ,OAAO;AACxB,oBAAY,IAAI,KAAK,OAAO;AAAA,MAC9B;AAEA,eAAS,QAAQ,MAAM,KAAK,aAAa,QAAM;AAC7C,cAAM,EAAE,QAAQ,SAAS,IAAI,SAAS,IAAI,EAAE;AAC5C,eAAO;AAAA,UACL,KAAK,OAAO;AAAA,UACZ,MAAM,OAAO;AAAA,UACb,UAAU,YAAY,SAAS;AAAA,QACjC;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IACA,MAAM,WAAW,QAAQ;AACvB,UAAI,CAAC;AAAgB;AAErB,YAAM,QAAQ;AAAA,QACZ,GAAI,MAAM,QAAQ,IAAI,OAAO,OAAO,cAAc,CAAC;AAAA,MACrD;AACA,YAAM,QAA8B,uBAAO,OAAO,IAAI;AAEtD,iBAAW,EAAE,SAAS,GAAG,KAAK,KAAK,OAAO;AACxC,cAAM,OAAO,IACX,MAAM,OAAO,KACb,IAAI,KAAK,WAAW,SAAS,IAAI,OAAO,GAAI,MAAM,CAAC;AACrD,cAAM,OAAO,EAAE,QAAQ,IAAI;AAAA,MAC7B;AAEA,iBAAW,CAAC,SAAS,IAAI,KAAK,OAAO,QAAQ,KAAK,GAAG;AACnD,cAAM,EAAE,OAAO,IAAI,SAAS,IAAI,OAAO;AAEvC,cAAM,OAAOD,UAAS;AAAA,UACpB,OAAO,UAAU;AAAA,UACjB,OAAO;AAAA,UACP,OAAO;AAAA,QACT;AACA,cAAM,UAAU,MAAM,OAAO,WAAW,IAAI,CAAC;AAAA,MAC/C;AACA,uBAAiB;AACjB,gBAAU;AAAA,IACZ;AAAA,EACF;AACF","names":["NodePath","resolveUrl","author"],"ignoreList":[],"sources":["../src/plugin-rss.ts","../src/exports.ts","../src/feed.ts","../src/internals/lang.ts","../src/internals/node.ts","../src/options.ts"],"sourcesContent":["import NodePath from 'node:path';\nimport { resolve as resolveUrl } from 'node:url';\nimport type { PageIndexInfo, RspressPlugin, UserConfig } from '@rspress/shared';\nimport { Feed } from 'feed';\nimport { PluginComponents, PluginName } from './exports';\nimport { createFeed, generateFeedItem } from './feed';\n\nimport {\n  PageWithFeeds,\n  ResolvedOutput,\n  concatArray,\n  writeFile,\n} from './internals';\nimport { getDefaultFeedOption, getOutputInfo, testPage } from './options';\nimport type { FeedChannel, FeedItem, PluginRssOptions } from './type';\n\ntype FeedItemWithChannel = FeedItem & { channel: string };\ntype TransformedFeedChannel = FeedChannel & { output: ResolvedOutput };\n\nclass FeedsSet {\n  feeds: TransformedFeedChannel[] = [];\n  feedsMapById: Record<string, TransformedFeedChannel> = Object.create(null);\n  set({ feed, output, siteUrl }: PluginRssOptions, config: UserConfig) {\n    this.feeds = (\n      Array.isArray(feed) ? feed : [{ ...getDefaultFeedOption(), ...feed }]\n    ).map(options => ({\n      title: config.title || '',\n      description: config.description || '',\n      favicon: config.icon && resolveUrl(siteUrl, config.icon),\n      copyright: config.themeConfig?.footer?.message || '',\n      link: siteUrl,\n      docs: '',\n      ...options,\n      output: getOutputInfo(options, { siteUrl, output }),\n    }));\n\n    this.feedsMapById = this.feeds.reduce(\n      (m, f) => ({ ...m, [f.id]: f }),\n      Object.create(null),\n    );\n  }\n  get(): TransformedFeedChannel[];\n  get(id: string): TransformedFeedChannel | null;\n  get(id?: string): TransformedFeedChannel[] | TransformedFeedChannel | null {\n    if (id) {\n      return this.feedsMapById[id] || null;\n    }\n    return this.feeds.slice(0);\n  }\n}\n\nfunction getRssItems(\n  feeds: TransformedFeedChannel[],\n  page: PageIndexInfo,\n  config: UserConfig,\n  siteUrl: string,\n): Promise<FeedItemWithChannel[]> {\n  return Promise.all(\n    feeds\n      .filter(options => testPage(options.test, page, config.base))\n      .map(async options => {\n        const after = options.item || ((feed: FeedItem) => feed);\n        const item = await after(\n          generateFeedItem(page, siteUrl),\n          page,\n          siteUrl,\n        );\n        return { ...item, channel: options.id };\n      }),\n  );\n}\n\nexport function pluginRss(pluginRssOptions: PluginRssOptions): RspressPlugin {\n  const feedsSet = new FeedsSet();\n\n  /**\n   * workaround for retrieving data of pages in `afterBuild`\n   * TODO: get pageData list directly in `afterBuild`\n   **/\n  let _rssWorkaround: null | Record<\n    string,\n    PromiseLike<FeedItemWithChannel[]>\n  > = null;\n  let _config: null | UserConfig;\n\n  return {\n    name: PluginName,\n    globalUIComponents: Object.values(PluginComponents),\n    beforeBuild(config, isProd) {\n      if (!isProd) {\n        _rssWorkaround = null;\n        return;\n      }\n      _rssWorkaround = {};\n      _config = config;\n      feedsSet.set(pluginRssOptions, config);\n    },\n    async extendPageData(_pageData) {\n      if (!_rssWorkaround) return;\n\n      const pageData = _pageData as PageWithFeeds;\n\n      // rspress run `extendPageData` for each page\n      //   - let's cache rss items within a complete rspress build\n      _rssWorkaround[pageData.id] =\n        _rssWorkaround[pageData.id] ||\n        getRssItems(\n          feedsSet.get(),\n          pageData,\n          _config!,\n          pluginRssOptions.siteUrl,\n        );\n\n      const feeds = await _rssWorkaround[pageData.id];\n      const showRssList = new Set(\n        concatArray(pageData.frontmatter['link-rss'] as string[] | string),\n      );\n      for (const feed of feeds) {\n        showRssList.add(feed.channel);\n      }\n\n      pageData.feeds = Array.from(showRssList, id => {\n        const { output, language } = feedsSet.get(id)!;\n        return {\n          url: output.url,\n          mime: output.mime,\n          language: language || pageData.lang,\n        };\n      });\n    },\n    async afterBuild(config) {\n      if (!_rssWorkaround) return;\n\n      const items = concatArray(\n        ...(await Promise.all(Object.values(_rssWorkaround))),\n      );\n      const feeds: Record<string, Feed> = Object.create(null);\n\n      for (const { channel, ...item } of items) {\n        feeds[channel] =\n          feeds[channel] ||\n          new Feed(createFeed(feedsSet.get(channel)!, config));\n        feeds[channel].addItem(item);\n      }\n\n      for (const [channel, feed] of Object.entries(feeds)) {\n        const { output } = feedsSet.get(channel)!;\n\n        const path = NodePath.resolve(\n          config.outDir || 'doc_build',\n          output.dir,\n          output.filename,\n        );\n        await writeFile(path, output.getContent(feed));\n      }\n      _rssWorkaround = null;\n      _config = null;\n    },\n  };\n}\n","export const PluginName = '@rspress/plugin-rss';\n\nexport const PluginComponents = {\n  FeedsAnnotations: '@rspress/plugin-rss/FeedsAnnotations',\n} as const;\n","import { resolve as resolveUrl } from 'node:url';\nimport type { PageIndexInfo, UserConfig } from '@rspress/shared';\nimport type { Author, FeedOptions } from 'feed';\nimport {\n  ResolvedOutput,\n  concatArray,\n  selectNonNullishProperty,\n  toDate,\n} from './internals';\nimport type { FeedChannel, FeedItem } from './type';\n\n/**\n * @public\n * @param page Rspress Page Data\n * @param siteUrl\n */\nexport function generateFeedItem(page: PageIndexInfo, siteUrl: string) {\n  const { frontmatter: fm } = page;\n  return {\n    id: selectNonNullishProperty(fm.slug, fm.id, page.id) || '',\n    title: selectNonNullishProperty(fm.title, page.title) || '',\n    author: toAuthors(fm.author),\n    link: resolveUrl(\n      siteUrl,\n      selectNonNullishProperty(fm.permalink, page.routePath) || '',\n    ),\n    description: selectNonNullishProperty(fm.description) || '',\n    content: selectNonNullishProperty(fm.summary, page.content) || '',\n    date: toDate((fm.date as string) || (fm.published_at as string))!,\n    category: concatArray(fm.categories as string[], fm.category as string).map(\n      cat => ({ name: cat }),\n    ),\n  } satisfies FeedItem;\n}\n\nexport function createFeed(\n  options: Omit<FeedChannel, 'test' | 'item' | 'output'> & {\n    item?: any;\n    test?: any;\n    output: ResolvedOutput;\n  },\n  config: UserConfig,\n): FeedOptions {\n  const { output, item, id, title, ..._options } = options;\n  return {\n    id,\n    copyright: config.themeConfig?.footer?.message || '',\n    description: config.description || '',\n    link: output.url,\n    ..._options,\n    title: title || config.title || '',\n  };\n}\n\nfunction toAuthors(author: unknown): Author[] | undefined {\n  const authors = (Array.isArray(author) ? author : [author])\n    .filter(Boolean)\n    .map(author => ({\n      // email is mandatory for RSS 2.0.\n      ...(typeof author === 'string' ? { name: author } : author),\n    }));\n  return authors.length ? authors : undefined;\n}\n","export type PartialPartial<T, K extends keyof T> = Partial<Pick<T, K>> &\n  Omit<T, K>;\n\nexport type ItemOf<T> = T extends Array<infer K> ? K : never;\n\nexport function notNullish<T>(n: T | undefined | null): n is T {\n  return n !== undefined && n !== null;\n}\nexport function concatArray<T>(...arrList: (T[] | T | undefined)[]) {\n  return arrList.reduce<T[]>(\n    (arr, item) =>\n      arr.concat((Array.isArray(item) ? item : [item]).filter(notNullish)),\n    [] as T[],\n  );\n}\n\nexport function selectNonNullishProperty(...list: unknown[]) {\n  for (const item of list) {\n    if (item === '') return '';\n    if (item === 0) return '0';\n    if (typeof item === 'number') return `${item}`;\n    if (typeof item === 'string') return item;\n  }\n}\n\nexport function toDate(s: string | Date): null | Date {\n  const d = new Date(s);\n  return Number.isNaN(d.getDate()) ? null : d;\n}\n","import { mkdir, writeFile as _writeFile } from 'node:fs/promises';\nimport * as NodePath from 'node:path';\n\nexport async function writeFile(path: string, content: string | Buffer) {\n  const dir = NodePath.dirname(path);\n  await mkdir(dir, { mode: 0o755, recursive: true });\n  return _writeFile(path, content);\n}\n","import { resolve as resolveUrl } from 'node:url';\nimport type { PageIndexInfo } from '@rspress/shared';\nimport { Feed } from 'feed';\nimport type { ResolvedOutput } from './internals';\nimport type { FeedChannel, FeedOutputType, PluginRssOptions } from './type';\n\nexport function testPage(\n  test: FeedChannel['test'],\n  page: PageIndexInfo,\n  base = '/',\n): boolean {\n  if (Array.isArray(test)) {\n    return test.some(item => testPage(item, page, base));\n  }\n  if (typeof test === 'function') {\n    return test(page, base);\n  }\n  const routePath = page.routePath;\n  const pureRoutePath = `/${\n    routePath.startsWith(base) ? routePath.slice(base.length) : routePath\n  }`.replace(/^\\/+/, '/');\n  if (typeof test === 'string') {\n    return [routePath, pureRoutePath].some(path => path.startsWith(test));\n  }\n  if (test instanceof RegExp) {\n    return [routePath, pureRoutePath].some(path => test.test(path));\n  }\n\n  throw new Error(\n    'test must be of `RegExp` or `string` or `(page: PageIndexInfo, base: string) => boolean`',\n  );\n}\n\nexport function getDefaultFeedOption() {\n  return { id: 'blog', test: '/blog/' } satisfies FeedChannel;\n}\n\nexport function getFeedFileType(type: FeedOutputType) {\n  switch (type) {\n    case 'rss':\n      return {\n        extension: 'rss',\n        mime: 'application/rss+xml',\n        getContent: (feed: Feed) => feed.rss2(),\n      };\n    case 'json':\n      return {\n        extension: 'json',\n        mime: 'application/json',\n        getContent: (feed: Feed) => feed.json1(),\n      };\n    case 'atom':\n    default:\n      return {\n        extension: 'xml',\n        mime: 'application/atom+xml',\n        getContent: (feed: Feed) => feed.atom1(),\n      };\n  }\n}\nexport function getOutputInfo(\n  { id, output }: Pick<FeedChannel, 'id' | 'output'>,\n  {\n    siteUrl,\n    output: globalOutput,\n  }: Pick<PluginRssOptions, 'output' | 'siteUrl'>,\n): ResolvedOutput {\n  const type = output?.type || globalOutput?.type || 'atom';\n  const { extension, mime, getContent } = getFeedFileType(type);\n  const filename = output?.filename || `${id}.${extension}`;\n  const dir = output?.dir || globalOutput?.dir || 'rss';\n  const publicPath = output?.publicPath || globalOutput?.publicPath || siteUrl;\n  const url = [publicPath, `${dir}/`, filename].reduce((u, part) =>\n    u ? resolveUrl(u, part) : part,\n  );\n  return { type, mime, filename, getContent, dir, publicPath, url };\n}\n"]}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@rspress/plugin-rss",
+  "version": "0.0.0-nightly-20240402160431",
+  "description": "A plugin for rss generation for rspress",
+  "bugs": "https://github.com/web-infra-dev/rspress/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/rspress",
+    "directory": "packages/plugin-rss"
+  },
+  "license": "MIT",
+  "jsnext:source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs"
+    },
+    "./FeedsAnnotations": "./static/global-components/FeedsAnnotations"
+  },
+  "engines": {
+    "node": ">=14.17.6"
+  },
+  "dependencies": {
+    "feed": "^4.2.2"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.17",
+    "@types/react": "^18",
+    "react": "^18",
+    "typescript": "^5",
+    "@rspress/runtime": "0.0.0-nightly-20240402160431",
+    "@rspress/shared": "0.0.0-nightly-20240402160431"
+  },
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "@types/react": ">=17.0.0",
+    "@rspress/runtime": "0.0.0-nightly-20240402160431"
+  },
+  "files": [
+    "dist",
+    "static"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "dev": "modern build -w",
+    "build": "modern build",
+    "reset": "rimraf ./**/node_modules",
+    "lint": "modern lint",
+    "change": "modern change",
+    "bump": "modern bump",
+    "pre": "modern pre",
+    "change-status": "modern change-status",
+    "gen-release-note": "modern gen-release-note",
+    "release": "modern release",
+    "new": "modern new",
+    "test": "vitest run --passWithNoTests",
+    "upgrade": "modern upgrade"
+  }
+}

package/static/global-components/FeedsAnnotations.tsx

@@ -0,0 +1,24 @@
+import type { PageFeedData } from '@rspress/plugin-rss';
+import { Helmet, usePageData } from '@rspress/runtime';
+import { LinkHTMLAttributes } from 'react';
+
+export default function FeedsAnnotations() {
+  const { page } = usePageData();
+  const feeds = (page.feeds as PageFeedData[]) || [];
+
+  return (
+    <Helmet>
+      {feeds.map(({ language, url, mime }) => {
+        const props: LinkHTMLAttributes<HTMLLinkElement> = {
+          rel: 'alternative',
+          type: mime,
+          href: url,
+        };
+        if (language) {
+          props.hrefLang = language;
+        }
+        return <link {...props} />;
+      })}
+    </Helmet>
+  );
+}