Build spec files to the "web" folder

jdesrosiers · jdesrosiers · commit fc5295d63e43 · 2024-10-21T11:13:44.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,13 @@
-jsonschema-*.html
-jsonschema-*.pdf
-jsonschema-*.txt
+# Markdown builds
+web/
+
+# IETF builds
+json-schema-use-cases.html
+json-schema-use-cases.pdf
+json-schema-use-cases.txt
 relative-json-pointer.html
 relative-json-pointer.pdf
 relative-json-pointer.txt
-proposals/*.html
 
 # For the Python enviornment
 .venv
diff --git a/README.md b/README.md
@@ -29,7 +29,8 @@ To build the spec files to HTML from the Markdown sources, run `npm run
 build-all`.
 You can also build each individually with `npm run build -- filename.md`
 (Example: `npm run build -- jsonschema-core.md`). You can also use wildcards to
-build multiple specs at the same time: `npm run build -- jsonschema-*.md`.
+build multiple specs at the same time: `npm run build -- jsonschema-*.md`. The
+HTML files will be available in the `web` folder.
 
 The spec is built using [Remark](https://remark.js.org/), a markdown engine with
 good support for plugins and lots of existing plugins we can use.
diff --git a/build/build.js b/build/build.js
@@ -1,8 +1,8 @@
 /* eslint-disable no-console */
 import dotenv from "dotenv";
-import { readFileSync, writeFileSync } from "node:fs";
-import { dirname, basename } from "node:path";
-import { argv } from "node:process";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { dirname, resolve, relative } from "node:path";
+import { argv, cwd } from "node:process";
 import { reporter } from "vfile-reporter";
 import { remark } from "remark";
 import remarkCodeTitles from "./remark-code-titles.js";
@@ -22,8 +22,8 @@ import rehypeStringify from "rehype-stringify";
 
 dotenv.config();
 
-const build = async (filename) => {
-  const md = readFileSync(filename, "utf-8");
+const build = async (filePath) => {
+  const md = await readFile(filePath, "utf-8");
   const file = await remark()
     .use(remarkPresetLintMarkdownStyleGuide)
     .use(remarkLintMaximumHeadingLength, false)
@@ -62,8 +62,12 @@ const build = async (filename) => {
     .use(rehypeStringify)
     .process(md);
 
-  const outfile = `${dirname(filename)}/${basename(filename, ".md")}.html`;
-  writeFileSync(outfile, `<!DOCTYPE html>
+  const rootPath = resolve(import.meta.dirname, "..");
+  const outPath = resolve(rootPath, "web");
+  const sourceRelativePath = relative(rootPath, filePath);
+  const outfile = resolve(outPath, sourceRelativePath).replace(/\.md$/, ".html");
+  await mkdir(dirname(outfile), { recursive: true });
+  await writeFile(outfile, `<!DOCTYPE html>
 <html>
   <head>
     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/dark.css">
@@ -184,7 +188,8 @@ const build = async (filename) => {
   let messageCount = 0;
   for (const filename of files) {
     console.log(`Building: ${filename} ...`);
-    messageCount += await build(filename);
+    const filePath = resolve(cwd(), filename);
+    messageCount += await build(filePath);
     console.log("");
   }
 
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
   "main": "index.js",
   "scripts": {
     "lint": "eslint build/",
-    "build-all": "node build/build.js jsonschema-*.md proposals/*.md",
+    "build-all": "node build/build.js jsonschema-*.md proposals/*.md output/*.md",
     "build": "node build/build.js"
   },
   "license": "MIT",
