hdoc-tools 0.7.0 → 0.7.2

package/hdoc-build.js

@@ -4,7 +4,7 @@
     const fs = require('fs-extra'),
         path = require('path'),
         dree = require('dree'),
-        AdmZip = require("adm-zip");
+        zipper = require('zip-local');
 
     let conversion_attempted = 0,
         conversion_success = 0,
@@ -33,11 +33,11 @@
 
             // Render markdown into HTML
             var html_txt = md.render(md_txt.toString());
-            
+
             // Save HTML into HTML file
             const target_file = file_path.replace(path.extname(file_path), '.html');
-            fs.writeFile(target_file, html_txt, function writeJSON(err) {
-                if (err) return console.log('Error writing:',target_file, '\r\n', err);
+            fs.writeFileSync(target_file, html_txt, function writeJSON(err) {
+                if (err) return console.log('Error writing:', target_file, '\r\n', err);
             });
             conversion_success++;
             return true;
@@ -74,29 +74,24 @@
         //   folder, conceptually we are making a little mini website crawler to index all of the content
         //   within the book. 
         // * Package everything up into a ZIP file, ready for the build controller to package and publish
-        
+
         console.log('Hornbill HDocBook Build', '\r\n');
+        console.log('  Document Path:', source_path, '\r\n');
 
         // 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`);
 
-        // Get source-path - 1 to work out where to store _work
-        const work_path_arr = source_path.split(path.sep);
-        let work_path = work_path_arr[0];
-        for (let i = 1; i < work_path_arr.length - 1; i++) {
-            work_path += path.sep + work_path_arr[i];
-        }
-        work_path = path.join(work_path, '_work_' + docId);
+        const work_path = path.join(source_path, '_work');
 
         // Make _work folder to copy everything into
         if (fs.existsSync(work_path)) {
@@ -105,42 +100,35 @@
                 force: true
             });
         }
-
-        // Create target book folder
         fs.mkdirSync(work_path);
 
         // Copy files from book into _work-docId folder
         try {
-            fs.copySync(source_path, work_path);
+            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);
         }
 
-        // Remove git stuff from work_path
-        fs.rmSync(path.join(work_path, '.git'), {
-            recursive: true,
-            force: true
-        });
-
         // 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){
+        md_files.forEach(function (md_file) {
             transform_markdown_and_save_html(md_file, md);
         });
-   
         console.log(`                MD files found: ${conversion_attempted}`);
         console.log(`Successfully converted to HTML: ${conversion_success}`);
         console.log(`             Failed to convert: ${conversion_failed}`);
 
-        // ZIP up content of _work-docId, save as docId_vx_y_z.zip where x/y/z is semantic version
-        const zip_path = path.join(work_path, docId + '_v' + hdocbook_config.version.replace('.', '_') + '.zip');
-        const zip = new AdmZip();
-        zip.addLocalFolder(work_path);
-        zip.writeZip(zip_path);
+        const zip_path = path.join(work_path, docId + '.zip');
+        zipper.sync.zip(work_path).compress().save(zip_path);
+
         console.log(`          ZIP Creation Success: ${zip_path}\r\n`);
         console.log('Build Complete\r\n');
+
     };
 })();

package/hdoc-serve.js

@@ -28,6 +28,11 @@
       console.log('  Document Path:', source_path, '\r\n');
       console.log('    Server Port:', port);
 
+      if(fs.existsSync(path.join(source_path, 'hdocbook-project.json')) == false) {
+         console.log("No hdocbook-project.js file found in working folder. Unable to continue.");
+         return -1;
+      }
+
       // Get an express server instance
       var app = express();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -25,7 +25,6 @@
   "author": "Hornbill Technologies Ltd",
   "license": "ISC",
   "dependencies": {
-    "adm-zip": "^0.5.9",
     "body-parser": "^1.20.1",
     "cookie-parser": "^1.4.6",
     "dree": "^3.4.2",
@@ -42,6 +41,7 @@
     "multer": "^1.4.5-lts.1",
     "prompt": "^1.3.0",
     "stream": "0.0.2",
-    "words-count": "^2.0.2"
+    "words-count": "^2.0.2",
+    "zip-local": "^0.3.5"
   }
 }