@rspress/plugin-rss 2.0.0-beta.8 → 2.0.0-rc.0

package/README.md

@@ -2,4 +2,4 @@
 
 > RSS plugin for rspress
 
-[Documentation](https://rspress.dev/plugin/official-plugins/rss)
+[Documentation](https://rspress.rs/plugin/official-plugins/rss)

package/dist/index.d.ts

@@ -2,9 +2,9 @@ import type { Author } from 'feed';
 import type { Feed } from 'feed';
 import type { FeedOptions } from 'feed';
 import type { Item } from 'feed';
-import type { PageIndexInfo } from '@rspress/shared';
-import type { RspressPlugin } from '@rspress/shared';
-import type { UserConfig } from '@rspress/shared';
+import type { PageIndexInfo } from '@rspress/core';
+import type { RspressPlugin } from '@rspress/core';
+import type { UserConfig } from '@rspress/core';
 
 export declare function createFeed(options: Omit<FeedChannel, 'test' | 'item' | 'output'> & {
     item?: unknown;
@@ -21,15 +21,14 @@ export declare interface FeedChannel extends PartialPartial<FeedOptions, 'title'
      * 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);
+    test: RegExp | string | (RegExp | string)[] | ((item: PageIndexInfo) => 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>;
+    item?: (item: FeedItem, page: PageIndexInfo) => FeedItem | PromiseLike<FeedItem>;
     /**
      * feed level output config
      */
@@ -151,6 +150,6 @@ declare interface ResolvedOutput {
     sorting: (left: FeedItem, right: FeedItem) => number;
 }
 
-export declare function testPage(test: FeedChannel['test'], page: PageIndexInfo, base?: string): boolean;
+export declare function testPage(test: FeedChannel['test'], page: PageIndexInfo): boolean;
 
 export { }

package/dist/index.js

@@ -1,8 +1,8 @@
-import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
-import * as __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__ from "node:url";
-import * as __WEBPACK_EXTERNAL_MODULE__rspress_shared_node_utils_78947ce6__ from "@rspress/shared/node-utils";
-import * as __WEBPACK_EXTERNAL_MODULE_feed__ from "feed";
-import * as __WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__ from "node:fs";
+import { resolve } from "node:url";
+import { promises } from "node:fs";
+import node_path, { dirname } from "node:path";
+import { getIconUrlPath } from "@rspress/core";
+import { Feed } from "feed";
 function notNullish(n) {
     return null != n;
 }
@@ -27,20 +27,20 @@ function sortByDate(l, r) {
     return (r ? r.getTime() : 0) - (l ? l.getTime() : 0);
 }
 async function writeFile(path, content) {
-    const dir = __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__.dirname(path);
-    await __WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__.promises.mkdir(dir, {
+    const dir = dirname(path);
+    await promises.mkdir(dir, {
         mode: 493,
         recursive: true
     });
-    return __WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__.promises.writeFile(path, content);
+    return promises.writeFile(path, content);
 }
 function generateFeedItem(page, siteUrl) {
     const { frontmatter: fm } = page;
     return {
-        id: selectNonNullishProperty(fm.slug, fm.id, page.id) || '',
+        id: selectNonNullishProperty(fm.slug, fm.id, page.routePath) || '',
         title: selectNonNullishProperty(fm.title, page.title) || '',
         author: toAuthors(fm.author),
-        link: (0, __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__.resolve)(siteUrl, selectNonNullishProperty(fm.permalink, page.routePath) || ''),
+        link: resolve(siteUrl, selectNonNullishProperty(fm.permalink, page.routePath)?.replace(/^\//, '') || ''),
         description: selectNonNullishProperty(fm.description) || '',
         content: selectNonNullishProperty(fm.summary, page._html) || '',
         date: toDate(fm.date || fm.published_at),
@@ -50,7 +50,7 @@ function generateFeedItem(page, siteUrl) {
     };
 }
 function createFeed(options, config) {
-    const { output, item, id, title, ..._options } = options;
+    const { output, item: _item, id, title, ..._options } = options;
     return {
         id,
         copyright: config.themeConfig?.footer?.message || '',
@@ -74,11 +74,11 @@ const PluginName = '@rspress/plugin-rss';
 const PluginComponents = {
     FeedsAnnotations: '@rspress/plugin-rss/FeedsAnnotations'
 };
-function testPage(test, page, base = '/') {
-    if (Array.isArray(test)) return test.some((item)=>testPage(item, page, base));
-    if ('function' == typeof test) return test(page, base);
+function testPage(test, page) {
+    if (Array.isArray(test)) return test.some((item)=>testPage(item, page));
+    if ('function' == typeof test) return test(page);
     const routePath = page.routePath;
-    const pureRoutePath = `/${routePath.startsWith(base) ? routePath.slice(base.length) : routePath}`.replace(/^\/+/, '/');
+    const pureRoutePath = `/${routePath}`.replace(/^\/+/, '/');
     if ('string' == typeof test) return [
         routePath,
         pureRoutePath
@@ -87,7 +87,7 @@ function testPage(test, page, base = '/') {
         routePath,
         pureRoutePath
     ].some((path)=>test.test(path));
-    throw new Error('test must be of `RegExp` or `string` or `(page: PageIndexInfo, base: string) => boolean`');
+    throw new Error('test must be of `RegExp` or `string` or `(page: PageIndexInfo) => boolean`');
 }
 function getDefaultFeedOption() {
     return {
@@ -128,7 +128,7 @@ function getOutputInfo({ id, output }, { siteUrl, output: globalOutput }) {
         publicPath,
         `${dir}/`,
         filename
-    ].reduce((u, part)=>u ? (0, __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__.resolve)(u, part) : part);
+    ].reduce((u, part)=>u ? resolve(u, part) : part);
     const sorting = output?.sorting || globalOutput?.sorting || ((l, r)=>sortByDate(l.date, r.date));
     return {
         type,
@@ -153,7 +153,7 @@ class FeedsSet {
         ]).map((options)=>({
                 title: config.title || '',
                 description: config.description || '',
-                favicon: config.icon && (0, __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__.resolve)(siteUrl, (0, __WEBPACK_EXTERNAL_MODULE__rspress_shared_node_utils_78947ce6__.getIconUrlPath)(config.icon)),
+                favicon: config.icon && resolve(siteUrl, getIconUrlPath(config.icon)),
                 copyright: config.themeConfig?.footer?.message || '',
                 link: siteUrl,
                 docs: '',
@@ -173,10 +173,10 @@ class FeedsSet {
         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)=>{
+function getRssItems(feeds, page, siteUrl) {
+    return Promise.all(feeds.filter((options)=>testPage(options.test, page)).map(async (options)=>{
         const after = options.item || ((feed)=>feed);
-        const item = await after(generateFeedItem(page, siteUrl), page, siteUrl);
+        const item = await after(generateFeedItem(page, siteUrl), page);
         return {
             ...item,
             channel: options.id
@@ -186,7 +186,6 @@ function getRssItems(feeds, page, config, siteUrl) {
 function pluginRss(pluginRssOptions) {
     const feedsSet = new FeedsSet();
     let _rssWorkaround = null;
-    let _config;
     return {
         name: PluginName,
         globalUIComponents: Object.values(PluginComponents),
@@ -196,13 +195,12 @@ function pluginRss(pluginRssOptions) {
                 return;
             }
             _rssWorkaround = {};
-            _config = config;
             feedsSet.set(pluginRssOptions, config);
         },
         async extendPageData (pageData) {
             if (!_rssWorkaround) return;
-            _rssWorkaround[pageData.id] = _rssWorkaround[pageData.id] || getRssItems(feedsSet.get(), pageData, _config, pluginRssOptions.siteUrl);
-            const feeds = await _rssWorkaround[pageData.id];
+            _rssWorkaround[pageData.routePath] = _rssWorkaround[pageData.routePath] || getRssItems(feedsSet.get(), pageData, pluginRssOptions.siteUrl);
+            const feeds = await _rssWorkaround[pageData.routePath];
             const showRssList = new Set(concatArray(pageData.frontmatter['link-rss']));
             for (const feed of feeds)showRssList.add(feed.channel);
             pageData.feeds = Array.from(showRssList, (id)=>{
@@ -219,17 +217,16 @@ function pluginRss(pluginRssOptions) {
             const items = concatArray(...await Promise.all(Object.values(_rssWorkaround)));
             const feeds = Object.create(null);
             for (const { channel, ...item } of items){
-                feeds[channel] = feeds[channel] || new __WEBPACK_EXTERNAL_MODULE_feed__.Feed(createFeed(feedsSet.get(channel), config));
+                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);
                 feed.items.sort(output.sorting);
-                const path = __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__["default"].resolve(config.outDir || 'doc_build', output.dir, output.filename);
+                const path = node_path.resolve(config.outDir || 'doc_build', output.dir, output.filename);
                 await writeFile(path, output.getContent(feed));
             }
             _rssWorkaround = null;
-            _config = null;
         }
     };
 }

package/index.d.ts

@@ -0,0 +1,9 @@
+import type { PageFeedData } from './dist'
+
+declare module '@rspress/core' {
+  interface PageIndexInfo {
+    feeds?: PageFeedData[];
+  }
+}
+
+export * from './dist'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-rss",
-  "version": "2.0.0-beta.8",
+  "version": "2.0.0-rc.0",
   "description": "A plugin for rss generation for rspress",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -12,39 +12,37 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./index.d.ts",
       "default": "./dist/index.js"
     },
     "./FeedsAnnotations": "./static/global-components/FeedsAnnotations.tsx"
   },
   "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "types": "./index.d.ts",
   "files": [
     "dist",
-    "static"
+    "static",
+    "index.d.ts"
   ],
   "dependencies": {
-    "feed": "^4.2.2",
-    "@rspress/shared": "2.0.0-beta.8"
+    "feed": "^4.2.2"
   },
   "devDependencies": {
-    "@rslib/core": "0.8.0",
+    "@rslib/core": "0.16.1",
     "@types/node": "^22.8.1",
-    "@types/react": "^18.3.22",
-    "react": "^19.1.0",
-    "rsbuild-plugin-publint": "^0.3.2",
-    "typescript": "^5.8.2",
-    "@rspress/runtime": "2.0.0-beta.8"
+    "@types/react": "^19.2.2",
+    "react": "^19.2.0",
+    "rsbuild-plugin-publint": "^0.3.3",
+    "typescript": "^5.8.2"
   },
   "peerDependencies": {
-    "rspress": "^2.0.0-beta.8"
+    "@rspress/core": "^2.0.0-rc.0"
   },
   "engines": {
     "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public",
-    "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
   "scripts": {

package/static/global-components/FeedsAnnotations.tsx

@@ -1,7 +1,7 @@
 /// <reference path="../../index.d.ts" />
 
+import { Head, usePageData } from '@rspress/core/runtime';
 import type { LinkHTMLAttributes } from 'react';
-import { Head, usePageData } from 'rspress/runtime';
 
 export default function FeedsAnnotations() {
   const { page } = usePageData();
@@ -16,10 +16,10 @@ export default function FeedsAnnotations() {
           href: url,
         };
         if (language) {
-          props.hrefLang = language;
+          // @ts-expect-error FIXME: why not hrefLang? @unhead/react issue
+          props.hreflang = language;
         }
-        // biome-ignore lint/correctness/useJsxKeyInIterable: no key props
-        return <link {...props} />;
+        return <link {...props} key={`${language}-${url}-${mime}`} />;
       })}
     </Head>
   );