feat: provide rss, atom and json feeds for the blog#2562
feat: provide rss, atom and json feeds for the blog#2562Kiwow wants to merge 26 commits intonpmx-dev:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
📝 WalkthroughWalkthroughAdds syndicated feeds (RSS, Atom, JSON) with server routes and a feed-generation utility, injects alternate feed links into the blog page, updates Nuxt/Nitro config and esbuild, adds the ChangesBlog feeds feature
Sequence Diagram(s)sequenceDiagram
participant Browser
participant BlogPage as Blog Page
participant FeedRoute as Feed Route (/rss.xml, /atom.xml, /feed.json)
participant FeedUtil as getFeed() Utility
participant BlogPosts as Blog Posts Data
Browser->>BlogPage: Request /blog
BlogPage-->>Browser: Render page with alternate feed links
Browser->>FeedRoute: Request feed endpoint (via link)
FeedRoute->>FeedUtil: Call getFeed()
FeedUtil->>BlogPosts: Load posts (exclude drafts)
BlogPosts-->>FeedUtil: Return posts
FeedUtil->>FeedUtil: Build new Feed object (items, authors, links, dates)
FeedUtil-->>FeedRoute: Return Feed
FeedRoute->>FeedRoute: Serialize (.rss2/.atom1/.json1)
FeedRoute-->>Browser: Respond with feed + Content-Type + CORS
Suggested reviewers
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
📊 Dependency Size ChangesWarning This PR adds 481.4 kB of new dependencies, which exceeds the threshold of 200 kB.
Total size change: 481.4 kB |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
| const atomPath = 'atom.xml' | ||
| const jsonFeedPath = 'feed.json' | ||
|
|
||
| await Promise.all([ |
There was a problem hiding this comment.
Maybe instead of saving these files to disk, creating pre-rendered server-side routes could be a cleaner approach 🤔. Similar to server/routes/opensearch.xml.get.ts with https://nuxt.com/docs/4.x/getting-started/prerendering#selective-pre-rendering
There was a problem hiding this comment.
Sounds like exactly what I was looking for and didn't find. Thanks!
I'll add a mention of this to the PR description and look into it when I have time to work on this again.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (3)
test/e2e/feeds.spec.ts (1)
20-49: Test is mostly solid; a couple of small robustness nits.
expect(href.slice(0, 16)).toBe('https://npmx.dev')is correct arithmetic ('https://npmx.dev'.length === 16) but brittle — any host-name change silently breaks both the prefix check and the derivedurl = href.slice(16). Prefer matching on the parsed URL so intent is obvious and the "derive path from href" step can't go wrong:- // href is an absolute link - expect(href.slice(0, 16)).toBe('https://npmx.dev') - - const { contentType, corsHeader } = await page.evaluate(async href => { - // Fetch the same path as in the alternate link - const url = href.slice(16) - const response = await fetch(url) + // href must be an absolute URL on the production origin + const parsed = new URL(href) + expect(parsed.origin).toBe('https://npmx.dev') + + const { contentType, corsHeader } = await page.evaluate(async path => { + const response = await fetch(path) return { contentType: response.headers.get('Content-Type'), corsHeader: response.headers.get('Access-Control-Allow-Origin'), } - }, href) + }, parsed.pathname)
await expect(locator).toHaveAttribute('href')without a second argument checks existence (fine), and the subsequentgetAttribute('href')+expect(href).not.toBeNull()+typeof href !== 'string'guard is a bit redundant. You can drop the first assertion and keep the null/string guard, sinceexpect(href).not.toBeNull()already fails the test on absence.Minor:
response.headers.get('Content-Type')returns the full header value, which may include charset parameters (application/rss+xml; charset=utf-8) depending on the server. Right nowtoBe(feed.contentType)would break if Nitro ever adds a charset. Considerexpect(contentType).toMatch(new RegExp('^' + feed.contentType))to be forward-compatible.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@test/e2e/feeds.spec.ts` around lines 20 - 49, The test should parse the alternate link href with the URL API instead of slicing and remove the redundant locator existence assert; change the code to getAttribute('href') into href, guard for null/string, then create const parsed = new URL(href) and assert parsed.origin === 'https://npmx.dev' (or the intended host) and pass parsed.pathname+parsed.search into page.evaluate for fetching; finally relax the content-type check to match the media type prefix (e.g., use a startsWith or regex like '^' + feed.contentType) when asserting response.headers.get('Content-Type') so charset parameters won't break the test — update references: locator, href, page.evaluate, response.headers.get and the expect(contentType) assertion accordingly.nuxt.config.ts (1)
195-206: CORS + Content-Type via route rules — looks good.Matches the PR checklist (enable CORS, serve correct MIME types) and the values are exactly what
test/e2e/feeds.spec.tsasserts. One small thought: if you want feeds to be cacheable by intermediaries, consider adding aCache-Control: public, max-age=…header alongside — otherwise feed aggregators may hit the origin more often than needed.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@nuxt.config.ts` around lines 195 - 206, The route rules for '/rss.xml', '/atom.xml', and '/feed.json' currently set CORS and Content-Type but lack caching; update the headers object in nuxt.config.ts for the route keys '/rss.xml', '/atom.xml', and '/feed.json' to include a Cache-Control header (e.g. 'Cache-Control': 'public, max-age=3600') so intermediaries can cache feeds; modify the headers for the RouteRule entries (the objects used for these paths) accordingly and run/update any tests that assert exact header sets if needed.app/pages/blog/index.vue (1)
19-40: Remove hard-coded feed URLs and title; use root-relative hrefs or derive from site config.The three hard-coded
https://npmx.dev/*hrefs and the fixed'Blog - npmx'title duplicate values already present innuxt.config.ts(site.url,site.name) and inserver/utils/feeds.ts. If the canonical origin ever changes (staging, preview branches, a rename), these links will silently point at the wrong host. Also note these are already absolute on a blog page onnpmx.dev— a root-relativehref(/rss.xml, etc.) is equally valid for<link rel="alternate">and would avoid hard-coding the origin on the client.Consider either:
Option A — root-relative hrefs
- href: 'https://npmx.dev/rss.xml', + href: '/rss.xml', ... - href: 'https://npmx.dev/atom.xml', + href: '/atom.xml', ... - href: 'https://npmx.dev/feed.json', + href: '/feed.json',Option B — derive from site config
const siteConfig = useSiteConfig() const origin = siteConfig.url // 'https://npmx.dev' useHead({ link: [ { rel: 'alternate', title: `${siteConfig.name} Blog`, type: 'application/rss+xml', href: `${origin}/rss.xml` }, { rel: 'alternate', title: `${siteConfig.name} Blog`, type: 'application/atom+xml', href: `${origin}/atom.xml` }, { rel: 'alternate', title: `${siteConfig.name} Blog`, type: 'application/feed+json', href: `${origin}/feed.json` }, ], })Note:
useSiteConfig()is already used elsewhere in the codebase (app/components/OgImage/Splash.takumi.vue), making Option B a viable pattern. Also consider updating the matching hard-coded URLs inserver/utils/feeds.tsfor consistency.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@app/pages/blog/index.vue` around lines 19 - 40, Replace the hard-coded feed hrefs and title in the useHead call with either root-relative paths or values derived from the site's config: stop using 'https://npmx.dev/*' and the fixed 'Blog - npmx' string in the link array inside useHead; instead call useSiteConfig() (already used elsewhere), read siteConfig.url (if you need absolute origin) and siteConfig.name (for the title), and set hrefs to '/rss.xml', '/atom.xml', '/feed.json' or to `${siteConfig.url}/rss.xml` etc., and set title to `${siteConfig.name} Blog`; update the same pattern in server/utils/feeds.ts as well for consistency.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@nuxt.config.ts`:
- Around line 243-251: The esbuild exclude regex under the esbuild options
currently targets node_modules/.cache/nuxt/.nuxt/blog/posts.ts which won't match
Nuxt's actual buildDir (e.g. .nuxt/blog/posts.ts); update the exclude pattern in
the esbuild.options.exclude to allow the generated .nuxt/blog/posts.ts (or
otherwise include .nuxt/**/blog/posts.ts) so the `#blog/posts` import isn't
excluded, and add a simple runtime/build-time assertion or log of the resolved
buildDir used by Nuxt (referenced from server/utils/feeds.ts) to surface
mismatches early; also fix the comment path to use forward slashes
(server/utils/feeds.ts) for consistency.
In `@package.json`:
- Line 136: Move the "feed" package from devDependencies to dependencies in
package.json so it is available at runtime; update package.json by removing
"feed": "5.2.0" from devDependencies and adding the same entry under
dependencies. This ensures imports in server/utils/feeds.ts (used by the
/rss.xml, /atom.xml and /feed.json routes with prerender: true) are present in
production builds and prevents runtime errors if those routes are ever rendered
on-demand.
In `@server/utils/feeds.ts`:
- Around line 4-17: Add a short clarifying comment above the module-level
variable "feed" explaining that this cache is build-time only because getFeed()
calls generateFeed() once at module import (used for prerendered /rss.xml,
/atom.xml, /feed.json), and that if prerendering/ISR is removed the cache will
become stale and must be invalidated or regenerated (e.g., reset feed or call
generateFeed on each request); reference the "feed" variable, the getFeed()
function and generateFeed() to make the intended lifetime and required
invalidation explicit for future maintainers.
- Around line 19-54: generateFeed currently passes post.image through unchanged
causing broken thumbnails; update the feed.addItem call in function generateFeed
to normalize post.image the same way author.avatar is normalized (e.g., if
post.image exists, set image to new URL(post.image, siteUrl).toString()), and
replace the hard-coded title/description/id/link values with values pulled from
the shared site config (useSiteConfig() or equivalent) so title/description/site
URL are derived from the single source of truth used by nuxt.config.ts and
app/pages/blog/index.vue.
---
Nitpick comments:
In `@app/pages/blog/index.vue`:
- Around line 19-40: Replace the hard-coded feed hrefs and title in the useHead
call with either root-relative paths or values derived from the site's config:
stop using 'https://npmx.dev/*' and the fixed 'Blog - npmx' string in the link
array inside useHead; instead call useSiteConfig() (already used elsewhere),
read siteConfig.url (if you need absolute origin) and siteConfig.name (for the
title), and set hrefs to '/rss.xml', '/atom.xml', '/feed.json' or to
`${siteConfig.url}/rss.xml` etc., and set title to `${siteConfig.name} Blog`;
update the same pattern in server/utils/feeds.ts as well for consistency.
In `@nuxt.config.ts`:
- Around line 195-206: The route rules for '/rss.xml', '/atom.xml', and
'/feed.json' currently set CORS and Content-Type but lack caching; update the
headers object in nuxt.config.ts for the route keys '/rss.xml', '/atom.xml', and
'/feed.json' to include a Cache-Control header (e.g. 'Cache-Control': 'public,
max-age=3600') so intermediaries can cache feeds; modify the headers for the
RouteRule entries (the objects used for these paths) accordingly and run/update
any tests that assert exact header sets if needed.
In `@test/e2e/feeds.spec.ts`:
- Around line 20-49: The test should parse the alternate link href with the URL
API instead of slicing and remove the redundant locator existence assert; change
the code to getAttribute('href') into href, guard for null/string, then create
const parsed = new URL(href) and assert parsed.origin === 'https://npmx.dev' (or
the intended host) and pass parsed.pathname+parsed.search into page.evaluate for
fetching; finally relax the content-type check to match the media type prefix
(e.g., use a startsWith or regex like '^' + feed.contentType) when asserting
response.headers.get('Content-Type') so charset parameters won't break the test
— update references: locator, href, page.evaluate, response.headers.get and the
expect(contentType) assertion accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: dae01d38-ddfa-4c63-be76-09ac26327e96
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (8)
app/pages/blog/index.vuenuxt.config.tspackage.jsonserver/routes/atom.xml.get.tsserver/routes/feed.json.get.tsserver/routes/rss.xml.get.tsserver/utils/feeds.tstest/e2e/feeds.spec.ts
| "devalue": "5.6.4", | ||
| "eslint-plugin-regexp": "3.1.0", | ||
| "fast-check": "4.6.0", | ||
| "feed": "5.2.0", |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Confirm the feed package is only used behind prerendered routes and nowhere on a runtime path.
rg -nP "from ['\"]feed['\"]|require\(['\"]feed['\"]\)" --type=ts --type=js --type=vue
echo '---'
# Double-check no non-prerendered route imports getFeed
rg -nP -C2 "getFeed\s*\(" --type=tsRepository: npmx-dev/npmx.dev
Length of output: 992
🏁 Script executed:
# Check where feed is imported in feeds.ts
cat -n server/utils/feeds.ts | head -20
echo '=== Checking nuxt.config.ts for prerender settings ==='
# Search for prerender configurations for the feed routes
rg -nP "atom\.xml|rss\.xml|feed\.json" nuxt.config.ts
echo '=== Current package.json state for feed ==='
# Check where feed is currently placed in package.json
rg -nP -B2 -A2 '"feed":\s*"5\.2\.0"' package.json
echo '=== Searching for any other getFeed or feed imports ==='
# Broader search for any other getFeed invocations
rg -nP "getFeed" --type=tsRepository: npmx-dev/npmx.dev
Length of output: 1513
🏁 Script executed:
# View the prerender configuration for the feed routes in nuxt.config.ts
sed -n '193,210p' nuxt.config.tsRepository: npmx-dev/npmx.dev
Length of output: 693
Move feed from devDependencies to dependencies for runtime safety.
feed is imported in server/utils/feeds.ts and used only by three routes (/rss.xml, /atom.xml, /feed.json), all of which have prerender: true in nuxt.config.ts. While this means the dependency is needed only at build time in a fully prerendered deploy, moving it to dependencies is recommended as a safer posture. If any of these routes ever fall back to runtime rendering—such as an ISR fallback, dev preview in production mode, or a prerender failure served on-demand—Nitro's bundled output will reference feed at runtime and it will be missing in a --prod/--production install.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@package.json` at line 136, Move the "feed" package from devDependencies to
dependencies in package.json so it is available at runtime; update package.json
by removing "feed": "5.2.0" from devDependencies and adding the same entry under
dependencies. This ensures imports in server/utils/feeds.ts (used by the
/rss.xml, /atom.xml and /feed.json routes with prerender: true) are present in
production builds and prevents runtime errors if those routes are ever rendered
on-demand.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
server/utils/feeds.ts (1)
49-49:⚠️ Potential issue | 🟠 MajorNormalise
post.imageto an absolute URL.
post.imagecan be a relative authored value, unlike the avatar path which is already normalised. Passing it through can break thumbnails in feed readers.Proposed fix
- image: post.image, + image: post.image ? new URL(post.image, 'https://npmx.dev').toString() : undefined,🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@server/utils/feeds.ts` at line 49, post.image is sometimes a relative URL and needs to be converted to an absolute URL before being emitted in the feed; update the code that sets image: post.image in server/utils/feeds.ts to normalise post.image to an absolute URL (using the app/site base origin from your config or request context), e.g. resolve relative paths against the site base and ensure the value is an absolute URL string, and reuse any existing avatar-normalisation helper if available so feed thumbnails don’t break.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@server/utils/feeds.ts`:
- Around line 42-47: The feed item currently sets author: post.authors.map(...)
which creates an authors array that the feed library ignores past the first
element; change this to use only the primary author (e.g., author:
post.authors[0] transformed the same way) so co-authors are not silently
dropped, and add a brief comment near the author assignment referencing the feed
library/JSON Feed 1.0 limitation (or alternately note in docs that only the
first author is preserved); update the transformation logic used in author
mapping (name, link, absolute avatar URL) to operate on post.authors[0] and
ensure null/empty checks handle when there is no author.
---
Duplicate comments:
In `@server/utils/feeds.ts`:
- Line 49: post.image is sometimes a relative URL and needs to be converted to
an absolute URL before being emitted in the feed; update the code that sets
image: post.image in server/utils/feeds.ts to normalise post.image to an
absolute URL (using the app/site base origin from your config or request
context), e.g. resolve relative paths against the site base and ensure the value
is an absolute URL string, and reuse any existing avatar-normalisation helper if
available so feed thumbnails don’t break.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 6a61b6bf-8a0c-4faa-b54a-2193e8891cd7
📒 Files selected for processing (2)
server/utils/feeds.tstest/e2e/feeds.spec.ts
✅ Files skipped from review due to trivial changes (1)
- test/e2e/feeds.spec.ts
| author: post.authors.map(author => ({ | ||
| name: author.name, | ||
| link: author.profileUrl ?? undefined, | ||
| // author.avatar is a relative URL - make it absolute to work in feed readers | ||
| avatar: author.avatar ? new URL(author.avatar, 'https://npmx.dev').toString() : undefined, | ||
| })), |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Description: Verify how the locked `feed` dependency serialises multiple item authors to JSON.
# Expected: If the generated item has only `author` and no `authors` array, co-authors are not preserved in /feed.json.
node --input-type=module <<'NODE'
import { Feed } from 'feed'
const feed = new Feed({
title: 'Test feed',
description: 'Test feed',
id: 'https://example.com/',
link: 'https://example.com/',
copyright: 'Test',
})
feed.addItem({
title: 'Multi-author post',
id: 'https://example.com/posts/multi-author',
link: 'https://example.com/posts/multi-author',
date: new Date('2026-01-01T00:00:00.000Z'),
author: [
{ name: 'Author One' },
{ name: 'Author Two' },
],
})
const item = JSON.parse(feed.json1()).items[0]
console.log(JSON.stringify(item, null, 2))
console.log('has_authors_array=' + Array.isArray(item.authors))
console.log('single_author_name=' + (item.author?.name ?? ''))
NODERepository: npmx-dev/npmx.dev
Length of output: 1061
🏁 Script executed:
git ls-files | head -20Repository: npmx-dev/npmx.dev
Length of output: 699
🏁 Script executed:
cat -n server/utils/feeds.ts | head -60Repository: npmx-dev/npmx.dev
Length of output: 2006
🏁 Script executed:
cat package.jsonRepository: npmx-dev/npmx.dev
Length of output: 5846
🏁 Script executed:
# Install feed and test multi-author serialization
cd /tmp && npm install feed@5.2.0 --silent 2>&1 | tail -5Repository: npmx-dev/npmx.dev
Length of output: 43
🌐 Web query:
feed npm package 5.2.0 multi-author JSON Feed 1.1 serialization
💡 Result:
The npm package "feed" version 5.2.0 (published Jan 12, 2026) is a Node.js library for generating RSS 2.0, Atom 1.0, and JSON Feed 1.0 feeds. It supports serialization to JSON Feed via the feed.json1 method. Official documentation and repo explicitly state "JSON Feed 1.0" support (e.g., README: "console.log(feed.json1); // Output: JSON Feed 1.0"). No mentions of JSON Feed 1.1 support (which adds authors array, deprecates singular author, adds language) in v5.2.0 changelog, releases, or docs. JSON Feed 1.1 spec dates to 2020, but package labels it as 1.0. Multi-author support: Uses singular author object for feed-level author (with avatar JSON-only) and addContributor for additional contributors (array). This maps to JSON Feed 1.0's singular author + contributors array, not 1.1's authors array. No evidence of authors array output in 1.1 format. Example usage for JSON Feed serialization: import { Feed } from 'feed'; const feed = new Feed({ title: 'Example Feed', id: 'https://example.com', link: 'https://example.com', description: 'Multi-author feed example', author: { name: 'Primary Author', email: 'primary@example.com' }, // ... }); feed.addContributor({ name: 'Contributor 1', link: 'https://example.com/c1' }); feed.addContributor({ name: 'Contributor 2' }); const jsonFeed = feed.json1; // Serializes to JSON Feed 1.0 format To confirm exact output, inspect feed.json1 string (starts with {"version":"https://jsonfeed.org/version/1.0",...} with "author":{...} and "contributors":[...], not 1.1 authors array).
Citations:
- 1: https://www.npmjs.com/package/feed
- 2: https://github.com/jpmonette/feed/releases/tag/5.2.0
- 3: https://registry.npmjs.org/feed
- 4: https://github.com/jpmonette/feed/tree/master
- 5: https://github.com/jpmonette/feed/blob/master/README.md
- 6: https://www.jsonfeed.org/version/1.1/
🏁 Script executed:
cd /tmp && cat > test-feed.js << 'EOF'
import { Feed } from 'feed';
const feed = new Feed({
title: 'Test',
description: 'Test',
id: 'https://example.com/',
link: 'https://example.com/',
});
// Test 1: Array in author field (what the code does)
feed.addItem({
title: 'Multi-author (array)',
id: '1',
link: 'https://example.com/1',
date: new Date('2026-01-01'),
author: [
{ name: 'Author One', link: 'https://example.com/a1' },
{ name: 'Author Two', link: 'https://example.com/a2' },
],
});
const json = JSON.parse(feed.json1());
const item = json.items[0];
console.log('=== TEST: Array in author field ===');
console.log('JSON Feed version:', json.version);
console.log('Item author field type:', typeof item.author);
console.log('Item author:', JSON.stringify(item.author, null, 2));
console.log('Has authors array:', Array.isArray(item.authors));
console.log('Item contributors:', JSON.stringify(item.contributors || 'NONE', null, 2));
EOF
node test-feed.jsRepository: npmx-dev/npmx.dev
Length of output: 697
🏁 Script executed:
cd /tmp && cat > test-feed-contributors.js << 'EOF'
import { Feed } from 'feed';
const feed = new Feed({
title: 'Test',
description: 'Test',
id: 'https://example.com/',
link: 'https://example.com/',
});
// Test: Using contributors parameter
feed.addItem({
title: 'Multi-author (with contributors)',
id: '2',
link: 'https://example.com/2',
date: new Date('2026-01-01'),
author: { name: 'Author One', link: 'https://example.com/a1' },
contributors: [
{ name: 'Author Two', link: 'https://example.com/a2' },
{ name: 'Author Three', link: 'https://example.com/a3' },
],
});
const json = JSON.parse(feed.json1());
const item = json.items[0];
console.log('=== TEST: contributors parameter ===');
console.log('Item author:', JSON.stringify(item.author, null, 2));
console.log('Item contributors:', JSON.stringify(item.contributors || 'NONE', null, 2));
EOF
node test-feed-contributors.jsRepository: npmx-dev/npmx.dev
Length of output: 605
🏁 Script executed:
cd /tmp && cat > inspect-feed.js << 'EOF'
import { Feed } from 'feed';
const feed = new Feed({
title: 'Test',
description: 'Test',
id: 'https://example.com/',
link: 'https://example.com/',
});
feed.addItem({
title: 'Test item',
id: '1',
link: 'https://example.com/1',
date: new Date('2026-01-01'),
author: { name: 'Single Author' },
});
// Check available methods
console.log('Feed methods:', Object.getOwnPropertyNames(Object.getPrototypeOf(feed))
.filter(m => m.startsWith('json') || m.includes('feed') || m.includes('item')));
// Full JSON Feed 1.0 output
const json1Output = JSON.parse(feed.json1());
console.log('\njson1() version:', json1Output.version);
console.log('First item keys:', Object.keys(json1Output.items[0]));
EOF
node inspect-feed.jsRepository: npmx-dev/npmx.dev
Length of output: 592
Co-authors are lost when serialising to JSON Feed because the feed library only preserves the first author.
The code passes an array to the author field, but the feed library (v5.2.0) outputs JSON Feed 1.0 format, which supports only a single author object per item—not an authors array. When an array is passed, the library silently uses only the first author and discards the rest. The JSON Feed 1.0 spec has no mechanism to represent co-authors at the item level.
To preserve co-author attribution, either use only the first author (author: post.authors[0]) and document the limitation, or consider an alternative feed library with JSON Feed 1.1 support. JSON Feed 1.1 introduced the authors array field, though the current feed library does not yet support it.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@server/utils/feeds.ts` around lines 42 - 47, The feed item currently sets
author: post.authors.map(...) which creates an authors array that the feed
library ignores past the first element; change this to use only the primary
author (e.g., author: post.authors[0] transformed the same way) so co-authors
are not silently dropped, and add a brief comment near the author assignment
referencing the feed library/JSON Feed 1.0 limitation (or alternately note in
docs that only the first author is preserved); update the transformation logic
used in author mapping (name, link, absolute avatar URL) to operate on
post.authors[0] and ensure null/empty checks handle when there is no author.
Conflicts: pnpm-lock.yaml
This reverts commit aa540af.
|
When it comes to feed validity, I don't love the situation but I'm happy to defer the decision to the community:
I think the possible solutions here are to just accept what Personally, I took time off this PR because life happened, but I'd be happy to try and write up a custom implementation if that makes sense to people. If so, I'm also unsure whether that should be part of this PR or a follow-up. |
2 participants
I'm opening this as a draft so that progress on it is transparent. Feedback is appreciated even before it's ready!
🔗 Linked issue
Resolves #2489
The plan
feedpackagemodules/blog.tsis creating in.nuxt/blog/posts.ts, possibly in the same module setup<link rel="alternate">elements for readers to find the feedsChecklist
Before merging, I need to make sure that:
Issues / obstacles:
The feed package currently doesn't support JSON Feed 1.1, which added support for multiple authors. This means it silently throws away all but the first author we specify in an the
authorarray. Manually parsing the object after it gets generated and adding in the other authors is an option, but then we'd be lying about the version that we're serving. Alternatively, it shouldn't be that hard to write the JSON Feed serializer ourselves (thefeedimplementation is a bit over 100 lines of code)RSS (the spec) seemingly doesn't support multiple authors at all, or just in convention, where you put everyone into an
<author>tag. I'll have to try and test some readers / find how feeds handle multiple authors to figure out a good solution. Either way, thefeedpackage includes multiple<author>tags, which seems to be valid in Atom but not in RSS.Also see my update comment on this