hdoc-tools 0.50.1 → 0.52.0

package/hdoc-serve.js

@@ -3,16 +3,8 @@
 	const fs = require("node:fs");
 	const path = require("node:path");
 	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
-	const stream = require("node:stream");
-
-	const mdfm = require("markdown-it-front-matter");
-
-	const { execSync } = require("child_process");
-
-	const mermaid_theme_path = path.resolve(
-		__dirname,
-		"templates",
-		"mermaid-theme.yaml",
+	const { create_content_handler } = require(
+		path.join(__dirname, "hdoc-content-routes.js"),
 	);
 
 	let port = 3000;
@@ -97,310 +89,38 @@
 			process.exit(1);
 		}
 
-		app.get("/_books/library.json", (req, res) => {
-			const library = {
-				books: [
-					{
-						docId: hdocbook_config.docId,
-						title: hdocbook_config.title,
-						nav_inline: nav_inline,
-					},
-				],
-			};
-			res.setHeader("Content-Type", "application/json");
-			res.send(JSON.stringify(library, null, 3));
-		});
-
-		async function transform_markdown_and_send_html(req, res, file_path) {
-			if (!fs.existsSync(file_path)) return false;
-
-			let md_txt = hdoc.expand_variables(
-				fs.readFileSync(file_path).toString(),
-				docId,
-			);
-
-			const includes_processed = await hdoc.process_includes(
-				file_path,
-				md_txt,
-				global_source_path,
-			);
-			md_txt = includes_processed.body;
-			const md = require("markdown-it")({
-				html: true,
-				linkify: true,
-				typographer: true,
-				highlight: function (str, lang) {
-					if (lang === "mermaid") {
-						try {
-							const tmpInput = hdoc.tmp_file_sync({ postfix: ".mmd" });
-							const tmpOutput = hdoc.tmp_file_sync({ postfix: ".svg" });
-
-							if (!str.startsWith('---')) {
-								str = '---\n' + fs.readFileSync(mermaid_theme_path, {encoding: 'utf-8'}) + `\n---\n${str}`;
-							}
-
-							fs.writeFileSync(tmpInput.name, str);
-
-							let cmd = `${__dirname}/node_modules/.bin/mmdc`;
-							
-							if (process.platform === "win32") {
-								cmd = `"${cmd}"`;
-							} 
-							cmd = `${cmd} -i "${tmpInput.name}" -o "${tmpOutput.name}" --quiet --backgroundColor transparent`;
-							console.log(`Generating Inline Mermaid SVG found in: ${file_path}`);
-							execSync(cmd);
-
-							if (!fs.existsSync(tmpOutput.name)) {
-								throw new Error("mmdc did not generate output");
-							}
-
-							const svg = fs.readFileSync(tmpOutput.name, "utf8");
-
-							tmpInput.removeCallback();
-							tmpOutput.removeCallback();
-
-							return `<div class="text-body">${svg}</div>`;
-						} catch (err) {
-							return  `<div class="alert alert-danger mb-0 text-break" 
-role="alert"
-data-bs-toggle="collapse" 
-data-bs-target="#alertContent" 
-aria-expanded="false" 
-aria-controls="alertContent">
-<div>
-<strong>Error!</strong> Mermaid was unable to generate the SVG expected here. Click for more details
-</div>
-<div class="collapse mt-3" id="alertContent">
-<p class="mb-0 text-break">
-${err.message}
-</p>
-</div>
-</div>`;
-						}
-					}
-				}
-			});
-			md.linkify.set({
-				fuzzyEmail: false,
-				fuzzyLink: false,
-				fuzzyIP: false,
-			});
-
-			let frontmatter_content = "";
-			md.use(mdfm, (fm) => {
-				frontmatter_content = fm;
-			});
-
-			const tips = require(`${__dirname}/custom_modules/tips.js`);
-			md.use(tips, { links: true });
-
-			const html_txt = md.render(md_txt.toString());
-
-			if (frontmatter_content.length) {
-				const obj = hdoc.parse_yaml(frontmatter_content);
-				const buff = Buffer.from(JSON.stringify(obj), "utf-8");
-				const base64 = buff.toString("base64");
-				res.setHeader("X-frontmatter", base64);
-			}
-
-			res.setHeader("Content-Type", "text/html");
-			res.send(html_txt);
-			return true;
-		}
-
-
-		function send_content_file(req, res, file_path, redirected = false) {
-			let content_txt = hdoc.expand_variables(
-				fs.readFileSync(file_path).toString(),
-				docId,
-			);
-			if (redirected)
-				content_txt = `Redirected from ${redirected}\n\n${content_txt}`;
-
-			const contentType = hdoc.content_type_for_ext(path.extname(file_path));
-
-			if (path.extname(file_path) === ".md") {
-				res.setHeader("Content-Disposition", "inline");
-			}
-
-			res.setHeader("Content-Type", contentType);
-
-			res.send(content_txt);
-		}
-
-		function send_file(req, res, file_path) {
-			// Need to set the content type here??
-			const contentType = hdoc.content_type_for_ext(path.extname(file_path));
-			res.setHeader("Content-Type", contentType);
-
-			const r = fs.createReadStream(file_path);
-			const ps = new stream.PassThrough();
-			stream.pipeline(r, ps, (err) => {
-				if (err) {
-					console.error(err); // No such file or any other kind of error
-					return res.sendStatus(400).send("Unexpected error");
-				}
-			});
-			ps.pipe(res);
-		}
-
-		function send_content_resource_404(req, res) {
-			res.setHeader("Content-Type", "text/html");
-			res.status(404).send("Content resource not found");
-		}
-
-		// 1. If we request a file with a .html file extension, and that file DOES NOT exist,
-		// we will look for the same file but with a .md extension. If we find that
-		// corresponding markdown file, we will transform that markdown file to HTML and
-		// return the HTML content
-		//
-		// 2. If we request a file, without any file extension then we will look for that file
-		// with a .md extension, and if that file exists, we will transform that markdown
-		// file to HTML and return that file.
-		//
-		// For all other requests, we are going to look on the filesystem.  If we request
-		// a specific file with its extension (including .md files), then we will simply
-		// return the file verbatim as a static file.
-		//
-		// If we request a file without an extension and that file does not exist, we will
-		// assume that is a folder, will append index.html and look for that file, if present
-		// we will send it, if not present we will look for index.md, and if thats present
-		// we will transform to HTML and return that
-		//
-		// Anything else in this handler will return a 404 error
-
-		app.get("/_books/*", (req, res) => {
-			let url = req.url.replace("/_books/", "/");
-
-			console.log("URL Requested:", url);
-
-			// Process redirect
-			if (
-				hdocbook_project.redirects &&
-				Array.isArray(hdocbook_project.redirects) &&
-				hdocbook_project.redirects.length > 0
-			) {
-				const source_url = url.indexOf("/") === 0 ? url : `/${url}`;
-				for (const redir of hdocbook_project.redirects) {
-					redir.url =
-						redir.url.indexOf("/") === 0 ? redir.url : `/${redir.url}`;
-					if (
-						redir.url === source_url &&
-						redir.location &&
-						redir.location !== ""
-					) {
-						url = `${redir.location}`;
-						console.log(`Redirecting to ${url}`);
-					}
-				}
-			}
-
-			const file_path = path.join(source_path, url);
-
-			if (path.extname(file_path) === ".html") {
-				// 1a. check for html files, and send/transform as required
-				if (fs.existsSync(file_path)) {
-					// HTML file exists on disk, just return it verbatim
-					res.setHeader("Content-Type", "text/html");
-					send_file(req, res, file_path);
-					return true;
-				}
-				if (fs.existsSync(file_path.replace(".html", ".md"))) {
-					if (
-						transform_markdown_and_send_html(
-							req,
-							res,
-							file_path.replace(".html", ".md"),
-						)
-					) {
-						return;
-					}
-				}
-			} else if (path.extname(file_path) === ".md") {
-				// If the markdown file exists, just send to caller as is
-				if (fs.existsSync(file_path)) {
-					send_content_file(req, res, file_path);
-					return true;
-				}
-			} else if (path.extname(file_path).length === 0) {
-				// 2. If we request a file, without any file extension
-				if (fs.existsSync(`${file_path}.md`)) {
-					if (transform_markdown_and_send_html(req, res, `${file_path}.md`)) {
-						return;
-					}
-				} else if (fs.existsSync(path.join(`${file_path}index.md`))) {
-					if (
-						transform_markdown_and_send_html(
-							req,
-							res,
-							path.join(file_path, "index.md"),
-						)
-					) {
-						return;
-					}
-				} else if (fs.existsSync(path.join(`${file_path}index.html`))) {
-					res.setHeader("Content-Type", "text/html");
-					send_content_file(req, res, path.join(`${file_path}index.html`));
-					return;
-				} else if (fs.existsSync(`${file_path}/index.md`)) {
-					if (
-						transform_markdown_and_send_html(req, res, `${file_path}/index.md`)
-					) {
-						return;
-					}
-				} else if (fs.existsSync(path.join(`${file_path}/index.html`))) {
-					res.setHeader("Content-Type", "text/html");
-					send_content_file(req, res, path.join(`${file_path}/index.html`));
-					return;
-				} else if (fs.existsSync(path.join(`${file_path}.html`))) {
-					res.setHeader("Content-Type", "text/html");
-					send_content_file(req, res, path.join(`${file_path}.html`));
-					return;
-				} else if (fs.existsSync(path.join(`${file_path}.htm`))) {
-					res.setHeader("Content-Type", "text/html");
-					send_content_file(req, res, path.join(`${file_path}.htm`));
-					return;
-				}
-			} else if (fs.existsSync(file_path)) {
-				if (
-					file_path.endsWith("hdocbook.json") ||
-					file_path.endsWith("hdocbook_project.json")
-				) {
-					try {
-						// Read & parse file
-						JSON.parse(fs.readFileSync(file_path));
-					} catch (e) {
-						console.error(`Error parsing hdocbook.json: ${e}`);
-					}
-				}
-				send_file(req, res, file_path);
-				return;
-			}
-
-			// Return a 404 error here
-			send_content_resource_404(req, res);
+		// Mount the shared /_books/* content + render routes. The very same
+		// handler is reused by `hdoc edit`, so live preview matches published
+		// output. The returned helpers are reused by the SPA catch-all below.
+		const content = create_content_handler({
+			source_path,
+			docId,
+			hdocbook_config,
+			hdocbook_project,
+			nav_inline,
 		});
+		content.register(app);
 
 		// Catch all
-		app.get("/*", (req, res) => {
+		app.get("/{*splat}", (req, res) => {
 
 			const ui_file_path = path.join(ui_path, req.url);
 
 			// 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
 			if (path.extname(ui_file_path).length === 0) {
-				send_content_file(req, res, path.join(ui_path, "index.html"));
+				content.send_content_file(req, res, path.join(ui_path, "index.html"));
 				return;
 			}
 
 			// If the file exists, send it.
 			if (fs.existsSync(ui_file_path)) {
-				send_content_file(req, res, ui_file_path);
+				content.send_content_file(req, res, ui_file_path);
 				return;
 			}
 
 			// All else fails, we have not file to return, so return a 404 error here
-			send_content_resource_404(req, res);
+			content.send_content_resource_404(req, res);
 		});
 
 		const server = app.listen(port, "0.0.0.0", () => {

package/hdoc-validate.js

@@ -28,6 +28,7 @@ const { error } = require("node:console");
 	let _on_int_net_cached = null; // null = not yet checked; cached after first DNS lookup
 	const exclude_h1_count = {};
 	const exclude_spellcheck_output = [];
+	let global_spellcheck = [];
 
 	const excludeLink = (url) => {
 		if (exclude_links[url]) return true;
@@ -87,13 +88,13 @@ const { error } = require("node:console");
 									error_message = `${markdown_paths.relativePath}:${key}:${link_location.column} - ${error_message}`;
 								else
 									error_message = `${markdown_paths.relativePath}:${key} - ${error_message}`;
-								if (!excludes[source_path]) {
+								if (!excludes[source_path] && !global_spellcheck.includes(spelling.toLowerCase())) {
 									errors[sourceFile.relativePath].push(
 										`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`,
 									);
 									spelling_errors[spelling] = true;
 								} else if (
-									!excludes[source_path].includes(spelling.toLowerCase())
+									!excludes[source_path].includes(spelling.toLowerCase()) && !global_spellcheck.includes(spelling.toLowerCase())
 								) {
 									errors[sourceFile.relativePath].push(
 										`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`,
@@ -1000,6 +1001,8 @@ const { error } = require("node:console");
 			}
 		}
 
+		if (hdocbook_project.validation && Array.isArray(hdocbook_project.validation.spellcheckDictionary)) global_spellcheck = hdocbook_project.validation.spellcheckDictionary.map((w) => String(w).toLowerCase());
+
 		// Check navigation spellings & paths exist
 		const nav_errors = await checkNavigation(
 			source_path,

package/hdoc.js

@@ -127,6 +127,7 @@
 	// Default source path to working directory
 	let source_path = process.cwd();
 	let ui_path = path.join(__dirname, "ui");
+	let editor_path = path.join(__dirname, "editor", "dist");
 	let git_token = "";
 	let command = ""; // Our command to run
 	let build_version = "";
@@ -210,6 +211,9 @@
 	if (command.toLowerCase() === "serve") {
 		const server = require(path.join(__dirname, "hdoc-serve.js"));
 		server.run(ui_path, source_path);
+	} else if (command.toLowerCase() === "edit") {
+		const editor = require(path.join(__dirname, "hdoc-edit.js"));
+		editor.run(editor_path, source_path);
 	} else if (command.toLowerCase() === "build") {
 		const builder = require(path.join(__dirname, "hdoc-build.js"));
 		await builder.run(