hdoc-tools 0.39.0 → 0.40.0

package/hdoc-validate.js

@@ -10,6 +10,7 @@ const e = require("express");
 	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
 	const translator = require("american-british-english-translator");
 	const { trueCasePathSync } = require("true-case-path");
+	const puppeteer = require("puppeteer");
 
 	const spellcheck_options = {
 		british: true,
@@ -470,15 +471,14 @@ const e = require("express");
 		const markdown_paths = getMDPathFromHtmlPath(htmlFile);
 		const markdown_content = fs.readFileSync(markdown_paths.markdownPath, 'utf8');
 
-		// Use Puppeteer to validate link address works
-		const page = await browser.newPage();
-
+		
 		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]);
+			
 			const valid_url = hdoc.valid_url(links[i]);
 			if (!valid_url) {
 				// Could be a relative path, check
@@ -508,9 +508,6 @@ 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]}`,
 				);
@@ -588,6 +585,8 @@ const e = require("express");
 					continue;
 				}
 
+				// Use Puppeteer to validate link address works
+				const page = await browser.newPage();
 
 				try {
 					// Set a user-agent to mimic a real browser
@@ -613,12 +612,9 @@ const e = require("express");
 						});
 
 						// Try loading the URL
-						response = await page.goto(links[i], { waitUntil: 'networkidle2' }).catch(() => {
-							// Ignore rendering errors (likely binary files like PDFs)
-						});
+						response = await page.goto(links[i], { waitUntil: 'networkidle2', timeout: 10000 });
 
 						if (response) {
-							console.log(response);
 							let status = response.status();
 							const contentType = response.headers()['content-type'];
 
@@ -630,7 +626,7 @@ const e = require("express");
 								}, links[i]);
 							}
 							if ((status < 200 || status > 299) && status !== 304) {
-								if (status === 403 && links[i].includes(".hornbill.com")) {
+								if (process.env.GITHUB_ACTIONS === 'true' && status === 403 && links[i].includes(".hornbill.com")) {
 									// STEVEG - do nothing here, as it always returns a 403 for Hornbill sites when accessing through GitHub Actions
 									// Works totally fine locally or in hdocpub, still trying to work out what's causing this in GitHub
 								} else {
@@ -652,16 +648,16 @@ const e = require("express");
 					} else {
 						error_message = processErrorMessage(`Issue with external link [${links[i]}]: ${e}`, markdown_paths.relativePath, markdown_content, links[i]);
 					}
-					if (hdocbook_project.validation.external_link_warnings)
+					if (hdocbook_project.validation.external_link_warnings || process.env.GITHUB_ACTIONS === 'true')
 						warnings[htmlFile.relativePath].push(error_message);
 					else
 						errors[htmlFile.relativePath].push(error_message);
 					
 				}
+				// Close the headless browser tab
+				page.close();
 			}
 		}
-		// Close the headless browser tab
-		page.close();
 	};
 
 	const checkHostExistsInDNS = async (hostname) => {
@@ -1064,7 +1060,8 @@ const e = require("express");
 
 		
 		const global_links_checked = [];
-
+		const validateBrowser = await puppeteer.launch({ args: ['--no-sandbox'] });
+		
 		for (const key in html_to_validate) {
 			const file = html_to_validate[key];
 			// Check for British spellings in static HTML content
@@ -1089,7 +1086,7 @@ const e = require("express");
 				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, browser, global_links_checked);
+				await checkLinks(source_path, file, links.href, hdocbook_config, hdocbook_project, validateBrowser, global_links_checked);
 			}
 			if (links.img.length === 0) {
 				messages[file.relativePath].push("No images found in file");
@@ -1100,6 +1097,9 @@ const e = require("express");
 			// Check for multiple H1 tags
 			await checkTags(file);
 		}
+
+		// Close the Chromium browser instance
+		await validateBrowser.close();
 		
 		if (gen_exclude) console.log(JSON.stringify(excl_output, null, 2));
 

package/hdoc.js

@@ -8,6 +8,10 @@
 	const packageFile = path.join(__dirname, "package.json");
 
 	const originalConsoleLog = console.log;
+	const originalConsoleError = console.error;
+	const originalConsoleInfo = console.info;
+
+	let console_color = true;
 
 	console.log = (...args) => {
 		if (process.env.GITHUB_ACTIONS !== 'true') {
@@ -33,18 +37,44 @@
 		console.log("\nRunning in non-GitHub Actions environment\n");
 	}
 
-	let console_color = true;
+	console.info = (...args) => {
+
+		if (process.env.GITHUB_ACTIONS !== 'true') {
+			// If not running in GitHub Actions, send args to the original console.log
+			if (console_color) originalConsoleInfo(`\x1b[33m${args}\x1b[0m`);
+			else originalConsoleInfo(...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
+			originalConsoleInfo(...escapedArgs);
+		}
 
-	const { info, error } = console;
-	console.info = (arg) => {
-		if (console_color)
-			info.call(console, `\x1b[33m${arg}\x1b[0m`);
-		else info.call(console, arg);
 	};
-	console.error = (arg) => {
-		if (console_color)
-			error.call(console, `\x1b[31m${arg}\x1b[0m`);
-		else error.call(console, arg);
+
+	console.error = (...args) => {
+
+		if (process.env.GITHUB_ACTIONS !== 'true') {
+			// If not running in GitHub Actions, send args to the original console.log
+			if (console_color) originalConsoleError(`\x1b[33m${args}\x1b[0m`);
+			else originalConsoleError(...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
+			originalConsoleError(...escapedArgs);
+		}
 	};
 
 	const getHdocPackageVersion = (packagePath) => {

package/package.json

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