Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/openstatusHQ/openstatus. 🫖 Status page with uptime monitoring & API monitoring as code 🫖 openstatus.dev
bun drizzle-orm monitoring monitoring-as-code nextjs observability on-call open-source shadcn-ui status-page statuspage synthetic-monitoring tinybird turso uptime uptime-checker uptime-monitor
Something went wrong. Try again.
4.2 kB · 125 lines
TypeScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126import { execFileSync } from "node:child_process";import fs from "node:fs";import path from "node:path";
import { type DocsSection, flattenDocsNav, sectionForSlug,} from "./docs.config";import { type MDXData, parseFrontmatter } from "./utils/read";
const DOCS_DIR = path.join(process.cwd(), "src", "content", "pages", "docs");
function walkMDX(dir: string): string[] { if (!fs.existsSync(dir)) return []; return fs.readdirSync(dir, { withFileTypes: true }).flatMap((entry) => { const full = path.join(dir, entry.name); if (entry.isDirectory()) return walkMDX(full); return path.extname(entry.name) === ".mdx" ? [full] : []; });}
function readDocsFile(filePath: string): MDXData { // Docs frontmatter omits author/publishedAt — supply defaults so the shared // reader validates docs identically to other MDX content. const { metadata, content } = parseFrontmatter(filePath, { author: "openstatus", publishedAt: fs.statSync(filePath).mtime, }); const rel = path.relative(DOCS_DIR, filePath).replace(/\.mdx$/, ""); // One file ↔ one slug. Directory landings (e.g. /docs/sdk/nodejs) are synthetic // card grids with no backing file — `index.mdx` is forbidden (see validateDocsNav) // precisely so it can't shadow a landing; use `overview.mdx` for a landing page. const slug = rel.split(path.sep).join("/"); return { metadata, content, slug, href: `/docs/${slug}`, filePath, };}
export function getDocs(): MDXData[] { return walkMDX(DOCS_DIR).map(readDocsFile);}
export function getDocsPage(slug: string): MDXData | undefined { const direct = path.join(DOCS_DIR, `${slug}.mdx`); if (fs.existsSync(direct)) return readDocsFile(direct); return undefined;}
// Build-time consistency check. Split by severity so an incremental migration// can still ship: a nav slug without a file yet is an expected `warning` (not// ported), while a category mismatch or an orphan file (a doc that exists but// isn't in the config) is a hard `error` — a real bug on a page that IS ported.export function validateDocsNav(): { errors: string[]; warnings: string[] } { const errors: string[] = []; const warnings: string[] = []; const docs = getDocs(); const bySlug = new Map(docs.map((d) => [d.slug, d])); const navSlugs = new Set(flattenDocsNav().map((i) => i.slug));
for (const { slug } of flattenDocsNav()) { const doc = bySlug.get(slug); if (!doc) { warnings.push(`nav references not-yet-ported doc: ${slug}`); continue; } const expected = sectionForSlug(slug); if (doc.metadata.category !== expected) { errors.push( `category mismatch for ${slug}: frontmatter "${doc.metadata.category}" ≠ config "${expected}"`, ); } }
for (const doc of docs) { if (path.basename(doc.filePath) === "index.mdx") { errors.push( `index.mdx is not allowed (it would shadow a directory landing); rename to overview.mdx: ${doc.slug}`, ); } if (!navSlugs.has(doc.slug)) { errors.push(`doc not listed in docs.config.ts: ${doc.slug}`); } }
return { errors, warnings };}
// Prev/next from the flattened nav order (not date-sorted like blog).export function getDocsPagination(slug: string): { prev?: MDXData; next?: MDXData;} { const flat = flattenDocsNav(); const idx = flat.findIndex((i) => i.slug === slug); if (idx === -1) return {}; const toData = (item?: { slug: string }) => item ? getDocsPage(item.slug) : undefined; return { prev: toData(flat[idx - 1]), next: toData(flat[idx + 1]) };}
export function getDocsCategories(): DocsSection[] { return [ ...new Set(getDocs().map((d) => d.metadata.category)), ] as DocsSection[];}
// Last-updated from git history at build time. Returns undefined outside a git// checkout (e.g. some CI shallow clones) so callers can fall back gracefully.export function gitLastModified(filePath: string): Date | undefined { try { const iso = execFileSync( "git", ["log", "-1", "--format=%cI", "--", filePath], { encoding: "utf-8" }, ).trim(); return iso ? new Date(iso) : undefined; } catch { return undefined; }}