build: validate mdx and md (#6816)

Author: JustinBeckwith

.github/workflows/docs.yaml

@@ -1,6 +1,10 @@
 name: Verify Docs Formatting
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 permissions:
   contents: read

.github/workflows/test.yaml

@@ -1,48 +1,46 @@
-name: Verify Links
+name: ci
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 permissions:
   contents: read
 
 jobs:
   lint:
-    name: ESLint
+    name: Lint
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Install Node v18
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run ESLint
-        run: npm run lint
-
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run build
   links:
     name: Check Links
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Install Node v18
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: npm
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Build
-        run: npm run build
-
-      - name: Run Link Checks
-        run: npm run test:links
+      - run: npm ci
+      - run: npm run test:links
+  mdx:
+    name: Validate mdx
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+      - run: npm ci
+      - run: npm run test:build

ci/checkBuild.ts

@@ -0,0 +1,37 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+import { compile } from "@mdx-js/mdx";
+
+const args = process.argv.slice(2);
+const bail = args.includes("--bail");
+
+const ROOT_DIR = path.join(import.meta.dirname, "..");
+const DOCS_DIR = path.join(ROOT_DIR, "docs");
+
+const extensions = [".mdx", ".md"];
+let hasErrors = false;
+
+for (const docsRelativePath of await fs.readdir(DOCS_DIR, { recursive: true })) {
+  const filePath = path.join(DOCS_DIR, docsRelativePath);
+  const rootRelPath = path.relative(ROOT_DIR, filePath);
+
+  if (extensions.includes(path.extname(filePath))) {
+    try {
+      console.error(`Compiling ${rootRelPath}`);
+      await compile(await fs.readFile(filePath), {
+        format: path.extname(filePath) === ".mdx" ? "mdx" : "md",
+      });
+    } catch (error) {
+      console.error(`Error compiling ${rootRelPath}:`);
+      console.error(error);
+      hasErrors = true;
+      if (bail) {
+        process.exit(1);
+      }
+    }
+  }
+}
+
+if (hasErrors) {
+  process.exit(1);
+}