Merge pull request #599 from negrel/598-feed-plugin-image-support

598 feed plugin image support
lumeland · Apr 19, 2024 · 70e0398 · 70e0398
2 parents d0d91f3 + 9323a6d
commit 70e0398
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/),
 and this project try to adheres to [Semantic Versioning](https://semver.org/).
 Go to the `v1` branch to see the changelog of Lume 1.
 
+## [X.X.X] - TODO
+### Added
+- Feed plugin: Add image support.
+
 ## [2.1.4] - 2024-04-17
 ### Added
 - Pagefind plugin: Updated the `ui` object with the new options introduced in v1.1.0.

diff --git a/plugins/feed.ts b/plugins/feed.ts
@@ -69,6 +69,9 @@ export interface FeedItemOptions {
 
   /** The item language */
   lang?: string | ((data: Data) => string | undefined);
+
+  /** The item image */
+  image?: string | ((data: Data) => string | undefined);
 }
 
 export const defaults: Options = {
@@ -119,6 +122,7 @@ export interface FeedItem {
   updated?: Date;
   content: string;
   lang: string;
+  image?: string;
 }
 
 const defaultGenerator = `Lume ${getCurrentVersion()}`;
@@ -154,6 +158,10 @@ export default function (userOptions?: Options) {
           const content = getDataValue(data, items.content)?.toString();
           const pageUrl = site.url(data.url, true);
           const fixedContent = fixUrls(new URL(pageUrl), content || "");
+          const imagePath = getDataValue(data, items.image);
+          const image = imagePath !== undefined
+            ? site.url(imagePath, true)
+            : undefined;
 
           return {
             title: getDataValue(data, items.title),
@@ -163,6 +171,7 @@ export default function (userOptions?: Options) {
             updated: getDataValue(data, items.updated),
             content: fixedContent,
             lang: getDataValue(data, items.lang),
+            image,
           };
         }),
       };
@@ -240,6 +249,9 @@ function generateRss(data: FeedData, file: string): string {
             "content:encoded": item.content,
             pubDate: item.published.toUTCString(),
             "atom:updated": item.updated?.toISOString(),
+            meta: item.image
+              ? { "@property": "og:image", "@content": item.image }
+              : undefined,
           })
         ),
       }),
@@ -264,6 +276,7 @@ function generateJson(data: FeedData, file: string): string {
         content_html: item.content,
         date_published: item.published.toUTCString(),
         date_modified: item.updated?.toUTCString(),
+        image: item.image,
       })
     ),
   });

