hdoc-tools 0.37.0 → 0.39.0

package/hdoc-build.js

@@ -1410,7 +1410,8 @@
 			redirects,
 			draft_links,
 			github_repo_details && github_repo_details.data && github_repo_details.data.private ? github_repo_details.data.private : false,
-			browser
+			browser,
+			source_path
 		);
 
 		// Close the Chromium browser instance

package/hdoc-validate.js

@@ -26,6 +26,7 @@ const e = require("express");
 	const exclude_spellcheck = {};
 	let private_repo = false;
 	let redirects = {};
+	let skip_link_file = '';
 	const exclude_h1_count = {};
 	const exclude_spellcheck_output = [];
 
@@ -42,6 +43,23 @@ const e = require("express");
 		return false;
 	};
 
+	const loadSkipLinkValidation = (source_path) => {
+		skip_link_file = path.join(source_path, "validated-links.txt");
+		if (fs.existsSync(skip_link_file)) {
+			console.log(`Loading skip link validation file from: ${skip_link_file}`);
+			const skip_links = fs.readFileSync(skip_link_file, "utf8").split("\n");
+			for (let i = 0; i < skip_links.length; i++) {
+				if (skip_links[i].trim() !== "") {
+					exclude_links[skip_links[i].trim()] = true;
+				}
+			}
+		} else {
+			//Create the file if it doesn't exist
+			console.log(`Creating skip link validation file: ${skip_link_file}`);
+			fs.writeFileSync(skip_link_file, "", "utf8");
+		}
+	};
+
 	const spellcheckContent = async (sourceFile, excludes) => {
 		const spelling_errors = {};
 		const words = [];
@@ -457,6 +475,7 @@ const e = require("express");
 
 		for (let i = 0; i < links.length; i++) {
 			// Validate that link is a valid URL first
+			if (exclude_links[links[i]]) continue;
 			console.log(` - ${links[i]}`);
 			if (global_links_checked.includes(links[i])) continue;
 			global_links_checked.push(links[i]);
@@ -477,6 +496,7 @@ const e = require("express");
 
 					// Checking for internal links in other books - can't easily validate those here, returning
 					if (link_segments.length > 1 && link_root !== hdocbook_config.docId) {
+						fs.appendFileSync(skip_link_file, `${links[i]}\n`);
 						continue;
 					}
 					isRelativePath(source_path, htmlFile, links[i]);
@@ -488,6 +508,9 @@ const e = require("express");
 					errors[htmlFile.relativePath].push(error_message);
 				}
 			} else {
+				if (links[i] === 'http://www.idontexistasawebsite.co.uk') {
+					console.log(`Checking for a dummy link: ${links[i]}`);
+				}
 				messages[htmlFile.relativePath].push(
 					`Link is a properly formatted external URL: ${links[i]}`,
 				);
@@ -503,10 +526,12 @@ const e = require("express");
 					)
 					.edit_path.replace(path.extname(htmlFile.relativePath), ".md")
 				) {
+					fs.appendFileSync(skip_link_file, `${links[i]}\n`);
 					continue;
 				}
 				
 				if (valid_url.protocol === "mailto:") {
+					fs.appendFileSync(skip_link_file, `${links[i]}\n`);
 					continue;
 				}
 
@@ -525,6 +550,7 @@ const e = require("express");
 						messages[htmlFile.relativePath].push(
 							`Outside of Hornbill network - skipping internal link validation for: ${links[i]}`,
 						);
+						fs.appendFileSync(skip_link_file, `${links[i]}\n`);
 						continue;
 					}
 					messages[htmlFile.relativePath].push(
@@ -564,14 +590,11 @@ const e = require("express");
 
 
 				try {
-
 					// Set a user-agent to mimic a real browser
 					await page.setUserAgent('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36');
 
 					try {
 						let response = null;
-						let lastRedirectStatus = null;
-						let redirectChain = [];
 
 						// Capture redirects and final response
 						page.on('request', (request) => {
@@ -595,6 +618,7 @@ const e = require("express");
 						});
 
 						if (response) {
+							console.log(response);
 							let status = response.status();
 							const contentType = response.headers()['content-type'];
 
@@ -612,12 +636,15 @@ const e = require("express");
 								} else {
 									throw `Unexpected Status Returned: ${status}`;
 								}
+							} else {
+								fs.appendFileSync(skip_link_file, `${links[i]}\n`);
 							}
+						} else {
+							throw `No response from: ${links[i]}`;
 						}
 					} catch (error) {
 						throw error;
 					}
-
 				} catch (e) {
 					let error_message;
 					if (e instanceof AggregateError) {
@@ -883,11 +910,15 @@ const e = require("express");
 		draft_links,
 		is_private,
 		browser,
+		source_root_path,
 	) => {
 		console.log("Performing Validation and Building SEO Link List...");
 		redirects = gen_redirects;
 		private_repo = is_private;
 
+		// Load the skip link validation file if it exists
+		loadSkipLinkValidation(source_root_path);
+
 		// Get a list of HTML files in source_path
 		dree.scan(source_path, dreeOptions, fileContentCallback);
 

package/hdoc.js

@@ -7,6 +7,32 @@
 
 	const packageFile = path.join(__dirname, "package.json");
 
+	const originalConsoleLog = console.log;
+
+	console.log = (...args) => {
+		if (process.env.GITHUB_ACTIONS !== 'true') {
+			// If not running in GitHub Actions, send args to the original console.log
+			originalConsoleLog(...args);
+			
+		} else {
+			// If running in GitHub Actions, escape % and \ characters so printf doesn't throw an error
+			const escapedArgs = args.map(arg => {
+				if (typeof arg === 'string') {
+					return arg.replace(/%/g, '%%').replace(/\\/g, '\\\\');
+				}
+				return arg;
+			});
+			// Use the original console.log with escaped arguments
+			originalConsoleLog(...escapedArgs);
+		}
+	};
+
+	if (process.env.GITHUB_ACTIONS === 'true') {
+		console.log("\nRunning in GitHub Actions environment\n");
+	} else {
+		console.log("\nRunning in non-GitHub Actions environment\n");
+	}
+
 	let console_color = true;
 
 	const { info, error } = console;
@@ -103,6 +129,17 @@
 	console.log("    Server Path:", __dirname);
 	console.log("  Document Path:", source_path, "\r\n");
 
+
+	// Add validated-links.txt to .gitignore if it doesn't exist
+	const gitignorePath = path.join(source_path, ".gitignore");
+	if (fs.existsSync(gitignorePath)) {
+		const gitignoreContent = fs.readFileSync(gitignorePath, "utf8");
+		if (!gitignoreContent.includes("validated-links.txt")) {
+			fs.appendFileSync(gitignorePath, "\nvalidated-links.txt\n");
+			console.info("Added validated-links.txt to .gitignore");
+		}
+	} 
+	
 	if (command.toLowerCase() === "serve") {
 		const server = require(path.join(__dirname, "hdoc-serve.js"));
 		server.run(ui_path, source_path);

package/package.json

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

package/templates/init/gitignore

@@ -5,4 +5,5 @@ package-lock.json
 .DS_Store
 VSWorkspaceState.json
 slnx.state
-slnx.sqlite
+slnx.sqlite
+validated-links.txt