fix: filter out draft item from glob result (#5612)

* fix: filter out draft item from glob result

* test: rss should ignore draft

* build: add changeset

* build: major version

* feat: add `drafts` option

* Add README docs

Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>

1 files changed, 77 insertions, 0 deletions

diff --git a/packages/astro-rss/test/rss.test.js b/packages/astro-rss/test/rss.test.js
index 95a0bbf10..bd4c9cba7 100644
--- a/packages/astro-rss/test/rss.test.js
+++ b/packages/astro-rss/test/rss.test.js
@@ -44,6 +44,8 @@ const web1FeedItemWithContent = {
 // prettier-ignore
 const validXmlResult = `<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"><channel><title><![CDATA[${title}]]></title><description><![CDATA[${description}]]></description><link>${site}/</link><item><title><![CDATA[${phpFeedItem.title}]]></title><link>${site}${phpFeedItem.link}/</link><guid>${site}${phpFeedItem.link}/</guid><description><![CDATA[${phpFeedItem.description}]]></description><pubDate>${new Date(phpFeedItem.pubDate).toUTCString()}</pubDate></item><item><title><![CDATA[${web1FeedItem.title}]]></title><link>${site}${web1FeedItem.link}/</link><guid>${site}${web1FeedItem.link}/</guid><description><![CDATA[${web1FeedItem.description}]]></description><pubDate>${new Date(web1FeedItem.pubDate).toUTCString()}</pubDate></item></channel></rss>`;
 // prettier-ignore
+const validXmlWithoutWeb1FeedResult = `<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"><channel><title><![CDATA[${title}]]></title><description><![CDATA[${description}]]></description><link>${site}/</link><item><title><![CDATA[${phpFeedItem.title}]]></title><link>${site}${phpFeedItem.link}/</link><guid>${site}${phpFeedItem.link}/</guid><description><![CDATA[${phpFeedItem.description}]]></description><pubDate>${new Date(phpFeedItem.pubDate).toUTCString()}</pubDate></item></channel></rss>`;
+// prettier-ignore
 const validXmlWithContentResult = `<?xml version="1.0" encoding="UTF-8"?><rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/"><channel><title><![CDATA[${title}]]></title><description><![CDATA[${description}]]></description><link>${site}/</link><item><title><![CDATA[${phpFeedItemWithContent.title}]]></title><link>${site}${phpFeedItemWithContent.link}/</link><guid>${site}${phpFeedItemWithContent.link}/</guid><description><![CDATA[${phpFeedItemWithContent.description}]]></description><pubDate>${new Date(phpFeedItemWithContent.pubDate).toUTCString()}</pubDate><content:encoded><![CDATA[${phpFeedItemWithContent.content}]]></content:encoded></item><item><title><![CDATA[${web1FeedItemWithContent.title}]]></title><link>${site}${web1FeedItemWithContent.link}/</link><guid>${site}${web1FeedItemWithContent.link}/</guid><description><![CDATA[${web1FeedItemWithContent.description}]]></description><pubDate>${new Date(web1FeedItemWithContent.pubDate).toUTCString()}</pubDate><content:encoded><![CDATA[${web1FeedItemWithContent.content}]]></content:encoded></item></channel></rss>`;
 // prettier-ignore
 const validXmlWithCustomDataResult = `<?xml version="1.0" encoding="UTF-8"?><rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/"><channel><title><![CDATA[${title}]]></title><description><![CDATA[${description}]]></description><link>${site}/</link><item><title><![CDATA[${phpFeedItemWithCustomData.title}]]></title><link>${site}${phpFeedItemWithCustomData.link}/</link><guid>${site}${phpFeedItemWithCustomData.link}/</guid><description><![CDATA[${phpFeedItemWithCustomData.description}]]></description><pubDate>${new Date(phpFeedItemWithCustomData.pubDate).toUTCString()}</pubDate>${phpFeedItemWithCustomData.customData}</item><item><title><![CDATA[${web1FeedItemWithContent.title}]]></title><link>${site}${web1FeedItemWithContent.link}/</link><guid>${site}${web1FeedItemWithContent.link}/</guid><description><![CDATA[${web1FeedItemWithContent.description}]]></description><pubDate>${new Date(web1FeedItemWithContent.pubDate).toUTCString()}</pubDate><content:encoded><![CDATA[${web1FeedItemWithContent.content}]]></content:encoded></item></channel></rss>`;
@@ -195,6 +197,81 @@ describe('rss', () => {
 				})
 			).to.be.rejected;
 		});
+
+		it('should filter out draft', async () => {
+			const globResult = {
+				'./posts/php.md': () =>
+					new Promise((resolve) =>
+						resolve({
+							url: phpFeedItem.link,
+							frontmatter: {
+								title: phpFeedItem.title,
+								pubDate: phpFeedItem.pubDate,
+								description: phpFeedItem.description,
+							},
+						})
+					),
+				'./posts/nested/web1.md': () =>
+					new Promise((resolve) =>
+						resolve({
+							url: web1FeedItem.link,
+							frontmatter: {
+								title: web1FeedItem.title,
+								pubDate: web1FeedItem.pubDate,
+								description: web1FeedItem.description,
+								draft: true,
+							},
+						})
+					),
+			};
+
+			const { body } = await rss({
+				title,
+				description,
+				items: globResult,
+				site,
+			});
+
+			chai.expect(body).xml.to.equal(validXmlWithoutWeb1FeedResult);
+		});
+
+		it('should respect drafts option', async () => {
+			const globResult = {
+				'./posts/php.md': () =>
+					new Promise((resolve) =>
+						resolve({
+							url: phpFeedItem.link,
+							frontmatter: {
+								title: phpFeedItem.title,
+								pubDate: phpFeedItem.pubDate,
+								description: phpFeedItem.description,
+							},
+						})
+					),
+				'./posts/nested/web1.md': () =>
+					new Promise((resolve) =>
+						resolve({
+							url: web1FeedItem.link,
+							frontmatter: {
+								title: web1FeedItem.title,
+								pubDate: web1FeedItem.pubDate,
+								description: web1FeedItem.description,
+								draft: true,
+							},
+						})
+					),
+			};
+
+			const { body } = await rss({
+				title,
+				description,
+				items: globResult,
+				site,
+				drafts: true,
+			});
+
+			chai.expect(body).xml.to.equal(validXmlResult);
+		});
 	});
 
 	describe('errors', () => {