@riebeckite/plugin-seo 0.0.5 → 0.0.6

package/README.md

@@ -107,4 +107,4 @@ they are never rebuilt from slugs.
 
 ## See also
 
-- [Plugin guide](../../docs/plugins_en.md)
+- [Plugin guide](../../../docs/en/plugin-system.md)

package/dist/index.js

@@ -82,29 +82,32 @@ function escapeXml(value) {
 
 // src/feeds.ts
 function renderRssFeed(config, entries) {
+  const feed = getResolvedFeedMetadata(config);
   const items = entries.map((entry) => {
     const url = buildPostUrl(config, entry.permalink);
     const pubDate = getEntryPublishedTime(entry);
     return `<item><title>${escapeXml(entry.title)}</title><link>${escapeXml(url)}</link><guid>${escapeXml(url)}</guid><description>${escapeXml(getDescription(entry))}</description>${pubDate ? `<pubDate>${new Date(pubDate).toUTCString()}</pubDate>` : ""}</item>`;
   });
-  return `<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"><channel><title>${escapeXml(config.site.feed.title)}</title><link>${escapeXml(buildAbsoluteUrl(config, "/"))}</link><description>${escapeXml(config.site.feed.description)}</description><language>${escapeXml(config.site.feed.language)}</language>${items.join("")}</channel></rss>`;
+  return `<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"><channel><title>${escapeXml(feed.title)}</title><link>${escapeXml(buildAbsoluteUrl(config, "/"))}</link><description>${escapeXml(feed.description)}</description><language>${escapeXml(feed.language)}</language>${items.join("")}</channel></rss>`;
 }
 function renderAtomFeed(config, entries) {
+  const feed = getResolvedFeedMetadata(config);
   const updated = entries.map(getEntryUpdatedTime).find(Boolean) ?? (/* @__PURE__ */ new Date(0)).toISOString();
   const items = entries.map((entry) => {
     const url = buildPostUrl(config, entry.permalink);
     return `<entry><title>${escapeXml(entry.title)}</title><link href="${escapeXml(url)}"/><id>${escapeXml(url)}</id><updated>${escapeXml(getEntryUpdatedTime(entry) ?? updated)}</updated><summary>${escapeXml(getDescription(entry))}</summary></entry>`;
   });
-  return `<?xml version="1.0" encoding="UTF-8"?><feed xmlns="http://www.w3.org/2005/Atom"><title>${escapeXml(config.site.feed.title)}</title><link href="${escapeXml(buildAbsoluteUrl(config, "/"))}"/><link rel="self" href="${escapeXml(buildAbsoluteUrl(config, "/atom.xml"))}"/><id>${escapeXml(buildAbsoluteUrl(config, "/"))}</id><updated>${escapeXml(updated)}</updated>${items.join("")}</feed>`;
+  return `<?xml version="1.0" encoding="UTF-8"?><feed xmlns="http://www.w3.org/2005/Atom"><title>${escapeXml(feed.title)}</title><link href="${escapeXml(buildAbsoluteUrl(config, "/"))}"/><link rel="self" href="${escapeXml(buildAbsoluteUrl(config, "/atom.xml"))}"/><id>${escapeXml(buildAbsoluteUrl(config, "/"))}</id><updated>${escapeXml(updated)}</updated>${items.join("")}</feed>`;
 }
 function renderJsonFeed(config, entries) {
+  const feed = getResolvedFeedMetadata(config);
   return JSON.stringify({
     version: "https://jsonfeed.org/version/1.1",
-    title: config.site.feed.title,
+    title: feed.title,
     home_page_url: buildAbsoluteUrl(config, "/"),
     feed_url: buildAbsoluteUrl(config, "/feed.json"),
-    description: config.site.feed.description,
-    language: getHtmlLanguage(config),
+    description: feed.description,
+    language: feed.language,
     items: entries.map((entry) => {
       const url = buildPostUrl(config, entry.permalink);
       return removeUndefined({
@@ -120,6 +123,13 @@ function renderJsonFeed(config, entries) {
     })
   });
 }
+function getResolvedFeedMetadata(config) {
+  return {
+    title: config.site.feed.title ?? config.site.title,
+    description: config.site.feed.description ?? config.site.description,
+    language: config.site.feed.language ?? getHtmlLanguage(config)
+  };
+}
 
 // src/metadata.ts
 import { calculateReadingTime } from "@riebeckite/core";
@@ -266,22 +276,27 @@ function renderRobots(config) {
 
 // src/endpoints.ts
 function createSeoEndpoints(options) {
-  return [
-    options.sitemap === true ? {
+  const endpoints = [];
+  if (options.sitemap === true) {
+    endpoints.push({
       path: "/sitemap.xml",
       handler: ({ config, manifest }) => ({
         headers: { "content-type": "application/xml; charset=utf-8" },
         body: renderSitemap(config, manifest.entries)
       })
-    } : null,
-    options.robots === true ? {
+    });
+  }
+  if (options.robots === true) {
+    endpoints.push({
       path: "/robots.txt",
       handler: ({ config }) => ({
         headers: { "content-type": "text/plain; charset=utf-8" },
         body: renderRobots(config)
       })
-    } : null,
-    options.feed?.rss === true ? {
+    });
+  }
+  if (options.feed?.rss === true) {
+    endpoints.push({
       path: "/feed.xml",
       handler: ({ config, manifest }) => ({
         headers: { "content-type": "application/rss+xml; charset=utf-8" },
@@ -290,8 +305,10 @@ function createSeoEndpoints(options) {
           filterFeedEntries(config, manifest.entries)
         )
       })
-    } : null,
-    options.feed?.atom === true ? {
+    });
+  }
+  if (options.feed?.atom === true) {
+    endpoints.push({
       path: "/atom.xml",
       handler: ({ config, manifest }) => ({
         headers: { "content-type": "application/atom+xml; charset=utf-8" },
@@ -300,19 +317,19 @@ function createSeoEndpoints(options) {
           filterFeedEntries(config, manifest.entries)
         )
       })
-    } : null,
-    options.feed?.json === true ? {
+    });
+  }
+  if (options.feed?.json === true) {
+    endpoints.push({
       path: "/feed.json",
       handler: ({ config, manifest }) => ({
         json: JSON.parse(
-          renderJsonFeed(
-            config,
-            filterFeedEntries(config, manifest.entries)
-          )
+          renderJsonFeed(config, filterFeedEntries(config, manifest.entries))
         )
       })
-    } : null
-  ].filter((endpoint) => endpoint !== null);
+    });
+  }
+  return endpoints;
 }
 
 // src/plugin.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-seo",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,7 +14,11 @@
     }
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.5"
+    "@riebeckite/core": "0.0.6"
+  },
+  "devDependencies": {
+    "tsx": "^4.22.4",
+    "@riebeckite/test": "0.0.6"
   },
   "publishConfig": {
     "access": "public"
@@ -46,6 +50,7 @@
   },
   "sideEffects": false,
   "scripts": {
-    "build": "node ../../../scripts/build_package.mjs"
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
   }
 }