From 2af237e00dd224cd5f5aa084785ff7caa7cc4924 Mon Sep 17 00:00:00 2001 From: Daniel Roe Date: Sat, 31 Dec 2022 17:24:21 +0100 Subject: [PATCH] feat: add rss feed support (#938) --- nuxt.config.ts | 5 +- package.json | 3 + pnpm-lock.yaml | 78 +++++++++++++++++++ src/app.vue | 1 + .../layout/TheSiteFooter.server.vue | 4 + src/modules/metadata.ts | 9 ++- src/server/plugins/sprite.ts | 3 + src/server/routes/feed.xml.get.ts | 51 ++++++++++++ src/server/routes/og/[slug].get.ts | 2 + 9 files changed, 154 insertions(+), 2 deletions(-) create mode 100644 src/server/routes/feed.xml.get.ts diff --git a/nuxt.config.ts b/nuxt.config.ts index a9a7b0ce..c495d8ad 100644 --- a/nuxt.config.ts +++ b/nuxt.config.ts @@ -53,10 +53,13 @@ export default defineNuxtConfig({ }, prerender: { crawlLinks: true, - routes: ['/', '/uses', '/og/og.jpg'], + routes: ['/', '/uses', '/og/og.jpg', '/feed.xml'], }, hooks: { 'prerender:generate' (route) { + if (route.fileName) + route.fileName = route.fileName.replace(/\.xml\/index.html$/, '.xml') + if (route.error) { process.exit(1) } diff --git a/package.json b/package.json index 9ca6a3cc..890b2d65 100644 --- a/package.json +++ b/package.json @@ -31,12 +31,15 @@ "@nuxtjs/plausible": "0.2.0", "@nuxtjs/tailwindcss": "6.2.0", "@nuxtjs/web-vitals": "0.2.2", + "feed": "^4.2.2", "gray-matter": "4.0.3", "jose": "4.11.1", "magic-regexp": "0.6.1", "nuxt": "npm:nuxt3@3.0.1-rc.0-27863365.da6fa9a", "playwright": "1.29.1", "prism-themes": "1.9.0", + "remark": "^14.0.2", + "remark-html": "^15.0.1", "tslib": "2.4.1" }, "devDependencies": { diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index a2128adf..485299a6 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -24,6 +24,7 @@ specifiers: eslint-config-prettier: 8.5.0 eslint-plugin-nuxt: 4.0.0 eslint-plugin-prettier: 4.2.1 + feed: ^4.2.2 gray-matter: 4.0.3 happy-dom: 8.1.1 husky: 8.0.2 @@ -35,6 +36,8 @@ specifiers: postcss-html: 1.5.0 prettier: 2.8.1 prism-themes: 1.9.0 + remark: ^14.0.2 + remark-html: ^15.0.1 stylelint: 14.16.1 stylelint-config-prettier: 9.0.4 stylelint-config-recommended-vue: 1.4.0 @@ -52,12 +55,15 @@ dependencies: '@nuxtjs/plausible': 0.2.0 '@nuxtjs/tailwindcss': 6.2.0 '@nuxtjs/web-vitals': 0.2.2 + feed: 4.2.2 gray-matter: 4.0.3 jose: 4.11.1 magic-regexp: 0.6.1 nuxt: /nuxt3/3.0.1-rc.0-27863365.da6fa9a_lka7wnccxlw45o2r5fapgs6fya playwright: 1.29.1 prism-themes: 1.9.0 + remark: 14.0.2 + remark-html: 15.0.1 tslib: 2.4.1 devDependencies: @@ -4182,6 +4188,13 @@ packages: dependencies: reusify: 1.0.4 + /feed/4.2.2: + resolution: {integrity: sha512-u5/sxGfiMfZNtJ3OvQpXcvotFpYkL0n9u9mM2vkui2nGo8b4wvDkJ8gAkYqbA8QpGyFCv3RK0Z+Iv+9veCS9bQ==} + engines: {node: '>=0.4.0'} + dependencies: + xml-js: 1.6.11 + dev: false + /fetch-blob/3.2.0: resolution: {integrity: sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==} engines: {node: ^12.20 || >= 14.13} @@ -4747,6 +4760,27 @@ packages: zwitch: 2.0.4 dev: false + /hast-util-sanitize/4.0.0: + resolution: {integrity: sha512-pw56+69jq+QSr/coADNvWTmBPDy+XsmwaF5KnUys4/wM1jt/fZdl7GPxhXXXYdXnz3Gj3qMkbUCH2uKjvX0MgQ==} + dependencies: + '@types/hast': 2.3.4 + dev: false + + /hast-util-to-html/8.0.3: + resolution: {integrity: sha512-/D/E5ymdPYhHpPkuTHOUkSatxr4w1ZKrZsG0Zv/3C2SRVT0JFJG53VS45AMrBtYk0wp5A7ksEhiC8QaOZM95+A==} + dependencies: + '@types/hast': 2.3.4 + ccount: 2.0.1 + comma-separated-tokens: 2.0.3 + hast-util-is-element: 2.1.2 + hast-util-whitespace: 2.0.0 + html-void-elements: 2.0.1 + property-information: 6.2.0 + space-separated-tokens: 2.0.2 + stringify-entities: 4.0.3 + unist-util-is: 5.1.1 + dev: false + /hast-util-to-parse5/7.0.0: resolution: {integrity: sha512-YHiS6aTaZ3N0Q3nxaY/Tj98D6kM8QX5Q8xqgg8G45zR7PvWnPGPP0vcKCgb/moIydEJ/QWczVrX0JODCVeoV7A==} dependencies: @@ -4764,6 +4798,10 @@ packages: '@types/hast': 2.3.4 dev: false + /hast-util-whitespace/2.0.0: + resolution: {integrity: sha512-Pkw+xBHuV6xFeJprJe2BBEoDV+AvQySaz3pPDRUs5PNZEMQjpXJJueqrpcHIXxnWTcAGi/UOCgVShlkY6kLoqg==} + dev: false + /hastscript/7.1.0: resolution: {integrity: sha512-uBjaTTLN0MkCZxY/R2fWUOcu7FRtUVzKRO5P/RAfgsu3yFiMB1JWCO4AjeVkgHxAira1f2UecHK5WfS9QurlWA==} dependencies: @@ -7899,6 +7937,16 @@ packages: - supports-color dev: false + /remark-html/15.0.1: + resolution: {integrity: sha512-7ta5UPRqj8nP0GhGMYUAghZ/DRno7dgq7alcW90A7+9pgJsXzGJlFgwF8HOP1b1tMgT3WwbeANN+CaTimMfyNQ==} + dependencies: + '@types/mdast': 3.0.10 + hast-util-sanitize: 4.0.0 + hast-util-to-html: 8.0.3 + mdast-util-to-hast: 12.2.4 + unified: 10.1.2 + dev: false + /remark-mdc/1.1.3: resolution: {integrity: sha512-ilYSkkQJhu5cUCEE2CJEncoMDoarP32ugfJpFWghXbnv3sWI3j2HtJuArc9tZzxN4ID6fngio3d8N87QfQAnRQ==} dependencies: @@ -7947,6 +7995,25 @@ packages: unified: 10.1.2 dev: false + /remark-stringify/10.0.2: + resolution: {integrity: sha512-6wV3pvbPvHkbNnWB0wdDvVFHOe1hBRAx1Q/5g/EpH4RppAII6J8Gnwe7VbHuXaoKIF6LAg6ExTel/+kNqSQ7lw==} + dependencies: + '@types/mdast': 3.0.10 + mdast-util-to-markdown: 1.3.0 + unified: 10.1.2 + dev: false + + /remark/14.0.2: + resolution: {integrity: sha512-A3ARm2V4BgiRXaUo5K0dRvJ1lbogrbXnhkJRmD0yw092/Yl0kOCZt1k9ZeElEwkZsWGsMumz6qL5MfNJH9nOBA==} + dependencies: + '@types/mdast': 3.0.10 + remark-parse: 10.0.1 + remark-stringify: 10.0.2 + unified: 10.1.2 + transitivePeerDependencies: + - supports-color + dev: false + /replace-in-file/6.3.5: resolution: {integrity: sha512-arB9d3ENdKva2fxRnSjwBEXfK1npgyci7ZZuwysgAp7ORjHSyxz6oqIjTEv8R0Ydl4Ll7uOAZXL4vbkhGIizCg==} engines: {node: '>=10'} @@ -8103,6 +8170,10 @@ packages: /safer-buffer/2.1.2: resolution: {integrity: sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==} + /sax/1.2.4: + resolution: {integrity: sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==} + dev: false + /schema-utils/3.1.1: resolution: {integrity: sha512-Y5PQxS4ITlC+EahLuXaY86TXfR7Dc5lw294alXOq86JAHCihAIZfqv8nNCWvaEJvaC51uN9hbLGeV0cFBdH+Fw==} engines: {node: '>= 10.13.0'} @@ -9738,6 +9809,13 @@ packages: optional: true dev: false + /xml-js/1.6.11: + resolution: {integrity: sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g==} + hasBin: true + dependencies: + sax: 1.2.4 + dev: false + /xml-name-validator/4.0.0: resolution: {integrity: sha512-ICP2e+jsHvAj2E2lIHxa5tjXRlKDJo4IdvPvCXbXQGdzSfmSpNVyIKMvoZHjDY9DP0zV17iI85o90vRFXNccRw==} engines: {node: '>=12'} diff --git a/src/app.vue b/src/app.vue index ff1c4657..5ac4f3e6 100644 --- a/src/app.vue +++ b/src/app.vue @@ -78,6 +78,7 @@ if (process.server) { { rel: 'canonical', href: url }, { rel: 'mask-icon', color: '#fff', href: '/favicon.svg' }, { rel: 'icon', type: 'image/svg', href: '/favicon.svg' }, + { rel: 'alternate', type: 'application/rss+xml', href: '/feed.xml' }, { rel: 'apple-touch-icon', sizes: '180x180', diff --git a/src/components/layout/TheSiteFooter.server.vue b/src/components/layout/TheSiteFooter.server.vue index b75bf2c9..cb7ea4e6 100644 --- a/src/components/layout/TheSiteFooter.server.vue +++ b/src/components/layout/TheSiteFooter.server.vue @@ -16,6 +16,10 @@ const links = [ link: 'https://mastodon.roe.dev/@daniel', name: 'Mastodon', }, + { + link: '/feed.xml', + name: 'RSS', + }, ] const year = new Date().getFullYear() diff --git a/src/modules/metadata.ts b/src/modules/metadata.ts index 0307c68c..c2ed418d 100644 --- a/src/modules/metadata.ts +++ b/src/modules/metadata.ts @@ -3,6 +3,8 @@ import { createResolver, defineNuxtModule, useNuxt } from '@nuxt/kit' import { globby } from 'globby' import grayMatter from 'gray-matter' import { filename } from 'pathe/utils' +import { remark } from 'remark' +import remarkHtml from 'remark-html' export default defineNuxtModule({ meta: { @@ -14,13 +16,18 @@ export default defineNuxtModule({ const files = await globby(resolve('../content/blog')) const metadata: Record = {} + const md = remark().use(remarkHtml) + for (const path of files) { - const contents = await readFile(path) + const contents = await readFile(path, 'utf-8') const slug = filename(path) const { data } = grayMatter(contents) const date = new Date(data.date) metadata[slug] = { ...data, + html: await md + .process(contents.replace(/---[\s\S]*---/m, '')) + .then(r => r.value), date: `${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}`, } } diff --git a/src/server/plugins/sprite.ts b/src/server/plugins/sprite.ts index 933da042..c75d6c7a 100644 --- a/src/server/plugins/sprite.ts +++ b/src/server/plugins/sprite.ts @@ -24,6 +24,9 @@ const sprite = + + + `.replace(/\s+/g, ' ') diff --git a/src/server/routes/feed.xml.get.ts b/src/server/routes/feed.xml.get.ts new file mode 100644 index 00000000..c2f0fd1a --- /dev/null +++ b/src/server/routes/feed.xml.get.ts @@ -0,0 +1,51 @@ +import { Feed } from 'feed' + +// @ts-expect-error virtual file +import { metadata } from '#metadata.json' + +export default defineEventHandler(async () => { + if (!process.dev && !process.env.prerender) return + + const feed = new Feed({ + title: 'Daniel Roe', + description: 'The personal website of Daniel Roe', + id: 'https://roe.dev/', + link: 'https://roe.dev/blog', + language: 'en', + image: 'https://roe.dev/og/og.jpg', + favicon: 'https://roe.dev/favicon.svg', + copyright: `© 2019-${new Date().getFullYear()} Daniel Roe. All rights reserved.`, + feedLinks: { + json: 'https://roe.dev/feed/json', + atom: 'https://roe.dev/feed/atom', + }, + author: { + name: 'Daniel Roe', + email: 'daniel@roe.dev', + link: 'https://roe.dev/', + }, + }) + + for (const slug in metadata) { + const blog = metadata[slug] + feed.addItem({ + title: blog.title, + id: slug, + link: `https://roe.dev/blog/${slug}`, + description: blog.description, + content: blog.html, + category: blog.tags.map((tag: string) => ({ name: tag })), + author: [ + { + name: 'Daniel Roe', + email: 'daniel@roe.dev', + link: 'https://roe.dev', + }, + ], + date: new Date(blog.date), + image: `https://roe.dev/og/${slug}.jpg`, + }) + } + + return feed.rss2() +}) diff --git a/src/server/routes/og/[slug].get.ts b/src/server/routes/og/[slug].get.ts index 3febc9a2..66c1a112 100644 --- a/src/server/routes/og/[slug].get.ts +++ b/src/server/routes/og/[slug].get.ts @@ -6,6 +6,8 @@ import { getScreenshot } from '../../utils/_chromium' const isDev = process.env.VERCEL_ENV === 'development' export default defineEventHandler(async event => { + if (!process.dev && !process.env.prerender) return + let { slug } = event.context.params slug = slug?.replace(/\.jpg$/, '') -- knotmirror 0.0.1