hdoc-tools 0.8.8 → 0.8.10

package/hdoc-build.js

@@ -1,11 +1,10 @@
-const {
-    stat
-} = require('fs');
-
 (function () {
     'use strict';
 
-    const dree = require('dree'),
+    const {
+        createHash
+    } = require('crypto'),
+        dree = require('dree'),
         fs = require('fs-extra'),
         mdfm = require('markdown-it-front-matter'),
         path = require('path'),
@@ -38,7 +37,10 @@ const {
         docId = '',
         md_files = [],
         static_html_files = [],
-        index_records = [];
+        index_records = [],
+        work_path_content = '',
+        built_relative_paths = [],
+        built_file_hashes = [];
 
     const transform_static_html = function (file_path) {
         if (fs.existsSync(file_path.path)) {
@@ -99,7 +101,10 @@ const {
                     console.log(`No frontmatter title property, or ${h_tags_to_search.join(', ')} tags detected in ${file_path.path}`);
                 }
             }
-            index_records.push({relative_path: file_path.relativePath, index_html: hdoc_index.transform_html_for_index(html_txt)});
+            index_records.push({
+                relative_path: file_path.relativePath,
+                index_html: hdoc_index.transform_html_for_index(html_txt)
+            });
             if (html_txt_updated) {
                 // Save HTML into HTML file
                 fs.writeFile(file_path.path, html_txt, function writeJSON(err) {
@@ -185,10 +190,13 @@ const {
             fs.writeFile(target_file, html_txt, function writeJSON(err) {
                 if (err) return console.log('Error writing:', target_file, '\r\n', err);
             });
-            
-            const index_details =  hdoc_index.transform_html_for_index(html_txt);
-            
-            index_records.push({relative_path: relative_path, index_html: index_details});
+
+            const index_details = hdoc_index.transform_html_for_index(html_txt);
+
+            index_records.push({
+                relative_path: relative_path,
+                index_html: index_details
+            });
 
             // Delete MD file from _work path
             try {
@@ -204,8 +212,8 @@ const {
         return false;
     };
 
-    // File callbacks for scans
-    const fileCallback = function (element) {
+    // File callback for build scan
+    const build_file_callback = function (element) {
         if (element.extension === 'md') {
             md_files.push(element);
         } else {
@@ -222,16 +230,28 @@ const {
         }
     };
 
+    // File & folder callback for MD5 hash of built content
+    const hash_callback = function (element) {
+        if (element.extension !== 'db') {
+            built_file_hashes.push({
+                path: element.relativePath,
+                hash: element.hash
+            });
+        }
+    };
+
     const dreeOptions = {
-        descendants: true,
-        depth: 10,
         extensions: ['md', 'html', 'htm'],
-        hash: false,
         normalize: true,
-        size: false,
-        sizeInBytes: false,
-        stat: false,
-        symbolicLinks: false
+    };
+
+    const md5DreeOptions = {
+        hash: true,
+        hashAlgorithm: 'md5',
+        hashEncoding: 'hex',
+        normalize: true,
+        size: true,
+        sorted: true
     };
 
     exports.run = function (source_path, verbose) {
@@ -262,7 +282,7 @@ const {
         console.log(`Building: ${docId} v${hdocbook_config.version}...\r\n`);
 
         const work_path = path.join(source_path, '_work');
-
+        work_path_content = path.join(work_path, docId);
         // Make _work folder to copy everything into
         if (fs.existsSync(work_path)) {
             fs.rmSync(work_path, {
@@ -274,14 +294,14 @@ const {
 
         // Copy files from book into _work-docId folder
         try {
-            fs.copySync(path.join(source_path, docId), path.join(work_path, docId));
+            fs.copySync(path.join(source_path, docId), work_path_content);
         } catch (e) {
             console.error('Error copying from source_path:\r\n', e);
             process.exit(1);
         }
 
         // Get a list of MD files in work_path
-        dree.scan(work_path, dreeOptions, fileCallback);
+        dree.scan(work_path, dreeOptions, build_file_callback);
 
         // Work through MD files and convert to HTML
         md_files.forEach(function (md_file) {
@@ -352,9 +372,31 @@ const {
             console.log(`\nIndex Build Complete: ${index_success_count} records created.`);
         }
 
+        // Now create MD5 hash of built content
+        dree.scan(work_path_content, md5DreeOptions, hash_callback);
+        let concat_hash = '|';
+        for (let i = 0; i < built_file_hashes.length; i++) {
+            concat_hash += built_file_hashes[i].path + ':' + built_file_hashes[i].hash + '|';
+        }
+        if (concat_hash === '|') {
+            console.log('No hash of content has been returned.');
+            process.exit(1);
+        }
+
+        const hash = createHash("md5").update(concat_hash).digest("hex");
+        const checksum_path = path.join(work_path_content, 'checksum.md5');
+        try {
+            fs.writeFileSync(checksum_path, hash);
+            console.log('\nHash file creation success:', checksum_path);
+        } catch (e) {
+            console.log('\nError creating', checksum_path, ':', e);
+            process.exit(1);
+        }
+
+
         try {
             const zip_path = path.join(work_path, docId + '.zip');
-            zipper.sync.zip(path.join(work_path, docId)).compress().save(zip_path);
+            zipper.sync.zip(work_path_content).compress().save(zip_path);
             console.log(`\nZIP Creation Success: ${zip_path}\n`);
             console.log('Build Complete\n');
         } catch (e) {

package/hdoc-stats.js

@@ -60,7 +60,7 @@
         symbolicLinks: false
     };
 
-    exports.run = function(ui_path, source_path, md, verbose = false) {
+    exports.run = function(ui_path, source_path, verbose = false) {
         
         // GERRY: The stats here are needed to support content development. The idea is to count all of the ]
         // words in a HDocBook so we know the size of the book, this helps with 3rd party involvement where
@@ -76,7 +76,7 @@
         // * MD files, and word count those
         
 
-        console.log('Hornbill HDocBook Stats', '\r\n');
+        console.log('Hornbill HDocBook Stats : verbose=' + verbose, '\r\n');
 
         const project_json_path = path.join(source_path, 'hdocbook-project.json');
 

package/hdoc.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 (function () {
    'use strict';
@@ -58,6 +58,8 @@
 
    }
 
+   console.log("VERBOSE: ", verbose);
+
    console.log('Hornbill HDocBook Tools v' + getHdocPackageVersion(packageFile), '\r\n');
    console.log('    Server Path:', __dirname);
    console.log('  Document Path:', source_path, '\r\n');

package/package.json

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

package/LICENSE

@@ -1,21 +0,0 @@
-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.