Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion scripts/finalize-sitemap.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,17 @@ import { finalizeSitemap } from '../src/lib/sitemap.ts'
import { getBlogPostSlugs } from '../src/marketing/blogPlugin.ts'

const sitemapPath = path.resolve('dist/public/sitemap.xml')
const sitemap = await fs.readFile(sitemapPath, 'utf-8')
let sitemap: string | undefined

try {
sitemap = await fs.readFile(sitemapPath, 'utf-8')
} catch (error) {
const isMissingSitemap = error instanceof Error && 'code' in error && error.code === 'ENOENT'
if (!isMissingSitemap) throw error
}

if (sitemap === undefined) process.exit(0)

const finalized = finalizeSitemap(sitemap, getBlogPostSlugs())

if (finalized !== sitemap) {
Expand Down
11 changes: 10 additions & 1 deletion src/lib/sitemap.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { describe, expect, it } from 'vitest'
import { finalizeSitemap } from './sitemap'
import { finalizeSitemap, shouldIncludeInSitemap } from './sitemap'

const sitemap = `<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
Expand Down Expand Up @@ -46,3 +46,12 @@ describe('finalizeSitemap', () => {
expect(result).toContain('<loc>https://tempo.xyz/developers/blog/t6</loc>')
})
})

describe('shouldIncludeInSitemap', () => {
it('keeps concrete routes and excludes dynamic route templates', () => {
expect(shouldIncludeInSitemap('/blog/t7-network-upgrade')).toBe(true)
expect(shouldIncludeInSitemap('/docs/guide/payments')).toBe(true)
expect(shouldIncludeInSitemap('/blog/[slug]')).toBe(false)
expect(shouldIncludeInSitemap('/examples/[id]/details')).toBe(false)
})
})
4 changes: 4 additions & 0 deletions src/lib/sitemap.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
const TEMPLATE_URL_PATTERN = /<url>\s*<loc>([^<]*\/\[[^\]]+\][^<]*)<\/loc>[\s\S]*?<\/url>\s*/g
const LOCATION_PATTERN = /<loc>([^<]+)<\/loc>/g

export function shouldIncludeInSitemap(path: string): boolean {
return !/\/\[[^\]]+\](?:\/|$)/.test(path)
}

export function finalizeSitemap(sitemap: string, blogPostSlugs: readonly string[]): string {
let blogBaseUrl: string | undefined

Expand Down
2 changes: 2 additions & 0 deletions vocs.config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { Changelog, defineConfig, Embedding, McpSource, Reranker, Retriever } from 'vocs/config'
import { docsRouteDestination, proxiedLegacyDocsRoutes } from './src/lib/docs-routing'
import { createFeedbackAdapter } from './src/lib/feedback-adapter'
import { shouldIncludeInSitemap } from './src/lib/sitemap'

// Only set baseUrl in production — Vocs injects a <base> tag from this value,
// which causes all links to resolve to the absolute URL on preview deployments.
Expand Down Expand Up @@ -114,6 +115,7 @@ export default defineConfig({
},
},
sitemap: {
include: shouldIncludeInSitemap,
lastmod: (path, { lastmod }) => {
const pagePath = typeof path === 'string' ? path : '/'
if (pagePath === '/docs' || pagePath.startsWith('/docs/')) return false
Expand Down
Loading