@hagicode/hagilight-starlight 0.2.2 → 0.2.3-dev.22.1.69e2b54

package/index.mjs

@@ -87,7 +87,7 @@ function getRssFeedUrl(config) {
   return rssLink?.attrs.href;
 }
 
-function createConfiguredIntegration(instanceId, serializedOptions, componentIds, getConfiguredRssFeed) {
+function createConfiguredIntegration(instanceId, serializedOptions, componentIds, getConfiguredRssFeed, generateRss) {
   const optionsId = `virtual:hagilight-starlight/${instanceId}/options`;
   const headerPath = componentIds.header
     ? fileURLToPath(new URL('./Header.astro', import.meta.url))
@@ -185,7 +185,14 @@ const isNotFound = /(?:^|\\/)404(?:\\.html)?\\/?$/u.test(Astro.url.pathname);
   return {
     name: `@hagicode/hagilight-starlight:${instanceId}`,
     hooks: {
-      'astro:config:setup'({ updateConfig }) {
+      'astro:config:setup'({ injectRoute, updateConfig }) {
+        if (generateRss) {
+          injectRoute({
+            pattern: '/rss.xml',
+            entrypoint: fileURLToPath(new URL('./rss.xml.ts', import.meta.url)),
+            prerender: true,
+          });
+        }
         updateConfig({ vite: { plugins: [vitePlugin] } });
       },
     },
@@ -210,6 +217,13 @@ export default function hagilight(options = {}) {
   if (options.notFoundPage?.enabled !== undefined && typeof options.notFoundPage.enabled !== 'boolean') {
     throw new TypeError('Hagilight notFoundPage enabled option must be a boolean.');
   }
+  if (options.rss !== undefined
+    && (!options.rss || typeof options.rss !== 'object' || Array.isArray(options.rss))) {
+    throw new TypeError('Hagilight rss options must be an object.');
+  }
+  if (options.rss?.enabled !== undefined && typeof options.rss.enabled !== 'boolean') {
+    throw new TypeError('Hagilight rss enabled option must be a boolean.');
+  }
   if (options.analytics !== undefined
     && (!options.analytics || typeof options.analytics !== 'object' || Array.isArray(options.analytics))) {
     throw new TypeError('Hagilight analytics options must be an object.');
@@ -271,7 +285,7 @@ export default function hagilight(options = {}) {
   return {
     name: '@hagicode/hagilight-starlight',
     hooks: {
-      'config:setup'({ config, updateConfig, addIntegration }) {
+      'config:setup'({ astroConfig, config, updateConfig, addIntegration }) {
         if (headerEnabled && config.components?.Header) {
           throw new Error('Hagilight cannot replace an existing Starlight Header override. Set header: { enabled: false } to keep it, or compose @hagicode/hagilight-starlight/Header directly.');
         }
@@ -291,17 +305,29 @@ export default function hagilight(options = {}) {
           throw new Error('Hagilight Google Analytics cannot replace an existing Starlight Head override. Compose @hagicode/hagilight/GoogleAnalytics in your Head instead.');
         }
 
+        const generateRss = options.rss?.enabled !== false && !getRssFeedUrl(config);
+        if (generateRss && !astroConfig.site) {
+          throw new Error('Hagilight RSS requires the Astro site option. Set site or disable RSS with rss: { enabled: false }.');
+        }
+        const rssFeedUrl = generateRss
+          ? new URL('rss.xml', new URL((astroConfig.base ?? '/').replace(/\/?$/u, '/'), astroConfig.site)).toString()
+          : undefined;
         addIntegration(createConfiguredIntegration(
           instanceId,
           serializedOptions,
           componentIds,
-          () => getRssFeedUrl(config),
+          () => getRssFeedUrl(config) ?? rssFeedUrl,
+          generateRss,
         ));
         updateConfig({
           ...(config.logo === undefined ? { logo: { src: defaultLogo, alt: 'HagiCode' } } : {}),
           customCss: [...(config.customCss ?? []), contentWidthCssPath],
           head: [
             ...(config.head ?? []),
+            ...(rssFeedUrl ? [{
+              tag: 'link',
+              attrs: { rel: 'alternate', type: 'application/rss+xml', href: rssFeedUrl },
+            }] : []),
             { tag: 'script', content: contentWidthHeadScript },
           ],
           components: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hagicode/hagilight-starlight",
-  "version": "0.2.2",
+  "version": "0.2.3-dev.22.1.69e2b54",
   "type": "module",
   "description": "Starlight customizations for HagiCode documentation",
   "repository": {
@@ -30,11 +30,13 @@
     "index.mjs",
     "*.css",
     "*.mjs",
+    "rss.xml.ts",
     "*.astro",
     "assets/*.png"
   ],
   "dependencies": {
-    "@hagicode/hagilight": "0.2.2"
+    "@astrojs/rss": "^4.0.19",
+    "@hagicode/hagilight": "0.2.3-dev.22.1.69e2b54"
   },
   "peerDependencies": {
     "@astrojs/starlight": "^0.42.4",

package/rss.xml.ts

@@ -0,0 +1,25 @@
+import rss from '@astrojs/rss';
+import { getCollection } from 'astro:content';
+import type { APIRoute } from 'astro';
+
+export const GET: APIRoute = async ({ site }) => {
+  if (!site) throw new Error('Hagilight RSS requires the Astro site option.');
+
+  const pages = await getCollection('docs', ({ data }) => !data.draft);
+  const base = new URL(import.meta.env.BASE_URL, site);
+  return rss({
+    title: 'Documentation',
+    description: 'Recently updated documentation pages',
+    site: base,
+    items: pages
+      .sort((a, b) =>
+        (b.data.lastUpdated instanceof Date ? b.data.lastUpdated.getTime() : 0)
+        - (a.data.lastUpdated instanceof Date ? a.data.lastUpdated.getTime() : 0))
+      .map(({ id, data }) => ({
+        title: data.title,
+        description: data.description,
+        ...(data.lastUpdated instanceof Date ? { pubDate: data.lastUpdated } : {}),
+        link: new URL(`${id.replace(/(?:^|\/)index$/u, '')}/`, base).toString(),
+      })),
+  });
+};