hdoc-tools 0.25.0 → 0.25.1

package/hdoc-validate.js

@@ -53,7 +53,8 @@ const e = require("express");
 			"",
 		);
 
-		const markdown_path = getMDPathFromHtmlPath(sourceFile);
+		const markdown_paths = getMDPathFromHtmlPath(sourceFile);
+
 		const translate_output = translator.translate(text, spellcheck_options);
 		if (Object.keys(translate_output).length) {
 			for (const key in translate_output) {
@@ -68,9 +69,9 @@ const e = require("express");
 							) {
 								const link_location = hdoc.find_string_in_string(text.split('\n')[key - 1], spelling);
 								if (link_location !== null)
-									error_message = `${markdown_path}:${key}:${link_location.column} - ${error_message}`;
+									error_message = `${markdown_paths.relativePath}:${key}:${link_location.column} - ${error_message}`;
 								else
-									error_message = `${markdown_path}:${key} - ${error_message}`;
+									error_message = `${markdown_paths.relativePath}:${key} - ${error_message}`;
 								if (!excludes[source_path]) {
 									errors[sourceFile.relativePath].push(
 										`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`,
@@ -433,17 +434,20 @@ const e = require("express");
 	};
 
 	const getMDPathFromHtmlPath = (htmlFile) => {
-		const markdownPath = htmlFile.relativePath.replace(`.${htmlFile.extension}`, '.md');
-		if (!fs.existsSync(markdownPath)) {
+		const returnPaths = {
+			markdownPath: htmlFile.path.replace(`.${htmlFile.extension}`, '.md'),
+			relativePath: htmlFile.relativePath.replace(`.${htmlFile.extension}`, '.md')
+		};
+		if (!fs.existsSync(returnPaths.markdownPath)) {
 			// No matching markdown
-			return htmlFile.relativePath;
+			returnPaths.markdownPath = htmlFile.path;
 		}
-		return markdownPath;
+		return returnPaths;
 	}
 
 	const checkLinks = async (source_path, htmlFile, links, hdocbook_config) => {
-		const markdown_path = getMDPathFromHtmlPath(htmlFile);
-		const markdown_content = fs.readFileSync(markdown_path, 'utf8');
+		const markdown_paths = getMDPathFromHtmlPath(htmlFile);
+		const markdown_content = fs.readFileSync(markdown_paths.markdownPath, 'utf8');
 
 		for (let i = 0; i < links.length; i++) {
 			// Validate that link is a valid URL first
@@ -465,7 +469,7 @@ const e = require("express");
 					//Flat Anchor - validate we have a same-file hit
 					isHashAnchor(htmlFile, links[i]);
 				} else {
-					const error_message = processErrorMessage(`Root relative links should start with a forward-slash: ${links[i]}`, markdown_path, markdown_content, links[i]);
+					const error_message = processErrorMessage(`Root relative links should start with a forward-slash: ${links[i]}`, markdown_paths.relativePath, markdown_content, links[i]);
 					errors[htmlFile.relativePath].push(error_message);
 				}
 			} else {
@@ -505,7 +509,7 @@ const e = require("express");
 					links[i].toLowerCase().includes("docs.hornbill.com") ||
 					links[i].toLowerCase().includes("docs-internal.hornbill.com")
 				) {
-					const error_message = processErrorMessage(`Hornbill Docs links should not be fully-qualified: ${links[i]}`, markdown_path, markdown_content, links[i]);
+					const error_message = processErrorMessage(`Hornbill Docs links should not be fully-qualified: ${links[i]}`, markdown_paths.relativePath, markdown_content, links[i]);
 					errors[htmlFile.relativePath].push( error_message );
 					continue;
 				}
@@ -524,7 +528,7 @@ const e = require("express");
 						`Link is a valid external URL: ${links[i]}`,
 					);
 				} catch (e) {
-					const error_message = processErrorMessage(`Issue with external link: ${e} - ${links[i]}`, markdown_path, markdown_content, links[i]);
+					const error_message = processErrorMessage(`Issue with external link: ${e} - ${links[i]}`, markdown_paths.relativePath, markdown_content, links[i]);
 					errors[htmlFile.relativePath].push(error_message);
 				}
 			}
@@ -532,13 +536,13 @@ const e = require("express");
 	};
 
 	const checkImages = async (source_path, htmlFile, links) => {
-		const markdown_path = getMDPathFromHtmlPath(htmlFile);
-		const markdown_content = fs.readFileSync(markdown_path, 'utf8');
+		const markdown_paths = getMDPathFromHtmlPath(htmlFile);
+		const markdown_content = fs.readFileSync(markdown_paths.markdownPath, 'utf8');
 		for (let i = 0; i < links.length; i++) {
 			// Validate that image is a valid URL first
 			if (!hdoc.valid_url(links[i])) {
 				// Could be a relative path, check image exists
-				doesFileExist(source_path, htmlFile, links[i], markdown_path, markdown_content);
+				doesFileExist(source_path, htmlFile, links[i], markdown_paths.relativePath, markdown_content);
 			} else {
 				messages[htmlFile.relativePath].push(
 					`Image link is a properly formatted external URL: ${links[i]}`,
@@ -551,7 +555,7 @@ const e = require("express");
 					);
 				} catch (e) {
 					// Handle errors
-					const error_message = processErrorMessage(`External image link error: ${links[i]} - ${e.message}`, markdown_path, markdown_content, links[i]);
+					const error_message = processErrorMessage(`External image link error: ${links[i]} - ${e.message}`, markdown_paths.relativePath, markdown_content, links[i]);
 					errors[htmlFile.relativePath].push(error_message);
 				}
 			}
@@ -559,7 +563,7 @@ const e = require("express");
 	};
 
 	const checkTags = async (htmlFile) => {
-		const markdown_path = getMDPathFromHtmlPath(htmlFile);
+		const markdown_paths = getMDPathFromHtmlPath(htmlFile);
 		// Check if file  is excluded from tag check
 		const file_no_ext = htmlFile.relativePath.replace(
 			path.extname(htmlFile.relativePath),
@@ -582,7 +586,7 @@ const e = require("express");
 				error_msg += h1_tags[i].text();
 				if (i < h1_tags.length - 1) error_msg += "; ";
 			}
-			errors[htmlFile.relativePath].push(`${markdown_path} - ${error_msg}`);
+			errors[htmlFile.relativePath].push(`${markdown_paths.relativePath} - ${error_msg}`);
 		}
 	};
 
