refactoring

Author: abrulic

app/utils/llms-utils.ts

@@ -1,6 +1,6 @@
 import { createDomain } from "~/utils/http"
 import { loadContentCollections } from "~/utils/load-content-collections"
-import type { PageRec, SectionRec } from "../../content-collections"
+import type { PageRecord, SectionRecord } from "../../content-collections"
 import { pageUrl } from "./version-links"
 import { versions } from "./versions"
 import type { Version } from "./versions-utils"
@@ -15,20 +15,20 @@ async function loadVersionData(version: Version) {
 }
 
 async function loadAllVersions() {
-	const acc: Record<string, { pages: PageRec[]; sections: SectionRec[] }> = {}
+	const acc: Record<string, { pages: PageRecord[]; sections: SectionRecord[] }> = {}
 	for (const v of versions) {
 		const loaded = await loadVersionData(v)
 		if (loaded) acc[v] = loaded
 	}
 	return acc
 }
 
-function buildSectionTitles(sections: SectionRec[]) {
+function buildSectionTitles(sections: SectionRecord[]) {
 	return new Map(sections.map((s) => [s.slug.split("/").pop() || "", s.title]))
 }
 
-function groupPagesByFolder(pages: PageRec[]) {
-	const groups = new Map<string, PageRec[]>()
+function groupPagesByFolder(pages: PageRecord[]) {
+	const groups = new Map<string, PageRecord[]>()
 
 	for (const p of pages) {
 		const id = p.section ?? p._meta?.path?.split("/")[0]
@@ -45,25 +45,25 @@ function groupPagesByFolder(pages: PageRec[]) {
 	return groups
 }
 
-function renderVersionBlock(domain: string, version: string, pages: PageRec[], sections: SectionRec[]) {
+function renderVersionBlock(domain: string, version: string, pages: PageRecord[], sections: SectionRecord[]) {
 	if (!pages.length) return `## ${version}\n\n_No pages found._`
 
 	const sectionTitles = buildSectionTitles(sections)
 	const groups = groupPagesByFolder(pages)
 
-	const blocks = Array.from(groups.entries())
-		.map(([id, list]) => {
-			const label = sectionTitles.get(id) ?? id
-			const lines = list
-				.map((p) => {
-					const url = pageUrl(domain, version, p.slug)
-					const note = p.summary || p.description || ""
-					return `- [${p.title}](${url})${note ? `: ${note}` : ""}`
-				})
-				.join("\n")
-			return `### ${label}\n\n${lines}`
-		})
-		.join("\n\n")
+	const renderPageLink = (p: PageRecord) => {
+		const url = pageUrl(domain, version, p.slug)
+		const note = p.summary || p.description || ""
+		return `- [${p.title}](${url})${note ? `: ${note}` : ""}`
+	}
+
+	const renderSection = ([id, list]: [string, PageRecord[]]) => {
+		const label = sectionTitles.get(id) ?? id
+		const lines = list.map(renderPageLink).join("\n")
+		return `### ${label}\n\n${lines}`
+	}
+
+	const blocks = Array.from(groups.entries()).map(renderSection).join("\n\n")
 
 	return `\n## ${version}\n\n${blocks}`
 }

app/utils/version-links.ts

@@ -30,7 +30,7 @@ export function resolveLayoutVersion(paramsVersion: string | undefined, request:
 	return ensureVersion(isKnownVersion(first) ? first : undefined)
 }
 
-export function homepageUrl(base: string, version: string) {
+function homepageUrl(base: string, version: string) {
 	return `${base}/${version}/home`
 }
 

content-collections.ts

@@ -7,6 +7,31 @@ const sectionSchema = z.object({
 	title: z.string(),
 })
 
+const pageSchema = z.object({
+	title: z.string(),
+	summary: z.string(),
+	description: z.string(),
+})
+
+const metaSchema = z.object({ path: z.string() }).partial().optional()
+const outputBaseSchema = z.object({
+	slug: z.string(),
+	_meta: metaSchema,
+})
+
+const sectionOutputSchema = sectionSchema.extend(outputBaseSchema.shape)
+const pageOutputSchema = pageSchema.extend({
+	...outputBaseSchema.shape,
+	section: z.string().optional(),
+	rawMdx: z.string(),
+	content: z.unknown(),
+})
+
+export type SectionRecord = z.infer<typeof sectionOutputSchema>
+export type PageRecord = z.infer<typeof pageOutputSchema>
+export const SectionsArray = z.array(sectionOutputSchema)
+export const PagesArray = z.array(pageOutputSchema)
+
 /**
  * Removes leading number prefixes like "01-", "02-" from each path segment.
  */
@@ -30,20 +55,10 @@ const section = defineCollection({
 	transform: (document) => {
 		const relativePath = document._meta.path.split("/").filter(Boolean).join("/")
 		const slug = cleanSlug(relativePath)
-
-		return {
-			...document,
-			slug,
-		}
+		return { ...document, slug }
 	},
 })
 
-const pageSchema = z.object({
-	title: z.string(),
-	summary: z.string(),
-	description: z.string(),
-})
-
 /*
  * This collection defines an individual documentation page within the package documentation.
  *
@@ -57,11 +72,9 @@ const page = defineCollection({
 	transform: async (document, context) => {
 		const relativePath = document._meta.path.split("/").filter(Boolean).join("/")
 		const slug = cleanSlug(relativePath)
-
 		const content = await compileMDX(context, document, {
 			rehypePlugins: [rehypeSlug],
 		})
-
 		// rawMdx is the content without the frontmatter, used to read headings from the mdx file and create a content tree for the table of content component
 		const rawMdx = document.content.replace(/^---\s*[\r\n](.*?|\r|\n)---/, "").trim()
 
@@ -78,24 +91,3 @@ const page = defineCollection({
 export default defineConfig({
 	collections: [section, page],
 })
-
-export const sectionOutputSchema = sectionSchema.extend({
-	slug: z.string(),
-	version: z.string(),
-	_meta: z.object({ path: z.string() }).partial().optional(),
-})
-
-export const pageOutputSchema = pageSchema.extend({
-	slug: z.string(),
-	section: z.string().optional(),
-	version: z.string(),
-	rawMdx: z.string(),
-	content: z.unknown(),
-	_meta: z.object({ path: z.string() }).partial().optional(),
-})
-
-export type SectionRec = z.infer<typeof sectionOutputSchema>
-export type PageRec = z.infer<typeof pageOutputSchema>
-
-export const SectionsArray = z.array(sectionOutputSchema)
-export const PagesArray = z.array(pageOutputSchema)