refactor(build): extract buildSitemap()

mdn · Jun 3, 2024 · 978888a · 978888a
1 parent d556f8a
commit 978888a
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 22 deletions.
diff --git a/build/blog.ts b/build/blog.ts
@@ -38,7 +38,7 @@ import { extractSections } from "./extract-sections.js";
 import { HydrationData } from "../libs/types/hydration.js";
 import { DEFAULT_LOCALE } from "../libs/constants/index.js";
 import { memoize } from "../content/utils.js";
-import { makeSitemapXML, writeSitemap } from "./sitemaps.js";
+import { buildSitemap } from "./sitemaps.js";
 
 const READ_TIME_FILTER = /[\w<>.,!?]+/;
 const HIDDEN_CODE_BLOCK_MATCH = /```.*hidden[\s\S]*?```/g;
@@ -513,8 +513,10 @@ export async function buildBlogSitemap(options: { verbose?: boolean }) {
       .at(0),
   };
 
-  const xml = makeSitemapXML(`/${DEFAULT_LOCALE}/blog/`, [index, ...items]);
-  const sitemapFilePath = await writeSitemap(xml, DEFAULT_LOCALE, "blog");
+  const sitemapFilePath = await buildSitemap([index, ...items], {
+    slugPrefix: `/${DEFAULT_LOCALE}/blog/`,
+    pathSuffix: [DEFAULT_LOCALE, "blog"],
+  });
 
   if (options.verbose) {
     console.log("Wrote", sitemapFilePath);

diff --git a/build/cli.ts b/build/cli.ts
@@ -27,11 +27,7 @@ import {
 } from "./index.js";
 import { Doc, DocMetadata, Flaws } from "../libs/types/document.js";
 import SearchIndex from "./search-index.js";
-import {
-  makeSitemapXML,
-  makeSitemapIndexXML,
-  writeSitemap,
-} from "./sitemaps.js";
+import { makeSitemapIndexXML, buildSitemap } from "./sitemaps.js";
 import { humanFileSize } from "./utils.js";
 import { initSentry } from "./sentry.js";
 import { macroRenderTimes } from "../kumascript/src/render.js";
@@ -345,8 +341,10 @@ async function buildDocuments(
   }
 
   for (const [locale, docs] of Object.entries(docPerLocale)) {
-    const xml = makeSitemapXML(`/${locale}/docs/`, docs);
-    await writeSitemap(xml, locale);
+    await buildSitemap(docs, {
+      slugPrefix: `/${locale}/docs/`,
+      pathSuffix: [locale],
+    });
   }
 
   searchIndex.sort();

diff --git a/build/curriculum.ts b/build/curriculum.ts
@@ -39,7 +39,7 @@ import { memoize, slugToFolder } from "../content/utils.js";
 // @ts-ignore
 import { renderHTML } from "../ssr/dist/main.js";
 import { CheerioAPI } from "cheerio";
-import { makeSitemapXML, writeSitemap } from "./sitemaps.js";
+import { buildSitemap } from "./sitemaps.js";
 
 export const allFiles = memoize(async () => {
   const api = new fdir()
@@ -443,8 +443,9 @@ export async function buildCurriculumSitemap(options: { verbose?: boolean }) {
     }
   }
 
-  const xml = makeSitemapXML("", items);
-  const sitemapFilePath = await writeSitemap(xml, DEFAULT_LOCALE, "curriculum");
+  const sitemapFilePath = await buildSitemap(items, {
+    pathSuffix: [DEFAULT_LOCALE, "curriculum"],
+  });
 
   if (options.verbose) {
     console.log("Wrote", sitemapFilePath);

diff --git a/build/sitemaps.ts b/build/sitemaps.ts
@@ -4,10 +4,25 @@ import { gzipSync } from "node:zlib";
 
 import { BUILD_OUT_ROOT } from "../libs/env/index.js";
 
-export function makeSitemapXML(
-  prefix: string,
-  docs: { slug: string; modified?: string }[]
+interface SitemapEntry {
+  slug: string;
+  modified?: string;
+}
+
+export async function buildSitemap(
+  entries: SitemapEntry[],
+  {
+    slugPrefix = "",
+    pathSuffix = [],
+  }: { slugPrefix?: string; pathSuffix?: string[] }
 ) {
+  const xml = makeSitemapXML(slugPrefix, entries);
+  const path = writeSitemap(xml, ...pathSuffix);
+
+  return path;
+}
+
+function makeSitemapXML(prefix: string, docs: SitemapEntry[]) {
   const sortedDocs = docs.slice().sort((a, b) => a.slug.localeCompare(b.slug));
 
   // Based on https://support.google.com/webmasters/answer/183668?hl=en
@@ -45,7 +60,7 @@ export function makeSitemapIndexXML(paths: string[]) {
   ].join("\n");
 }
 
-export async function writeSitemap(xml: string, ...paths: string[]) {
+async function writeSitemap(xml: string, ...paths: string[]) {
   const dirPath = join(
     BUILD_OUT_ROOT,
     "sitemaps",

diff --git a/build/spas.ts b/build/spas.ts
@@ -30,7 +30,7 @@ import { getSlugByBlogPostUrl, splitSections } from "./utils.js";
 import { findByURL } from "../content/document.js";
 import { buildDocument } from "./index.js";
 import { findPostBySlug } from "./blog.js";
-import { makeSitemapXML, writeSitemap } from "./sitemaps.js";
+import { buildSitemap } from "./sitemaps.js";
 
 const FEATURED_ARTICLES = [
   "blog/learn-javascript-console-methods/",
@@ -384,14 +384,13 @@ export async function buildSPAs(options: {
   }
 
   // Sitemap.
-  const sitemapXml = makeSitemapXML(
-    "",
+  const sitemapFilePath = buildSitemap(
     sitemap.map(({ url }) => ({
       slug: url,
       modified: "",
-    }))
+    })),
+    { pathSuffix: ["misc"] }
   );
-  const sitemapFilePath = writeSitemap(sitemapXml, "misc");
 
   if (!options.quiet) {
     console.log("Wrote", sitemapFilePath);