feat: publish draft posts (with badge + noindex)#1829
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
📝 WalkthroughWalkthroughThe change adds draft post support across the blog: a new 🚥 Pre-merge checks | ✅ 1✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
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 |
|
@danielroe can you provide some context about why we want to show draft posts to everyone in the world please? Also you'll need to remove the hello world blog post to merge this I think. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
app/components/BlogPostListCard.vueapp/components/global/BlogPostWrapper.vueapp/pages/blog/index.vuei18n/locales/en.jsoni18n/schema.jsonlunaria/files/en-GB.jsonlunaria/files/en-US.jsonmodules/blog.ts
| // Add X-Robots-Tag header for draft posts to prevent indexing | ||
| const posts = loadBlogPosts(blogDir) | ||
| for (const post of posts) { | ||
| if (post.draft) { | ||
| nuxt.options.routeRules ||= {} | ||
| nuxt.options.routeRules[`/blog/${post.slug}`] = { | ||
| headers: { 'X-Robots-Tag': 'noindex, nofollow' }, | ||
| } | ||
| }) | ||
| } | ||
| } |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "1) Blog posts with explicit frontmatter path (slug/path mismatch risk):"
rg -n --type=md '^path:\s*' app/pages/blog || true
echo
echo "2) Existing routeRules definitions that could be clobbered:"
rg -n -C2 'routeRules' . || trueRepository: npmx-dev/npmx.dev
Length of output: 1193
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== Blog post type/interface definition (checking for 'path' property) ==="
rg -n 'interface.*[Pp]ost|type.*[Pp]ost' modules/blog.ts -A 20 | head -50
echo
echo "=== loadBlogPosts function to understand post structure ==="
rg -n 'function loadBlogPosts|const loadBlogPosts' modules/blog.ts -A 30 | head -60
echo
echo "=== Full nuxt.config.ts routeRules to check for blog routes ==="
rg -n 'routeRules:' nuxt.config.ts -A 30
echo
echo "=== Check for post.path usage in modules/blog.ts ==="
rg -n 'post\.path' modules/blog.ts || echo "No post.path found"Repository: npmx-dev/npmx.dev
Length of output: 4171
Use post.path instead of hardcoded /blog/${post.slug} and merge headers when updating route rules.
The code ignores the normalised post.path property (set at line 26) and hardcodes /blog/${post.slug} instead, which can cause misalignment if posts use custom paths. Additionally, overwriting the entire routeRules entry discards any existing rule fields without merging headers, risking loss of previously configured settings.
💡 Suggested fix
- for (const post of posts) {
- if (post.draft) {
- nuxt.options.routeRules ||= {}
- nuxt.options.routeRules[`/blog/${post.slug}`] = {
- headers: { 'X-Robots-Tag': 'noindex, nofollow' },
- }
- }
- }
+ for (const post of posts) {
+ if (!post.draft) continue
+
+ nuxt.options.routeRules ||= {}
+ const routePath = post.path || `/blog/${post.slug}`
+ const existingRule = nuxt.options.routeRules[routePath] ?? {}
+ const existingHeaders
+ = typeof existingRule === 'object' && existingRule && 'headers' in existingRule
+ ? (existingRule.headers as Record<string, string> | undefined)
+ : undefined
+
+ nuxt.options.routeRules[routePath] = {
+ ...existingRule,
+ headers: {
+ ...existingHeaders,
+ 'X-Robots-Tag': 'noindex, nofollow',
+ },
+ }
+ }📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // Add X-Robots-Tag header for draft posts to prevent indexing | |
| const posts = loadBlogPosts(blogDir) | |
| for (const post of posts) { | |
| if (post.draft) { | |
| nuxt.options.routeRules ||= {} | |
| nuxt.options.routeRules[`/blog/${post.slug}`] = { | |
| headers: { 'X-Robots-Tag': 'noindex, nofollow' }, | |
| } | |
| }) | |
| } | |
| } | |
| // Add X-Robots-Tag header for draft posts to prevent indexing | |
| const posts = loadBlogPosts(blogDir) | |
| for (const post of posts) { | |
| if (!post.draft) continue | |
| nuxt.options.routeRules ||= {} | |
| const routePath = post.path || `/blog/${post.slug}` | |
| const existingRule = nuxt.options.routeRules[routePath] ?? {} | |
| const existingHeaders | |
| = typeof existingRule === 'object' && existingRule && 'headers' in existingRule | |
| ? (existingRule.headers as Record<string, string> | undefined) | |
| : undefined | |
| nuxt.options.routeRules[routePath] = { | |
| ...existingRule, | |
| headers: { | |
| ...existingHeaders, | |
| 'X-Robots-Tag': 'noindex, nofollow', | |
| }, | |
| } | |
| } |
|
the blog posts shouldn't be visible on the index (that's a bug!) or crawlable by search engines, so you have to know the exact link. but it's possibly helpful for sharing links in advance, and getting review from people. (like the oss pledge does) |
|
We could still share the direct link even when it was a draft, but I do like the draft banner and the noindex, good additions. Fix up the bug and I'll look again :) |
# Conflicts: # lunaria/files/en-GB.json # lunaria/files/en-US.json
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
♻️ Duplicate comments (1)
modules/blog.ts (1)
95-103:⚠️ Potential issue | 🟠 MajorUse
post.pathand merge existing route rules instead of overwriting.Line 100 hardcodes
/blog/${post.slug}and replaces the whole rule object. This can miss draft posts using custom paths and can drop existing rule fields/headers for that route.💡 Proposed fix
- for (const post of posts) { - if (post.draft) { - nuxt.options.routeRules ||= {} - nuxt.options.routeRules[`/blog/${post.slug}`] = { - headers: { 'X-Robots-Tag': 'noindex, nofollow' }, - } - } - } + for (const post of posts) { + if (!post.draft) continue + + nuxt.options.routeRules ||= {} + const routePath = post.path || `/blog/${post.slug}` + const existingRule = nuxt.options.routeRules[routePath] ?? {} + const existingHeaders + = typeof existingRule === 'object' && existingRule && 'headers' in existingRule + ? (existingRule.headers as Record<string, string> | undefined) + : undefined + + nuxt.options.routeRules[routePath] = { + ...existingRule, + headers: { + ...existingHeaders, + 'X-Robots-Tag': 'noindex, nofollow', + }, + } + }#!/bin/bash set -euo pipefail echo "1) Draft posts with custom path frontmatter (these should map to routeRules via post.path):" fd -e md . app/pages/blog | while read -r f; do if rg -n '^draft:\s*true\b' "$f" >/dev/null && rg -n '^path:\s*' "$f" >/dev/null; then echo "--- $f" rg -n '^(draft|path|slug):' "$f" fi done echo echo "2) Current routeRules assignment pattern in modules/blog.ts:" rg -n -C4 'routeRules|X-Robots-Tag|/blog/\$\{post\.slug\}' modules/blog.ts
|
ah - before merging, I actually filtered them out so the drafts weren't even accessible by direct link (I didn't want it looking like a final article)... but as I reflected I realised it was a useful thing to be able to share. hopefully bug now fixed 🙏 |
danielroe
requested review from
whitep4nth3r
and removed request for
whitep4nth3r
| <span class="text-xs text-fg-muted font-mono">{{ published }}</span> | ||
| <div class="flex items-center gap-2"> | ||
| <span class="text-xs text-fg-muted font-mono">{{ published }}</span> | ||
| <span |
There was a problem hiding this comment.
I'm not seeing this badge on the preview
There was a problem hiding this comment.
oh it's the list card, if we're not showing drafts on the blog index we don't need this
There was a problem hiding this comment.
I think it would be useful when previewing on preview URLs and locally.
There was a problem hiding this comment.
But locally we don't show drafts on the index?
I'm confused, but you know more about this than I.
There was a problem hiding this comment.
it does now show drafts on the /blog index locally and on preview deploys (but with badge) and in production, only allows accessing them directly (and displays a banner at the top of the page).
likely you checked before I pushed (yet another) fix 🤦
There was a problem hiding this comment.
♻️ Duplicate comments (1)
modules/blog.ts (1)
96-103:⚠️ Potential issue | 🟠 MajorUse
post.pathand merge existing route rules instead of overwriting them.At Line 101, hardcoding
/blog/${post.slug}can miss draft posts with custompath, soX-Robots-Tagmay not be applied. Also, direct assignment replaces any existing route rule config for that route.Suggested fix
- for (const post of posts) { - if (post.draft) { - nuxt.options.routeRules ||= {} - nuxt.options.routeRules[`/blog/${post.slug}`] = { - headers: { 'X-Robots-Tag': 'noindex, nofollow' }, - } - } - } + for (const post of posts) { + if (!post.draft) continue + + nuxt.options.routeRules ||= {} + const routePath = post.path || `/blog/${post.slug}` + const existingRule = nuxt.options.routeRules[routePath] ?? {} + const existingHeaders + = typeof existingRule === 'object' && existingRule && 'headers' in existingRule + ? (existingRule.headers as Record<string, string> | undefined) + : undefined + + nuxt.options.routeRules[routePath] = { + ...existingRule, + headers: { + ...existingHeaders, + 'X-Robots-Tag': 'noindex, nofollow', + }, + } + }Run this to verify whether draft posts with explicit
pathexist and to inspect current route-rule handling:#!/bin/bash set -euo pipefail echo "Draft/frontmatter path usage in blog markdown:" rg -n --type=md -C2 '^\s*draft:\s*true\s*$|^\s*path:\s*' app/pages/blog echo echo "Route rule construction in modules/blog.ts:" rg -n -C3 'routeRules|X-Robots-Tag|post\.slug|post\.path' modules/blog.ts
🧹 Nitpick comments (1)
modules/blog.ts (1)
85-97: Consider loading posts once during setup.
loadBlogPosts(blogDir)is called at Line 85 and again at Line 97. Reusing a single in-memory result would avoid duplicate file reads and frontmatter parsing.
2 participants
🔗 Linked issue
🧭 Context
📚 Description
this allows us to preview in prod - whilst also preventing indexing from search engines (and adding a disclaimer)
inspired by https://opensourcepledge.com/blog/npmx-a-lesson-in-open-source-collaboration-feedback-loops/