/ opencodehub / scripts / check-docs-parity.mjs
Swadhin Biswas chore(infra): harden deployment, backups, and production docs · 3/6/2026
16d8399
84 lines · 2.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
import { readdir } from "node:fs/promises";
import { readFile } from "node:fs/promises";
import path from "node:path";

const root = process.cwd();
const docsRoot = path.join(root, "docs");
const siteRoot = path.join(root, "docs-site", "src", "content", "docs");
const baselinePath = path.join(root, "doc", "docs-parity-baseline.json");

async function walk(dir) {
  const entries = await readdir(dir, { withFileTypes: true });
  const files = [];
  for (const entry of entries) {
    const full = path.join(dir, entry.name);
    if (entry.isDirectory()) {
      files.push(...(await walk(full)));
      continue;
    }
    files.push(full);
  }
  return files;
}

function toRel(base, file) {
  return path.relative(base, file).replaceAll("\\", "/");
}

function stripExt(rel) {
  return rel.replace(/\.(md|mdx)$/i, "");
}

async function main() {
  const docsFiles = (await walk(docsRoot)).filter((f) => f.endsWith(".md"));
  const siteFiles = (await walk(siteRoot)).filter((f) => f.endsWith(".md") || f.endsWith(".mdx"));

  const docsRel = docsFiles.map((f) => toRel(docsRoot, f));
  const siteRel = siteFiles.map((f) => toRel(siteRoot, f));

  const docsSet = new Set(docsRel.map(stripExt));
  const siteSet = new Set(siteRel.map(stripExt));

  const missingInSite = [...docsSet].filter((p) => !siteSet.has(p)).sort();
  const missingInDocs = [...siteSet].filter((p) => !docsSet.has(p)).sort();

  let baseline = { missingInSite: [], missingInDocs: [] };
  try {
    baseline = JSON.parse(await readFile(baselinePath, "utf-8"));
  } catch {
    // No baseline found; treat current state as strict parity requirement.
  }

  const baselineMissingInSite = new Set((baseline.missingInSite || []).map(String));
  const baselineMissingInDocs = new Set((baseline.missingInDocs || []).map(String));

  const newMissingInSite = missingInSite.filter((item) => !baselineMissingInSite.has(item));
  const newMissingInDocs = missingInDocs.filter((item) => !baselineMissingInDocs.has(item));

  if (newMissingInSite.length === 0 && newMissingInDocs.length === 0) {
    console.log("Docs parity check passed (no new parity drift beyond baseline).");
    return;
  }

  if (newMissingInSite.length > 0) {
    console.error("New files missing in docs-site/src/content/docs:");
    for (const file of newMissingInSite) {
      console.error(`  - ${file}`);
    }
  }

  if (newMissingInDocs.length > 0) {
    console.error("New files missing in docs/:");
    for (const file of newMissingInDocs) {
      console.error(`  - ${file}`);
    }
  }

  process.exit(1);
}

main().catch((error) => {
  console.error("Docs parity check failed:", error);
  process.exit(1);
});