hdoc-tools 0.7.11 → 0.7.13

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Hornbill Docs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/hdoc-build.js

@@ -4,7 +4,8 @@
     const fs = require('fs-extra'),
         path = require('path'),
         dree = require('dree'),
-        zipper = require('zip-local');
+        zipper = require('zip-local'),
+        validate = require(path.join(__dirname, 'hdoc-validate.js'));
 
     let conversion_attempted = 0,
         conversion_success = 0,
@@ -47,7 +48,7 @@
         return false;
     }
 
-    // File callback for scan
+    // File callbacks for scans
     const fileCallback = function (element) {
         md_files.push(element.path);
     };
@@ -58,13 +59,13 @@
         extensions: ['md'],
         hash: false,
         normalize: true,
-        size: true,
-        sizeInBytes: true,
+        size: false,
+        sizeInBytes: false,
         stat: false,
         symbolicLinks: false
     };
 
-    exports.run = function (source_path, md) {
+    exports.run = function (source_path, md, verbose) {
         // GERRY: The purpose of this function is to create a zip file containing the hdocbook content, 
         // * Create a _work folder 
         // * copy the hdocbook content to the work folder
@@ -80,14 +81,14 @@
 
         // Load the hdocbook-project.json file to get the docId
         // use the docId to get the book config
-        const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json'),
-            hdocbook_project = require(hdocbook_project_config_path);
+        const   hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json'),
+                hdocbook_project = require(hdocbook_project_config_path);
 
         docId = hdocbook_project.docId;
 
-        const book_path = path.join(source_path, docId),
-            hdocbook_path = path.join(book_path, 'hdocbook.json'),
-            hdocbook_config = require(hdocbook_path);
+        const   book_path = path.join(source_path, docId),
+                hdocbook_path = path.join(book_path, 'hdocbook.json'),
+                hdocbook_config = require(hdocbook_path);
 
         console.log(`Building: ${docId} v${hdocbook_config.version}...\r\n`);
 
@@ -105,10 +106,6 @@
         // Copy files from book into _work-docId folder
         try {
             fs.copySync(path.join(source_path, docId), path.join(work_path, docId));
-            //fs.copyFileSync(path.join(source_path, 'hdocbook-project.json'), path.join(work_path, 'hdocbook-project.json'));
-            //fs.copyFileSync(path.join(source_path, 'LICENSE'), path.join(work_path, 'LICENSE'));
-            //fs.copyFileSync(path.join(source_path, 'README.md'), path.join(work_path, 'README.md'));
-            //fs.copyFileSync(path.join(source_path, 'package.json'), path.join(work_path, 'package.json'));
         } catch (e) {
             console.error('Error copying from source_path:\r\n', e);
             process.exit(1);
@@ -116,6 +113,7 @@
 
         // Get a list of MD files in work_path
         dree.scan(work_path, dreeOptions, fileCallback);
+
         // Work through MD files and convert to HTML
         md_files.forEach(function (md_file) {
             transform_markdown_and_save_html(md_file, md);
@@ -124,11 +122,16 @@
         console.log(`Successfully converted to HTML: ${conversion_success}`);
         console.log(`             Failed to convert: ${conversion_failed}`);
 
+        console.log(`\r\nValidating paths in generated HTML files`);
+        const validation_success = validate.run(work_path, verbose);
+        if (!validation_success) {
+            process.exit(1);
+        }
+
         const zip_path = path.join(work_path, docId + '.zip');
         zipper.sync.zip(path.join(work_path, docId)).compress().save(zip_path);
 
-        console.log(`          ZIP Creation Success: ${zip_path}\r\n`);
+        console.log(`ZIP Creation Success: ${zip_path}\r\n`);
         console.log('Build Complete\r\n');
-
     };
 })();

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/hdoc.js

@@ -94,7 +94,7 @@ const { createCipheriv } = require('crypto');
       server.run(ui_path, source_path, md);
    } else if (command == 'build') {
       const builder = require(path.join(__dirname, 'hdoc-build.js'));
-      builder.run(source_path, md);
+      builder.run(source_path, md, verbose);
    } else if (command == 'stats') {
       const stats = require(path.join(__dirname, 'hdoc-stats.js'));
       stats.run(ui_path, source_path, md, verbose);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.7.11",
+  "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",
@@ -26,6 +27,7 @@
   "license": "ISC",
   "dependencies": {
     "body-parser": "^1.20.1",
+    "cheerio": "^1.0.0-rc.12",
     "cookie-parser": "^1.4.6",
     "dree": "^3.4.2",
     "express": "^4.18.2",