hdoc-tools 0.60.1 → 0.62.0

package/hdoc-serve.js

@@ -4,9 +4,8 @@
 	const fs = require("node:fs");
 	const path = require("node:path");
 	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
-	const { create_content_handler, build_nav_inline } = require(
-		path.join(__dirname, "hdoc-content-routes.js"),
-	);
+	const { create_content_handler, build_nav_inline, resolve_within_root } =
+		require(path.join(__dirname, "hdoc-content-routes.js"));
 
 	let port = 3000;
 	let docId;
@@ -47,9 +46,12 @@
 			"hdocbook-project.json",
 		);
 
-		// Load the hdocbook config  file
+		// Load the hdocbook config file (readFileSync, not require — no module
+		// cache, and the content routes re-read it per request anyway)
 		try {
-			hdocbook_project = require(hdocbook_project_config_path);
+			hdocbook_project = JSON.parse(
+				fs.readFileSync(hdocbook_project_config_path, "utf8"),
+			);
 		} catch (e) {
 			console.error(`\nFailed to load hdocbook-project.json:\n${e}\n`);
 			process.exit(1);
@@ -72,7 +74,7 @@
 
 		// Pull in the book config file
 		try {
-			hdocbook_config = require(hdocbook_path);
+			hdocbook_config = JSON.parse(fs.readFileSync(hdocbook_path, "utf8"));
 		} catch (e) {
 			console.error(`\nFailed to load hdocbook.json:${e}\n`);
 			process.exit(1);
@@ -93,7 +95,11 @@
 		// Catch all
 		app.get("/{*splat}", (req, res) => {
 
-			const ui_file_path = path.join(ui_path, req.url);
+			const ui_file_path = resolve_within_root(ui_path, req.url);
+			if (ui_file_path === null) {
+				content.send_content_resource_404(req, res);
+				return;
+			}
 
 			// To support the SPA application behavior, if there is no file extension present, then
 			// we simply return the /index.html file content to the client

package/hdoc-stats.js

@@ -5,9 +5,10 @@
 	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
 
 
-	// Regex to remove Hornbill-specific tags
+	// Regex to remove Hornbill admonition markers (::: note etc — see
+	// custom_modules/tips.js) so the marker keywords don't inflate word counts.
 	const hbMDTagRegex =
-		/(:{3}[ ]note)|(:{3}[ ]tip)|(:{3}[ ]important)|(:{3}[ ]caution)|(:{3}[ ]warning)|(:{3})/g;
+		/(:{3}[ ]note)|(:{3}[ ]tip)|(:{3}[ ]important)|(:{3}[ ]info)|(:{3}[ ]caution)|(:{3}[ ]warning)|(:{3})/g;
 
 	const stats = {
 		totalMDFiles: 0,
@@ -42,15 +43,12 @@
 		}
 	};
 
-	const dreeOptions = {
-		descendants: true,
+	// Options for hdoc.scan_dir (see hdoc-module.js for the supported keys)
+	const scanOptions = {
 		depth: 10,
 		extensions: ["md", "html", "htm"],
-		hash: false,
 		normalize: true,
-		size: true,
 		sizeInBytes: true,
-		stat: false,
 		symbolicLinks: false,
 	};
 
@@ -105,12 +103,14 @@
 		});
 
 		// Scan content path directory, send file info to callback for processing
-		hdoc.scan_dir(bookPath, dreeOptions, fileCallback);
+		hdoc.scan_dir(bookPath, scanOptions, fileCallback);
 		for (const element of markdownFiles) {
 			// Load markdown file
 			const md_txt = fs.readFileSync(element.path, "utf8");
 
-			const html_txt = md.render(md_txt.toString());
+			const html_txt = md.render(
+				md_txt.toString().replace(hbMDTagRegex, ""),
+			);
 			const text = hdoc.html_to_text(html_txt);
 
 			// Do the wordcount and add to status