@@ -608,8 +612,8 @@ const e = require("express");
 	};
 
 	const isRelativePath = (source_path, html_path, relative_path) => {
-		const markdown_path = getMDPathFromHtmlPath(html_path);
-		const markdown_content = fs.readFileSync(markdown_path, 'utf8');
+		const markdown_paths = getMDPathFromHtmlPath(html_path);
+		const markdown_content = fs.readFileSync(markdown_paths.markdownPath, 'utf8');
 
 		const rel_path_ext = path.extname(relative_path);
 		const response = {
@@ -660,7 +664,7 @@ const e = require("express");
 			}
 		}
 		if (response.has_md_extension || response.has_html_extension) {
-			const error_message = processErrorMessage(`Relative link has ${rel_path_ext} extension, but should not: ${relative_path}`, markdown_path, markdown_content, relative_path);
+			const error_message = processErrorMessage(`Relative link has ${rel_path_ext} extension, but should not: ${relative_path}`, markdown_paths.relativePath, markdown_content, relative_path);
 			errors[html_path.relativePath].push(error_message);
 			return;
 		}
@@ -679,11 +683,11 @@ const e = require("express");
 		const redir = checkRedirect(source_path, relpath);
 		if (redir.exists) {
 			if (redir.error !== null) {
-				const error_message = processErrorMessage(`${redir.error}: ${relative_path}`, markdown_path, markdown_content, clean_relative_path);
+				const error_message = processErrorMessage(`${redir.error}: ${relative_path}`, markdown_paths.relativePath, markdown_content, clean_relative_path);
 				errors[html_path.relativePath].push(error_message);
 			}
 		} else {
-			const error_message = processErrorMessage(`Link path does not exist: ${relative_path}`, markdown_path, markdown_content, clean_relative_path);
+			const error_message = processErrorMessage(`Link path does not exist: ${relative_path}`, markdown_paths.relativePath, markdown_content, clean_relative_path);
 			errors[html_path.relativePath].push(error_message);
 		}
 	};

package/package.json

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