hdoc-tools 0.7.12 → 0.7.13

package/hdoc-validate.js

@@ -0,0 +1,147 @@
+const parseLinkDestination = require('markdown-it/lib/helpers/parse_link_destination');
+
+(function () {
+    'use strict';
+
+    const cheerio = require('cheerio'),
+        dree = require('dree'),
+        fs = require('fs'),
+        path = require('path'),
+        URL = require("url").URL;
+
+    let errors = {},
+        messages = {},
+        errorcount = 0,
+        filecount = 0;
+
+    const stringIsAValidUrl = (s) => {
+        try {
+            new URL(s);
+            return true;
+        } catch (err) {
+            return false;
+        }
+    };
+
+    const checkLinks = function (source_path, htmlFile, links) {
+        for (let i = 0; i < links.length; i++) {
+
+            // Validate that link is a valid URL first
+            if (!stringIsAValidUrl(links[i])) {
+
+                // Could be a relative path, check
+                const fileExists = doesFileExist(source_path, htmlFile, links[i]);
+                if (!fileExists) {
+                    errorcount++;
+                }
+            } else {
+                messages[htmlFile.relativePath].push(`Link is valid External URL: ${links[i]}`);
+            }
+        }
+    };
+
+    const dreeOptions = {
+        descendants: true,
+        depth: 10,
+        extensions: ['htm', 'html'],
+        hash: false,
+        normalize: true,
+        size: false,
+        sizeInBytes: false,
+        stat: false,
+        symbolicLinks: false
+    };
+
+    let htmlFiles = [];
+
+    // File callbacks for html file scan
+    const fileCallback = function (element) {
+        filecount++;
+        htmlFiles.push(element);
+    };
+
+    const doesFileExist = function (source_path, html_path, relative_path) {
+        // Remove explicit anchor links
+        let file_path = path.join(source_path, relative_path.split('#')[0]);
+
+        if (!fs.existsSync(file_path) && !fs.existsSync(file_path + '.htm') && !fs.existsSync(file_path + '.html')) {
+            errors[html_path.relativePath].push(`Book resource does not exist: ${file_path}`);
+            return false;
+        } else {
+            messages[html_path.relativePath].push(`Book resource exists: ${file_path}`);
+        }
+        return true;
+    };
+
+    // Takes a dree element, returns an object with a pair of arrays
+    const getLinks = function (file) {
+        messages[file.relativePath].push('Parsing HTML file');
+        const htmlBody = fs.readFileSync(file.path, 'utf8');
+        let links = [];
+        const $ = cheerio.load(htmlBody);
+        const hrefs = $('a').map(function (i) {
+            return $(this).attr('href');
+        }).get();
+        const srcs = $('img').map(function (i) {
+            return $(this).attr('src');
+        }).get();
+        links.push(...hrefs);
+        links.push(...srcs);
+        return links;
+    };
+
+
+    exports.run = function (source_path, verbose) {
+        // Get a list of HTML files in source_path
+        dree.scan(source_path, dreeOptions, fileCallback);
+
+        for (let i = 0; i < htmlFiles.length; i++) {
+
+            // Initiate maps for errors and verbose messages for HTML file
+            errors[htmlFiles[i].relativePath] = [];
+            messages[htmlFiles[i].relativePath] = [];
+
+            const links = getLinks(htmlFiles[i]);
+            if (links.length === 0) {
+                messages[htmlFiles[i].relativePath].push('No links found in file');
+            } else {
+                checkLinks(source_path, htmlFiles[i], links);
+            }
+
+        }
+        if (errorcount === 0) {
+            console.log('\r\n---------------');
+            console.log('   No Errors   ');
+            console.log('---------------\r\n');
+        } else {
+            console.log('\r\n------------');
+            console.log('   Errors   ');
+            console.log('------------');
+
+            for (const key in errors) {
+                if (errors.hasOwnProperty(key) && errors[key].length > 0) {
+                    console.log(`\r\n${errors[key].length} error(s) in ${key}`);
+                    for (let i = 0; i < errors[key].length; i++) {
+                        console.log(` - ${errors[key][i]}`);
+                    }
+                }
+            }
+        }
+
+        if (verbose) {
+            console.log('\r\n-------------');
+            console.log('   Verbose   ');
+            console.log('-------------');
+            for (const key in messages) {
+                if (messages.hasOwnProperty(key) && messages[key].length > 0) {
+                    console.log(`\r\nMessage output for ${key}`);
+                    for (let i = 0; i < messages[key].length; i++) {
+                        console.log(` - ${messages[key][i]}`);
+                    }
+                }
+            }
+        }
+        console.log(`\r\nValidation Errors Found: ${errorcount}\r\n`);
+        return errorcount === 0 ? true : false;
+    };
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.7.12",
+  "version": "0.7.13",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -13,6 +13,7 @@
     "hdoc-init.js",
     "hdoc-serve.js",
     "hdoc-stats.js",
+    "hdoc-validate.js",
     "validateNodeVer.js",
     "ui",
     "custom_modules",