hdoc-tools 0.53.0 → 0.55.0

package/hdoc-build.js

@@ -97,8 +97,12 @@
 
 	// Mutable references updated immediately before each md.render() call so
 	// the highlight and frontmatter plugin callbacks can identify the current
-	// file. Safe because md.render() is synchronous — nothing can interleave
-	// between setting these and reading them back within a single render.
+	// file. md.render() is synchronous, so these are safe to READ from within
+	// the render itself (e.g. the highlight callback reading currentMdFilePath).
+	// They are NOT safe to read back AFTER an await: transform_file runs up to 8
+	// concurrently, so a concurrent render can clobber these while we're awaiting.
+	// Anything needed past the first await must be snapshotted into a local first
+	// (see file_frontmatter in transform_file).
 	let currentMdFilePath = "";
 	let currentFrontmatter = "";
 
@@ -303,6 +307,16 @@
 			// Render markdown into HTML
 			html_txt = md.render(md_txt);
 
+			// Capture this file's frontmatter into a local NOW, before any await.
+			// currentFrontmatter is shared module-level state populated by the mdfm
+			// callback during the (synchronous) md.render() above. transform_file runs
+			// up to 8-at-a-time (see the chunked Promise.all in run()), so the await
+			// below yields the event loop and lets a concurrent transform_file reset
+			// and overwrite currentFrontmatter — if we read it back after the await we
+			// would parse another file's frontmatter. Snapshot it while it is still
+			// guaranteed to be ours.
+			const file_frontmatter = currentFrontmatter;
+
 			// md.render() synchronously queued any Mermaid diagrams in this file.
 			// Render them to SVG now (memoized/deduped) so the files exist before
 			// PDF generation below reads them, and before validation/zipping.
@@ -318,7 +332,7 @@
 			let fm_contains_reading_time = false;
 			let fm_contains_description = false;
 
-			const fm_content = currentFrontmatter.split(/\r?\n/);
+			const fm_content = file_frontmatter.split(/\r?\n/);
 			if (fm_content.length >= 0) {
 				for (fm_prop of fm_content) {
 					const fm_id = fm_prop.slice(0, fm_prop.indexOf(":"));

package/hdoc-content-routes.js

@@ -33,6 +33,47 @@ function escape_html(str) {
 		.replace(/>/g, ">");
 }
 
+// Recursively walk <source_path>/<docId>/_inline building the nav fragment
+// consumed by the viewer's nav-section-component. Subfolders become
+// expandable container nodes (items, no link); files become leaf links.
+function build_inline_nav_items(dir, docId, rel_prefix) {
+	const items = [];
+	for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+		if (entry.isDirectory()) {
+			items.push({
+				text: entry.name,
+				expand: false,
+				items: build_inline_nav_items(
+					path.join(dir, entry.name),
+					docId,
+					`${rel_prefix}${entry.name}/`,
+				),
+			});
+		} else {
+			const name = entry.name.replace(path.extname(entry.name), "");
+			items.push({
+				text: name,
+				link: `${docId}/_inline/${rel_prefix}${name}`,
+			});
+		}
+	}
+	return items;
+}
+
+// Build the top-level "Inline Help Items" nav fragment for a book, or {}
+// if the book has no _inline folder.
+function build_nav_inline(source_path, docId) {
+	const inline_path = path.join(source_path, docId, "_inline");
+	if (!fs.existsSync(inline_path)) return {};
+	return {
+		text: "Inline Help Items",
+		expand: true,
+		inline: true,
+		items: build_inline_nav_items(inline_path, docId, ""),
+	};
+}
+exports.build_nav_inline = build_nav_inline;
+
 // Build a content handler bound to a single book's context.
 //
 // ctx:

package/hdoc-edit.js

@@ -25,7 +25,7 @@
 
 	const sha1 = (data) =>
 		crypto.createHash("sha1").update(Buffer.from(data)).digest("hex");
-	const { create_content_handler } = require(
+	const { create_content_handler, build_nav_inline } = require(
 		path.join(__dirname, "hdoc-content-routes.js"),
 	);
 	const { TocModel } = require(path.join(__dirname, "hdoc-toc.js"));
@@ -184,17 +184,7 @@
 			);
 
 			// Inline-help nav fragment, surfaced via /_books/library.json.
-			let inline = {};
-			const inline_path = path.join(sp, id, "_inline");
-			if (fs.existsSync(inline_path)) {
-				inline = { text: "Inline Help Items", expand: true, inline: true, items: [] };
-				for (const file of fs.readdirSync(inline_path)) {
-					inline.items.push({
-						text: file.replace(path.extname(file), ""),
-						link: `${id}/_inline/${file.replace(path.extname(file), "")}`,
-					});
-				}
-			}
+			const inline = build_nav_inline(sp, id);
 
 			source_path = sp;
 			hdocbook_project = proj;

package/hdoc-serve.js

@@ -4,7 +4,7 @@
 	const fs = require("node:fs");
 	const path = require("node:path");
 	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
-	const { create_content_handler } = require(
+	const { create_content_handler, build_nav_inline } = require(
 		path.join(__dirname, "hdoc-content-routes.js"),
 	);
 
@@ -59,23 +59,7 @@
 		docId = hdocbook_project.docId;
 
 		// Get inline content for nav
-		const inline_path = path.join(source_path, docId, "_inline");
-		let nav_inline = {};
-		if (fs.existsSync(inline_path)) {
-			const inline_files = fs.readdirSync(inline_path);
-			nav_inline = {
-				text: "Inline Help Items",
-				expand: true,
-				inline: true,
-				items: [],
-			};
-			for (const file of inline_files) {
-				nav_inline.items.push({
-					text: file.replace(path.extname(file), ""),
-					link: `${docId}/_inline/${file.replace(path.extname(file), "")}`,
-				});
-			}
-		}
+		const nav_inline = build_nav_inline(source_path, docId);
 		// Get an express server instance
 		const app = express();
 
@@ -135,10 +119,10 @@
 		});
 
 		const server = app.listen(port, "0.0.0.0", () => {
-			const host = server.address().address;
-			const port = server.address().port;
+			const addr = server.address();
+			if (!addr) return;
 
-			console.log("Server listening at http://127.0.0.1:%s", port);
+			console.log("Server listening at http://127.0.0.1:%s", addr.port);
 			console.log(`Document source path is: ${source_path}`);
 
 			const _vars = ["{{DOC_ID}}", "{{BUILD_NUMBER}}", "{{BUILD_DATE}}"];
@@ -148,6 +132,15 @@
 				console.log("   ", name, " = ", hdoc.expand_variables(name, docId));
 			}
 		});
+
+		server.on("error", (err) => {
+			if (err.code === "EADDRINUSE") {
+				console.error(`\nPort ${port} is already in use. Pick a different port with -port.\n`);
+			} else {
+				console.error(`\nServer error: ${err}\n`);
+			}
+			process.exit(1);
+		});
 	};
 
 })();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hdoc-tools",
-	"version": "0.53.0",
+	"version": "0.55.0",
 	"description": "Hornbill HDocBook Development Support Tool",
 	"main": "hdoc.js",
 	"bin": {