diff --git a/tests/__snapshots__/feed.test.ts.snap b/tests/__snapshots__/feed.test.ts.snap
@@ -107,6 +107,8 @@ snapshot[`RSS plugin 1`] = `
     "/404.md",
     "/_data.yml",
     "/favicon.png",
+    "/images",
+    "/images/avatar.jpg",
     "/page5.yaml",
     "/pages",
     "/pages/2020-06-21_page2.page.json",
@@ -136,10 +138,10 @@ snapshot[`RSS plugin 2`] = `[]`;
 snapshot[`RSS plugin 3`] = `
 [
   {
-    content: '{"version":"https://jsonfeed.org/version/1","title":"My RSS Feed","home_page_url":"https://example.com/","feed_url":"https://example.com/feed.json","description":"","items":[{"id":"https://example.com/pages/new-name/page7/","url":"https://example.com/pages/new-name/page7/","content_html":"Content of Page 7","date_published":"Sun, 02 Jan 2022 00:00:00 GMT","date_modified":"Sun, 02 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page6/","url":"https://example.com/pages/page6/","title":"PAGE 6","content_html":"<p>Content of Page 6</p>\\\\n","date_published":"Sat, 01 Jan 2022 00:00:00 GMT","date_modified":"Sat, 01 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page4/","url":"https://example.com/pages/page4/","title":"PAGE 4","content_html":"Content of Page 4 in Overrided site name, from the file /pages/2021-01-02-18-32_page4.page.ts","date_published":"Sat, 02 Jan 2021 18:32:00 GMT","date_modified":"Sat, 02 Jan 2021 18:32:00 GMT"},{"id":"https://example.com/overrided-page2/","url":"https://example.com/overrided-page2/","title":"PAGE 2","content_html":"Content of Page 2","date_published":"Sun, 21 Jun 2020 00:00:00 GMT","date_modified":"Sun, 21 Jun 2020 00:00:00 GMT"},{"id":"https://example.com/page5/","url":"https://example.com/page5/","title":"PAGE 5","content_html":"Content of Page 5","date_published":"Thu, 21 Jun 1979 23:45:00 GMT","date_modified":"Thu, 21 Jun 1979 23:45:00 GMT"}]}',
+    content: '{"version":"https://jsonfeed.org/version/1","title":"My RSS Feed","home_page_url":"https://example.com/","feed_url":"https://example.com/feed.json","description":"","items":[{"id":"https://example.com/pages/new-name/page7/","url":"https://example.com/pages/new-name/page7/","content_html":"Content of Page 7","date_published":"Sun, 02 Jan 2022 00:00:00 GMT","date_modified":"Sun, 02 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page6/","url":"https://example.com/pages/page6/","title":"PAGE 6","content_html":"<p>Content of Page 6</p>\\\\n","date_published":"Sat, 01 Jan 2022 00:00:00 GMT","date_modified":"Sat, 01 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page4/","url":"https://example.com/pages/page4/","title":"PAGE 4","content_html":"Content of Page 4 in Overrided site name, from the file /pages/2021-01-02-18-32_page4.page.ts","date_published":"Sat, 02 Jan 2021 18:32:00 GMT","date_modified":"Sat, 02 Jan 2021 18:32:00 GMT"},{"id":"https://example.com/overrided-page2/","url":"https://example.com/overrided-page2/","title":"PAGE 2","content_html":"Content of Page 2","date_published":"Sun, 21 Jun 2020 00:00:00 GMT","date_modified":"Sun, 21 Jun 2020 00:00:00 GMT","image":"https://example.com/images/avatar.jpg"},{"id":"https://example.com/page5/","url":"https://example.com/page5/","title":"PAGE 5","content_html":"Content of Page 5","date_published":"Thu, 21 Jun 1979 23:45:00 GMT","date_modified":"Thu, 21 Jun 1979 23:45:00 GMT"}]}',
     data: {
       basename: "feed",
-      content: '{"version":"https://jsonfeed.org/version/1","title":"My RSS Feed","home_page_url":"https://example.com/","feed_url":"https://example.com/feed.json","description":"","items":[{"id":"https://example.com/pages/new-name/page7/","url":"https://example.com/pages/new-name/page7/","content_html":"Content of Page 7","date_published":"Sun, 02 Jan 2022 00:00:00 GMT","date_modified":"Sun, 02 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page6/","url":"https://example.com/pages/page6/","title":"PAGE 6","content_html":"<p>Content of Page 6</p>\\\\n","date_published":"Sat, 01 Jan 2022 00:00:00 GMT","date_modified":"Sat, 01 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page4/","url":"https://example.com/pages/page4/","title":"PAGE 4","content_html":"Content of Page 4 in Overrided site name, from the file /pages/2021-01-02-18-32_page4.page.ts","date_published":"Sat, 02 Jan 2021 18:32:00 GMT","date_modified":"Sat, 02 Jan 2021 18:32:00 GMT"},{"id":"https://example.com/overrided-page2/","url":"https://example.com/overrided-page2/","title":"PAGE 2","content_html":"Content of Page 2","date_published":"Sun, 21 Jun 2020 00:00:00 GMT","date_modified":"Sun, 21 Jun 2020 00:00:00 GMT"},{"id":"https://example.com/page5/","url":"https://example.com/page5/","title":"PAGE 5","content_html":"Content of Page 5","date_published":"Thu, 21 Jun 1979 23:45:00 GMT","date_modified":"Thu, 21 Jun 1979 23:45:00 GMT"}]}',
+      content: '{"version":"https://jsonfeed.org/version/1","title":"My RSS Feed","home_page_url":"https://example.com/","feed_url":"https://example.com/feed.json","description":"","items":[{"id":"https://example.com/pages/new-name/page7/","url":"https://example.com/pages/new-name/page7/","content_html":"Content of Page 7","date_published":"Sun, 02 Jan 2022 00:00:00 GMT","date_modified":"Sun, 02 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page6/","url":"https://example.com/pages/page6/","title":"PAGE 6","content_html":"<p>Content of Page 6</p>\\\\n","date_published":"Sat, 01 Jan 2022 00:00:00 GMT","date_modified":"Sat, 01 Jan 2022 00:00:00 GMT"},{"id":"https://example.com/pages/page4/","url":"https://example.com/pages/page4/","title":"PAGE 4","content_html":"Content of Page 4 in Overrided site name, from the file /pages/2021-01-02-18-32_page4.page.ts","date_published":"Sat, 02 Jan 2021 18:32:00 GMT","date_modified":"Sat, 02 Jan 2021 18:32:00 GMT"},{"id":"https://example.com/overrided-page2/","url":"https://example.com/overrided-page2/","title":"PAGE 2","content_html":"Content of Page 2","date_published":"Sun, 21 Jun 2020 00:00:00 GMT","date_modified":"Sun, 21 Jun 2020 00:00:00 GMT","image":"https://example.com/images/avatar.jpg"},{"id":"https://example.com/page5/","url":"https://example.com/page5/","title":"PAGE 5","content_html":"Content of Page 5","date_published":"Thu, 21 Jun 1979 23:45:00 GMT","date_modified":"Thu, 21 Jun 1979 23:45:00 GMT"}]}',
       page: [
         "src",
         "data",
@@ -197,6 +199,7 @@ snapshot[`RSS plugin 3`] = `
       <content:encoded><![CDATA[Content of Page 2]]></content:encoded>
       <pubDate>Sun, 21 Jun 2020 00:00:00 GMT</pubDate>
       <atom:updated>2020-06-21T00:00:00.000Z</atom:updated>
+      <meta property="og:image" content="https://example.com/images/avatar.jpg"/>
     </item>
     <item>
       <title>PAGE 5</title>
@@ -253,6 +256,7 @@ snapshot[`RSS plugin 3`] = `
       <content:encoded><![CDATA[Content of Page 2]]></content:encoded>
       <pubDate>Sun, 21 Jun 2020 00:00:00 GMT</pubDate>
       <atom:updated>2020-06-21T00:00:00.000Z</atom:updated>
+      <meta property="og:image" content="https://example.com/images/avatar.jpg"/>
     </item>
     <item>
       <title>PAGE 5</title>
@@ -374,6 +378,7 @@ Content of Page 2",
       metas: [
         "title",
         "description",
+        "image",
       ],
       names: "Array(2)",
       page: [

diff --git a/tests/__snapshots__/loaders.test.ts.snap b/tests/__snapshots__/loaders.test.ts.snap
@@ -119,6 +119,8 @@ snapshot[`Load the pages of a site 1`] = `
     "/404.md",
     "/_data.yml",
     "/favicon.png",
+    "/images",
+    "/images/avatar.jpg",
     "/page5.yaml",
     "/pages",
     "/pages/2020-06-21_page2.page.json",
@@ -285,6 +287,7 @@ Content of Page 2",
       metas: [
         "title",
         "description",
+        "image",
       ],
       names: "Array(2)",
       page: [

diff --git a/tests/__snapshots__/robots.test.ts.snap b/tests/__snapshots__/robots.test.ts.snap
@@ -107,6 +107,8 @@ snapshot[`Robots plugin 1`] = `
     "/404.md",
     "/_data.yml",
     "/favicon.png",
+    "/images",
+    "/images/avatar.jpg",
     "/page5.yaml",
     "/pages",
     "/pages/2020-06-21_page2.page.json",
@@ -250,6 +252,7 @@ Content of Page 2",
       metas: [
         "title",
         "description",
+        "image",
       ],
       names: "Array(2)",
       page: [
@@ -552,6 +555,8 @@ snapshot[`Robots plugin with allow 1`] = `
     "/404.md",
     "/_data.yml",
     "/favicon.png",
+    "/images",
+    "/images/avatar.jpg",
     "/page5.yaml",
     "/pages",
     "/pages/2020-06-21_page2.page.json",
@@ -698,6 +703,7 @@ Content of Page 2",
       metas: [
         "title",
         "description",
+        "image",
       ],
       names: "Array(2)",
       page: [
@@ -1000,6 +1006,8 @@ snapshot[`Robots plugin with disallow 1`] = `
     "/404.md",
     "/_data.yml",
     "/favicon.png",
+    "/images",
+    "/images/avatar.jpg",
     "/page5.yaml",
     "/pages",
     "/pages/2020-06-21_page2.page.json",
@@ -1146,6 +1154,7 @@ Content of Page 2",
       metas: [
         "title",
         "description",
+        "image",
       ],
       names: "Array(2)",
       page: [
@@ -1448,6 +1457,8 @@ snapshot[`Robots plugin with custom rules 1`] = `
     "/404.md",
     "/_data.yml",
     "/favicon.png",
+    "/images",
+    "/images/avatar.jpg",
     "/page5.yaml",
     "/pages",
     "/pages/2020-06-21_page2.page.json",
@@ -1596,6 +1607,7 @@ Content of Page 2",
       metas: [
         "title",
         "description",
+        "image",
       ],
       names: "Array(2)",
       page: [

diff --git a/tests/__snapshots__/sitemap.test.ts.snap b/tests/__snapshots__/sitemap.test.ts.snap
@@ -107,6 +107,8 @@ snapshot[`Sitemap plugin 1`] = `
     "/404.md",
     "/_data.yml",
     "/favicon.png",
+    "/images",
+    "/images/avatar.jpg",
     "/page5.yaml",
     "/pages",
     "/pages/2020-06-21_page2.page.json",
@@ -314,6 +316,7 @@ Content of Page 2",
       metas: [
         "title",
         "description",
+        "image",
       ],
       names: "Array(2)",
       page: [
@@ -1604,6 +1607,8 @@ snapshot[`Sitemap plugin with filter_pages plugin 1`] = `
     "/404.md",
     "/_data.yml",
     "/favicon.png",
+    "/images",
+    "/images/avatar.jpg",
     "/page5.yaml",
     "/pages",
     "/pages/2020-06-21_page2.page.json",
@@ -1803,6 +1808,7 @@ Content of Page 2",
       metas: [
         "title",
         "description",
+        "image",
       ],
       names: "Array(2)",
       page: [

diff --git a/tests/assets/normal/images/avatar.jpg b/tests/assets/normal/images/avatar.jpg
diff --git a/tests/assets/normal/pages/2020-06-21_page2.page.json b/tests/assets/normal/pages/2020-06-21_page2.page.json
@@ -1,5 +1,8 @@
 {
   "title": "Page 2",
   "url": "/overrided-page2/",
-  "content": "Content of Page 2"
+  "content": "Content of Page 2",
+  "metas": {
+    "image": "/images/avatar.jpg"
+  }
 }
diff --git a/tests/feed.test.ts b/tests/feed.test.ts
@@ -17,6 +17,7 @@ Deno.test("RSS plugin", async (t) => {
       items: {
         title: (data) => data.title?.toUpperCase(),
         updated: "=date",
+        image: "=metas.image",
       },
     }),
   );