hdoc-tools 0.7.10 → 0.7.12

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`);
 
@@ -104,11 +105,7 @@
 
         // Copy files from book into _work-docId folder
         try {
-            fs.copySync(path.join(source_path, docId), path.join(work_path));
-            //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'));
+            fs.copySync(path.join(source_path, docId), path.join(work_path, docId));
         } 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(work_path).compress().save(zip_path);
+        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.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.10",
+  "version": "0.7.12",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -26,6 +26,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",