add base pages (guides) to sitemap and tests

Author: davemooreuws

package.json

@@ -5,10 +5,12 @@
   "scripts": {
     "postinstall": "husky && prisma generate && node scripts/collect-assets",
     "dev": "next dev",
+    "prebuild": "yarn generate-sitemap-pages",
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
     "test:spellcheck": "spellchecker",
+    "generate-sitemap-pages": "node scripts/build-sitemap",
     "format:check": "prettier --check src",
     "format:fix": "prettier --write src",
     "cypress": "cypress open",

scripts/build-pages-fixture.mjs

@@ -1,16 +1,19 @@
 import fs from 'fs/promises'
 
 import { allDocs } from '../.contentlayer/generated/index.mjs'
+import pages from '../src/assets/sitemap.json' with { type: 'json' }
 
 const FIXTURE_PATH = 'cypress/fixtures/pages.json'
 
 async function run() {
   try {
-    const paths = allDocs
-      .map((doc) => {
-        return doc.slug === '/' ? '/docs' : `/docs/${doc.slug}`
-      })
-      .sort((a, b) => a.localeCompare(b))
+    const basePages = pages.map((p) => p.replace('https://nitric.io', ''))
+
+    const docPages = allDocs.map((doc) => {
+      return doc.slug === '/' ? '/docs' : `/docs/${doc.slug}`
+    })
+
+    const paths = [...basePages, ...docPages].sort((a, b) => a.localeCompare(b))
 
     console.log(`${paths.length} paths found. Generating fixture`)
 

scripts/build-sitemap.js

@@ -0,0 +1,32 @@
+const fs = require('fs/promises')
+
+const excludedDirectories = ['[[...slug]]'] // ignore dynamic routes
+const pages = []
+
+const URL = 'https://nitric.io/docs'
+
+const readDirRecursive = async (dir) => {
+  const files = await fs.readdir(dir)
+
+  for (const file of files) {
+    const filePath = `${dir}/${file}`
+    const stats = await fs.stat(filePath)
+    if (stats.isDirectory() && !excludedDirectories.includes(file)) {
+      await readDirRecursive(filePath)
+    } else if (file.startsWith('page.')) {
+      const loc = `${URL}${filePath
+        .replace('src/app', '')
+        .replace('.tsx', '')
+        .replace('.mdx', '')
+        .replace('page', '')}`.replace(/\/$/, '')
+
+      pages.push(loc)
+    }
+  }
+}
+
+readDirRecursive('src/app').then(async () => {
+  console.log('static pages for sitemap: ', pages)
+
+  await fs.writeFile('./src/assets/sitemap.json', JSON.stringify(pages))
+})

src/app/(sitemaps)/sitemap-0.xml/route.ts

@@ -1,4 +1,5 @@
 import { allDocs } from '@/content'
+import staticPaths from '@/assets/sitemap.json'
 
 const URL = 'https://nitric.io/docs'
 
@@ -9,16 +10,27 @@ interface SitemapItem {
   priority: number
 }
 
+const lastmod = new Date().toISOString()
+
 // Function to construct the XML structure of the sitemap index.
 export async function GET() {
-  const pages: SitemapItem[] = allDocs.map((page) => ({
+  const pages = staticPaths.map((page) => ({
+    loc: page,
+    lastmod,
+    changefreq: 'daily',
+    priority: 0.7,
+  }))
+
+  const docPages: SitemapItem[] = allDocs.map((page) => ({
     loc: page.slug === '' ? URL : `${URL}/${page.slug}`,
     lastmod: new Date(page.lastModified).toISOString(),
     changefreq: 'daily',
     priority: 0.7,
   }))
 
-  const allPagesSorted = [...pages].sort((a, b) => (a.loc < b.loc ? -1 : 1))
+  const allPagesSorted = [...pages, ...docPages].sort((a, b) =>
+    a.loc < b.loc ? -1 : 1,
+  )
 
   const sitemapIndexXML = buildSitemap(allPagesSorted)