mirror of
https://github.com/withastro/astro.git
synced 2024-12-16 21:46:22 -05:00
81dce94f2a
* chore: strictNullChecks for zod * feat: expose `rssSchema` helper * refactor: align types with schema types * feat: break glob handler to globToRssItems util * refactor: RSS options validation to Zod * refactor: avoid intermediate type * fix: allow numbers and dates in pubDate * test: update glob and error tests * feat: add rss to with-content starter * fix: move globToRssItems back to internal behavior * chore: JSON.stringify * Revert "fix: move globToRssItems back to internal behavior" This reverts commit 85305075e6444907455541b24bccbccd5016951a. * test: missing url * docs: `import.meta.env.SITE` -> `context.site` * docs: update README to content collections example * fix: url -> link * docs: add `rssSchema` to README * chore: consistent formatting * docs: add `pagesGlobToRssItems()` reference * chore: globToRssItems -> pagesGlobToRssItems * chore: changeset * fix: bad docs line highlighting * fix: add collections export to example * nit: remove "our" * fix: are -> all * fix: more README edits * deps: kleur * chore: add back import.meta.glob handling as deprecated * docs: bump down to `minor`, update headline to be less content collections-y * typo: suggest adding * chore: support URL object on `site` * docs: add await to pagesGlob ex * docs: tighten `rssSchema` explainer * docs: tighten pagesGlobToRssItems section * docs: add content to README * docs: replace examples with docs link * docs: re-we Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
154 lines
7.3 KiB
JavaScript
154 lines
7.3 KiB
JavaScript
import rss from '../dist/index.js';
|
|
import chai from 'chai';
|
|
import chaiPromises from 'chai-as-promised';
|
|
import chaiXml from 'chai-xml';
|
|
import {
|
|
title,
|
|
description,
|
|
site,
|
|
phpFeedItem,
|
|
phpFeedItemWithContent,
|
|
phpFeedItemWithCustomData,
|
|
web1FeedItem,
|
|
web1FeedItemWithContent,
|
|
} from './test-utils.js';
|
|
|
|
chai.use(chaiPromises);
|
|
chai.use(chaiXml);
|
|
|
|
// note: I spent 30 minutes looking for a nice node-based snapshot tool
|
|
// ...and I gave up. Enjoy big strings!
|
|
// 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>`;
|
|
// prettier-ignore
|
|
const validXmlWithStylesheet = `<?xml version="1.0" encoding="UTF-8"?><?xml-stylesheet href="/feedstylesheet.css"?><rss version="2.0"><channel><title><![CDATA[${title}]]></title><description><![CDATA[${description}]]></description><link>${site}/</link></channel></rss>`;
|
|
// prettier-ignore
|
|
const validXmlWithXSLStylesheet = `<?xml version="1.0" encoding="UTF-8"?><?xml-stylesheet href="/feedstylesheet.xsl" type="text/xsl"?><rss version="2.0"><channel><title><![CDATA[${title}]]></title><description><![CDATA[${description}]]></description><link>${site}/</link></channel></rss>`;
|
|
|
|
describe('rss', () => {
|
|
it('should generate on valid RSSFeedItem array', async () => {
|
|
const { body } = await rss({
|
|
title,
|
|
description,
|
|
items: [phpFeedItem, web1FeedItem],
|
|
site,
|
|
});
|
|
|
|
chai.expect(body).xml.to.equal(validXmlResult);
|
|
});
|
|
|
|
it('should generate on valid RSSFeedItem array with HTML content included', async () => {
|
|
const { body } = await rss({
|
|
title,
|
|
description,
|
|
items: [phpFeedItemWithContent, web1FeedItemWithContent],
|
|
site,
|
|
});
|
|
|
|
chai.expect(body).xml.to.equal(validXmlWithContentResult);
|
|
});
|
|
|
|
it('should generate on valid RSSFeedItem array with custom data included', async () => {
|
|
const { body } = await rss({
|
|
xmlns: {
|
|
dc: 'http://purl.org/dc/elements/1.1/',
|
|
},
|
|
title,
|
|
description,
|
|
items: [phpFeedItemWithCustomData, web1FeedItemWithContent],
|
|
site,
|
|
});
|
|
|
|
chai.expect(body).xml.to.equal(validXmlWithCustomDataResult);
|
|
});
|
|
|
|
it('should include xml-stylesheet instruction when stylesheet is defined', async () => {
|
|
const { body } = await rss({
|
|
title,
|
|
description,
|
|
items: [],
|
|
site,
|
|
stylesheet: '/feedstylesheet.css',
|
|
});
|
|
|
|
chai.expect(body).xml.to.equal(validXmlWithStylesheet);
|
|
});
|
|
|
|
it('should include xml-stylesheet instruction with xsl type when stylesheet is set to xsl file', async () => {
|
|
const { body } = await rss({
|
|
title,
|
|
description,
|
|
items: [],
|
|
site,
|
|
stylesheet: '/feedstylesheet.xsl',
|
|
});
|
|
|
|
chai.expect(body).xml.to.equal(validXmlWithXSLStylesheet);
|
|
});
|
|
|
|
it('should filter out entries marked as `draft`', async () => {
|
|
const { body } = await rss({
|
|
title,
|
|
description,
|
|
items: [phpFeedItem, { ...web1FeedItem, draft: true }],
|
|
site,
|
|
});
|
|
|
|
chai.expect(body).xml.to.equal(validXmlWithoutWeb1FeedResult);
|
|
});
|
|
|
|
it('should respect drafts option', async () => {
|
|
const { body } = await rss({
|
|
title,
|
|
description,
|
|
drafts: true,
|
|
items: [phpFeedItem, { ...web1FeedItem, draft: true }],
|
|
site,
|
|
drafts: true,
|
|
});
|
|
|
|
chai.expect(body).xml.to.equal(validXmlResult);
|
|
});
|
|
|
|
it('Deprecated import.meta.glob mapping still works', 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,
|
|
},
|
|
})
|
|
),
|
|
};
|
|
|
|
const { body } = await rss({
|
|
title,
|
|
description,
|
|
items: globResult,
|
|
site,
|
|
});
|
|
|
|
chai.expect(body).xml.to.equal(validXmlResult);
|
|
});
|
|
});
|