hdoc-tools 0.25.1 → 0.26.0

package/hdoc-validate.js

@@ -4,6 +4,7 @@ const e = require("express");
 	const axios = require("axios");
 	const cheerio = require("cheerio");
 	const dree = require("dree");
+	const dns = require("node:dns");
 	const fs = require("node:fs");
 	const path = require("node:path");
 	const https = require("node:https");
@@ -494,7 +495,29 @@ const e = require("express");
 				if (valid_url.protocol === "mailto:") {
 					continue;
 				}
-				
+
+				// Skip internal.hornbill.com link validation if run outside of the Hornbill network
+				if (links[i].toLowerCase().includes(".internal.hornbill.com")) {
+					// DNS lookup internal docs endpoint
+					const hostname = 'docs-internal.hornbill.com';
+					let on_int_net = false;
+					try {
+						on_int_net = await checkHostExistsInDNS(hostname);
+					} catch (e) { 
+						// Don't need to do anything here
+					}
+					
+					if (!on_int_net) {
+						messages[htmlFile.relativePath].push(
+							`Outside of Hornbill network - skipping internal link validation for: ${links[i]}`,
+						);
+						continue;
+					}
+					messages[htmlFile.relativePath].push(
+						`Inside of Hornbill network - performing internal link validation for: ${links[i]}`,
+					);
+				}
+
 				// Skip if the link is excluded in the project config
 				const skip_link = await excludeLink(links[i]);
 				if (skip_link) {
@@ -504,10 +527,12 @@ const e = require("express");
 					continue;
 				}
 
-
-				if (
-					links[i].toLowerCase().includes("docs.hornbill.com") ||
-					links[i].toLowerCase().includes("docs-internal.hornbill.com")
+				if ( 
+					( 	links[i].toLowerCase().includes("docs.hornbill.com") || 
+						links[i].toLowerCase().includes("docs-internal.hornbill.com")
+					) && 
+					!links[i].toLowerCase().endsWith(".hornbill.com") && 
+					!links[i].toLowerCase().endsWith(".hornbill.com/")
 				) {
 					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 );
@@ -535,6 +560,18 @@ const e = require("express");
 		}
 	};
 
+	const checkHostExistsInDNS = async (hostname) => {
+		return new Promise((resolve, reject) => {
+			dns.lookup(hostname, { all:true }, (err, addresses) => {
+				if (err) {
+					reject(err);
+				} else {
+					resolve(addresses !== undefined);
+				}
+			});
+		});
+	}
+
 	const checkImages = async (source_path, htmlFile, links) => {
 		const markdown_paths = getMDPathFromHtmlPath(htmlFile);
 		const markdown_content = fs.readFileSync(markdown_paths.markdownPath, 'utf8');
@@ -900,7 +937,6 @@ const e = require("express");
 		);
 
 		// Perform rest of validation against HTML files
-		let listContent = "";
 		const htmlPromiseArray = [];
 		for (let i = 0; i < html_to_validate.length; i++) {
 			errors[html_to_validate[i].relativePath] = [];
@@ -941,24 +977,11 @@ const e = require("express");
 
 				// Check for multiple H1 tags
 				await checkTags(file);
-
-				// Build list content for Google
-				listContent += `/${file.relativePath.replace(path.extname(file.relativePath), "")}`;
-				listContent += "\r\n";
 			}),
 		);
 
 		if (gen_exclude) console.log(JSON.stringify(excl_output, null, 2));
 
-		try {
-			// Write list
-			const listFile = path.join(source_path, doc_id, "links.txt");
-			fs.writeFileSync(listFile, listContent);
-			console.log(`\r\nLink list text file created successfully: ${listFile}`);
-		} catch (err) {
-			console.error(err);
-		}
-
 		if (verbose) {
 			console.log("\r\n-------------");
 			console.log("   Verbose   ");

package/package.json

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