hdoc-tools 0.26.3 → 0.27.0

package/README.md

@@ -47,6 +47,8 @@ If the -v switch is provided, then a more verbose output is provided, which incl
 
 Use the --set-version argument to set the version number of the built book.
 
+Use the --no-color argument to remove any color control characters from the output.
+
 ### validate
 
 Performs a minimum local build of the book, then validates the links and static content are present and correct.
@@ -55,6 +57,8 @@ If the -v switch is provided, then a more verbose output is provided, which incl
 
 Use the --set-version argument to set the version number of the built book.
 
+Use the --no-color argument to remove any color control characters from the output.
+
 ### serve
 
 Starts a local web server on port 3000, serving the book content.

package/hdoc-help.js

@@ -1,48 +1,48 @@
-(() => {
-	exports.run = () => {
-		// STEVE: The purpose of this function is to output information about hdoc arguments
-		const helpText = `
-Command Line Usage
-
-    hdoc <command> [switches]
-
-Commands
-
- - build
-    Performs a local build of the book, and outputs as a ZIP file. Use non-mandatory argument '--set-version 1.2.3' to set the version number of the built book
-
- - createDocs
-    Creates folder structure and markdown documents as defined in the HDocBook navigation item links 
-
- - help
-    Outputs available arguments and switches
-
- - init
-    Initializes a new HDocBook project from a template, using runtime input variables
-
- - serve
-    Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
-
- - stats
-    Returns statistics regarding the book you are working on. Supports a -v switch for verbose output.
-    The book statistics do not include counts for any externally hosted content injected into the book content using the [[INCLUDE]] tags.
-
- - validate
-    Validates the book content
-
- - bump
-    Updates the semantic version number of the current book. If no options are specified, then the default of patch is applied:
-    - major - updates the major version of the book. i.e. - 1.4.5 would become 2.0.0
-    - minor - updates the minor version of the book. i.e. - 1.4.5 would become 1.5.0
-    - patch (default) - updates the patch version of the book. i.e. - 1.4.5 would become 1.4.6
-
- - ver
-    Returns the version of the current book
-
-Example
-
-    hdoc stats -v
-`;
-		console.log(helpText);
-	};
-})();
+(() => {
+	exports.run = () => {
+		// STEVE: The purpose of this function is to output information about hdoc arguments
+		const helpText = `
+Command Line Usage
+
+    hdoc <command> [switches]
+
+Commands
+
+ - build
+    Performs a local build of the book, and outputs as a ZIP file. Use the '--set-version 1.2.3' argument to set the version number of the built book. Use the '--no-color' argument to remove any color control characters from the output.
+
+ - createDocs
+    Creates folder structure and markdown documents as defined in the HDocBook navigation item links 
+
+ - help
+    Outputs available arguments and switches
+
+ - init
+    Initializes a new HDocBook project from a template, using runtime input variables
+
+ - serve
+    Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
+
+ - stats
+    Returns statistics regarding the book you are working on. Supports a -v switch for verbose output.
+    The book statistics do not include counts for any externally hosted content injected into the book content using the [[INCLUDE]] tags.
+
+ - validate
+    Validates the book content. Use the '--set-version 1.2.3' argument to set the version number of the built book. Use the '--no-color' argument to remove any color control characters from the output.
+
+ - bump
+    Updates the semantic version number of the current book. If no options are specified, then the default of patch is applied:
+    - major - updates the major version of the book. i.e. - 1.4.5 would become 2.0.0
+    - minor - updates the minor version of the book. i.e. - 1.4.5 would become 1.5.0
+    - patch (default) - updates the patch version of the book. i.e. - 1.4.5 would become 1.4.6
+
+ - ver
+    Returns the version of the current book
+
+Example
+
+    hdoc stats -v
+`;
+		console.log(helpText);
+	};
+})();

package/hdoc-validate.js

@@ -415,6 +415,9 @@ const e = require("express");
 	};
 
 	const isHashAnchor = (html_file, hash_anchor, full_hash_anchor_link = "") => {
+		const markdown_paths = getMDPathFromHtmlPath(html_file);
+		const markdown_content = fs.readFileSync(markdown_paths.markdownPath, 'utf8');
+
 		try {
 			const file_content = fs.readFileSync(html_file.path, {
 				encoding: "utf-8",
@@ -425,9 +428,8 @@ const e = require("express");
 			if (
 				!file_content.includes(`<div id="hb-doc-anchor-${clean_hash_anchor}"`)
 			) {
-				errors[html_file.relativePath].push(
-					`Target hash anchor is not present in page content: ${full_hash_anchor_link !== "" ? full_hash_anchor_link : hash_anchor}`,
-				);
+				const error_message = processErrorMessage(`Target hash anchor is not present in page content: ${full_hash_anchor_link !== "" ? full_hash_anchor_link : hash_anchor}`, markdown_paths.relativePath, markdown_content, full_hash_anchor_link);
+				errors[html_file.relativePath].push( error_message );
 			}
 		} catch (e) {
 			errors[html_file.relativePath].push(e);
@@ -688,7 +690,7 @@ const e = require("express");
 					// Check for hash anchor
 					if (hash_anchor !== null) {
 						isHashAnchor(
-							{ path: html_file_path, relativePath: html_path.relativePath },
+							{ path: html_file_path, relativePath: html_path.relativePath, extension: html_path.extension },
 							hash_anchor,
 							relative_path,
 						);

package/hdoc.js

@@ -7,12 +7,18 @@
 
 	const packageFile = path.join(__dirname, "package.json");
 
+	let console_color = true;
+
 	const { info, error } = console;
 	console.info = (arg) => {
-		info.call(console, `\x1b[33m${arg}\x1b[0m`);
+		if (console_color)
+			info.call(console, `\x1b[33m${arg}\x1b[0m`);
+		else info.call(console, arg);
 	};
 	console.error = (arg) => {
-		error.call(console, `\x1b[31m${arg}\x1b[0m`);
+		if (console_color)
+			error.call(console, `\x1b[31m${arg}\x1b[0m`);
+		else error.call(console, arg);
 	};
 
 	const getHdocPackageVersion = (packagePath) => {
@@ -84,6 +90,8 @@
 			}
 		} else if (process.argv[x].toLowerCase() === "-e") {
 			gen_exclude = true;
+		} else if (process.argv[x].toLowerCase() === "--no-color") {
+			console_color = false;
 		}
 	}
 	source_path = trueCasePathSync(source_path);

package/package.json

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