@rspress/plugin-rss 2.0.16 → 2.0.17

package/dist/index.d.ts

@@ -111,7 +111,10 @@ export declare function getFeedFileType(type: FeedOutputType): {
     getContent: (feed: Feed) => string;
 };
 
-export declare function getOutputInfo({ id, output }: Pick<FeedChannel, 'id' | 'output'>, { siteUrl, output: globalOutput, }: Pick<PluginRssOptions, 'output' | 'siteUrl'>): ResolvedOutput;
+export declare function getOutputInfo({ id, output }: Pick<FeedChannel, 'id' | 'output'>, { siteUrl, output: globalOutput, }: {
+    siteUrl: string;
+    output?: PluginRssOptions['output'];
+}): ResolvedOutput;
 
 /**
  * feed information attached in `PageIndexInfo['feeds']` array
@@ -130,7 +133,7 @@ export declare const PluginComponents: {
 
 export declare const PluginName = "@rspress/plugin-rss";
 
-export declare function pluginRss(pluginRssOptions: PluginRssOptions): RspressPlugin;
+export declare function pluginRss(pluginRssOptions?: PluginRssOptions): RspressPlugin;
 
 /**
  * plugin options for `pluginRss`
@@ -138,9 +141,9 @@ export declare function pluginRss(pluginRssOptions: PluginRssOptions): RspressPl
 export declare interface PluginRssOptions {
     /**
      * site url of this rspress site. it will be used in feed files and feed link.
-     * @requires
+     * @default rspress `siteOrigin` config with `base`, or `base` when `siteOrigin` is not configured
      */
-    siteUrl: string;
+    siteUrl?: string;
     /**
      * Feed options for each rss. If array is given, this plugin will produce multiple feed files.
      * @default { id: 'blog', test: '/blog/' }

package/dist/index.js

@@ -1,9 +1,9 @@
 import { resolve } from "node:url";
 import { promises } from "node:fs";
 import node_path from "node:path";
-import { getIconUrlPath } from "@rspress/core";
+import { getIconUrlPath, withBase, withSiteOrigin } from "@rspress/core";
 import { Feed } from "feed";
-import * as __rspack_external_node_path_c5b9b54f from "node:path";
+import * as __rspack_external_node_path_806ed179 from "node:path";
 function notNullish(n) {
     return null != n;
 }
@@ -28,7 +28,7 @@ function sortByDate(l, r) {
     return (r ? r.getTime() : 0) - (l ? l.getTime() : 0);
 }
 async function writeFile(path, content) {
-    const dir = __rspack_external_node_path_c5b9b54f.dirname(path);
+    const dir = __rspack_external_node_path_806ed179.dirname(path);
     await promises.mkdir(dir, {
         mode: 493,
         recursive: true
@@ -138,6 +138,9 @@ function getFeedFileType(type) {
             };
     }
 }
+function ensureTrailingSlash(url) {
+    return url.endsWith('/') ? url : `${url}/`;
+}
 async function renderFeedContent(feed, channel, output) {
     const content = output.getContent(feed);
     if (!output.transform) return content;
@@ -152,7 +155,7 @@ function getOutputInfo({ id, output }, { siteUrl, output: globalOutput }) {
     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 publicPath = ensureTrailingSlash(output?.publicPath || globalOutput?.publicPath || siteUrl);
     const url = [
         publicPath,
         `${dir}/`,
@@ -175,7 +178,7 @@ function getOutputInfo({ id, output }, { siteUrl, output: globalOutput }) {
 class FeedsSet {
     feeds = [];
     feedsMapById = Object.create(null);
-    set({ feed, output, siteUrl }, config) {
+    set({ feed, output }, config, siteUrl) {
         this.feeds = (Array.isArray(feed) ? feed : [
             {
                 ...getDefaultFeedOption(),
@@ -204,6 +207,27 @@ class FeedsSet {
         return this.feeds.slice(0);
     }
 }
+function plugin_rss_ensureTrailingSlash(url) {
+    return url.endsWith('/') ? url : `${url}/`;
+}
+function normalizeSiteUrl(siteUrl) {
+    try {
+        const url = new URL(siteUrl);
+        url.pathname = plugin_rss_ensureTrailingSlash(url.pathname);
+        return url.href;
+    } catch  {
+        throw new Error('[plugin-rss] `siteUrl` must be a valid absolute URL with protocol, such as `https://example.com/base/`.');
+    }
+}
+function getSiteUrl(siteUrl, config) {
+    if (siteUrl) return normalizeSiteUrl(siteUrl);
+    const base = withBase('/', config.base ?? '/');
+    try {
+        return config.siteOrigin ? withSiteOrigin(base, config.siteOrigin) : base;
+    } catch  {
+        throw new Error('[plugin-rss] `siteOrigin` in rspress.config.ts must be a valid absolute URL origin with protocol, such as `https://example.com`.');
+    }
+}
 async function getRssItems(feeds, page, siteUrl, htmlContent) {
     return Promise.all(feeds.filter((options)=>testPage(options.test, page)).map(async (options)=>{
         const after = options.item || ((feed)=>feed);
@@ -214,9 +238,10 @@ async function getRssItems(feeds, page, siteUrl, htmlContent) {
         };
     }));
 }
-function pluginRss(pluginRssOptions) {
+function pluginRss(pluginRssOptions = {}) {
     const feedsSet = new FeedsSet();
     let _pagesForRss = null;
+    let _siteUrl = '';
     return {
         name: PluginName,
         globalUIComponents: Object.values(PluginComponents),
@@ -228,7 +253,8 @@ function pluginRss(pluginRssOptions) {
             const enableSSG = Boolean((config.ssg || config.llms) ?? true);
             if (!enableSSG) throw new Error("[plugin-rss] RSS plugin requires SSG to be enabled. Please set `ssg: true` in your rspress.config.ts or remove the RSS plugin.");
             _pagesForRss = new Map();
-            feedsSet.set(pluginRssOptions, config);
+            _siteUrl = getSiteUrl(pluginRssOptions.siteUrl, config);
+            feedsSet.set(pluginRssOptions, config, _siteUrl);
         },
         async extendPageData (pageData) {
             if (!_pagesForRss) return;
@@ -258,7 +284,7 @@ function pluginRss(pluginRssOptions) {
                 const htmlPath = node_path.resolve(outDir, routePathToHtmlPath(routePath));
                 const htmlFile = await readFile(htmlPath);
                 const htmlContent = htmlFile ? extractHtmlContent(htmlFile) : null;
-                const items = await getRssItems(channels.map((id)=>feedsSet.get(id)), page, pluginRssOptions.siteUrl, htmlContent);
+                const items = await getRssItems(channels.map((id)=>feedsSet.get(id)), page, _siteUrl, htmlContent);
                 for (const { channel, ...item } of items){
                     feeds[channel] = feeds[channel] || new Feed(createFeed(feedsSet.get(channel), config));
                     feeds[channel].addItem(item);
@@ -272,6 +298,7 @@ function pluginRss(pluginRssOptions) {
                 await writeFile(path, await renderFeedContent(feed, feedChannel, output));
             }
             _pagesForRss = null;
+            _siteUrl = '';
         }
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-rss",
-  "version": "2.0.16",
+  "version": "2.0.17",
   "description": "A plugin for rss generation for rspress",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -28,7 +28,7 @@
     "feed": "^5.2.1"
   },
   "devDependencies": {
-    "@rslib/core": "0.23.0",
+    "@rslib/core": "0.23.2",
     "@types/node": "^22.8.1",
     "@types/react": "^19.2.17",
     "react": "^19.2.7",