hdoc-tools 0.41.11 → 0.42.0

package/README.md

@@ -49,6 +49,8 @@ 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.
 
+Use the '--no-links' argument to skip link output to CLI during validation.
+
 ### validate
 
 Performs a minimum local build of the book, then validates the links and static content are present and correct.
@@ -59,6 +61,8 @@ 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.
 
+Use the '--no-links' argument to skip link output to CLI during validation.
+
 ### serve
 
 Starts a local web server on port 3000, serving the book content.

package/hdoc-build.js

@@ -1149,6 +1149,7 @@
 		validate,
 		gen_exclude,
 		build_version = "",
+		output_links = true,
 	) => {
 		if (github_api_token !== "") {
 			git_token = github_api_token;
@@ -1487,7 +1488,8 @@
 			draft_links,
 			github_repo_details && github_repo_details.data && github_repo_details.data.private ? github_repo_details.data.private : false,
 			browser,
-			source_path
+			source_path,
+			output_links,
 		);
 
 		// Close the Chromium browser instance

package/hdoc-help.js

@@ -12,6 +12,7 @@ Commands
     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.
+     - Use the '--no-links' argument to skip link output to CLI during validation.
 
  - createDocs
     Creates folder structure and markdown documents as defined in the HDocBook navigation item links 
@@ -33,6 +34,7 @@ Commands
     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.
+     - Use the '--no-links' argument to skip link output to CLI during validation.
 
  - bump
     Updates the semantic version number of the current book. If no options are specified, then the default of patch is applied:

package/hdoc-validate.js

@@ -467,14 +467,14 @@ const e = require("express");
 		return returnPaths;
 	}
 
-	const checkLinks = async (source_path, htmlFile, links, hdocbook_config, hdocbook_project, browser, global_links_checked) => {
+	const checkLinks = async (source_path, htmlFile, links, hdocbook_config, hdocbook_project, browser, global_links_checked, output_links) => {
 		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
-			console.log(` - ${links[i]}`);
+			if (output_links) console.log(` - ${links[i]}`);
 			if (exclude_links[links[i]]) continue;
 			if (global_links_checked.includes(links[i])) continue;
 			global_links_checked.push(links[i]);
@@ -907,6 +907,7 @@ const e = require("express");
 		is_private,
 		browser,
 		source_root_path,
+		output_links = true,
 	) => {
 		console.log("Performing Validation and Building SEO Link List...");
 		redirects = gen_redirects;
@@ -1085,8 +1086,8 @@ const e = require("express");
 			if (links.href.length === 0) {
 				messages[file.relativePath].push("No links found in file");
 			} else {
-				console.log(`\r\nChecking Links in ${file.relativePath}`);
-				await checkLinks(source_path, file, links.href, hdocbook_config, hdocbook_project, validateBrowser, global_links_checked);
+				console.log(`\r\nChecking ${links.href.length} Links in ${file.relativePath}`);
+				await checkLinks(source_path, file, links.href, hdocbook_config, hdocbook_project, validateBrowser, global_links_checked, output_links);
 			}
 			if (links.img.length === 0) {
 				messages[file.relativePath].push("No images found in file");

package/hdoc.js

@@ -104,6 +104,7 @@
 	let verbose = false;
 	let gen_exclude = false;
 	let bump_type = "patch"; // To generate spellcheck exclusions for all files
+	let output_links = true;
 
 	// Get options from command args
 	for (let x = 0; x < process.argv.length; x++) {
@@ -148,6 +149,8 @@
 			gen_exclude = true;
 		} else if (process.argv[x].toLowerCase() === "--no-color") {
 			console_color = false;
+		} else if (process.argv[x].toLowerCase() === "--no-links") {
+			output_links = false;
 		}
 	}
 	source_path = trueCasePathSync(source_path);
@@ -182,6 +185,7 @@
 			false,
 			gen_exclude,
 			build_version,
+			output_links,
 		);
 	} else if (command.toLowerCase() === "createdocs") {
 		const creator = require(path.join(__dirname, "hdoc-create.js"));
@@ -195,6 +199,7 @@
 			true,
 			gen_exclude,
 			build_version,
+			output_links,
 		);
 	} else if (command.toLowerCase() === "stats") {
 		const stats = require(path.join(__dirname, "hdoc-stats.js"));

package/package.json

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