hdoc-tools 0.6.8 → 0.7.0

package/hdoc-build.js

@@ -1,8 +1,70 @@
 (function () {
     'use strict';
 
-    exports.run = function(ui_path, source_path, md) {
-        
+    const fs = require('fs-extra'),
+        path = require('path'),
+        dree = require('dree'),
+        AdmZip = require("adm-zip");
+
+    let conversion_attempted = 0,
+        conversion_success = 0,
+        conversion_failed = 0,
+        docId = '',
+        md_files = [];
+
+    function expand_variables(text) {
+        // For debug mode our base path is our root??
+        text = text.replaceAll('{{BASE_PATH}}', '/' + docId);
+        text = text.replaceAll('{{BUILD_NUMBER}}', '0');
+
+        let build_date = new Date().toISOString();
+        build_date = build_date.replace('T', ' ');
+        build_date = build_date.substring(0, 19);
+
+        text = text.replaceAll('{{BUILD_DATE}}', build_date);
+        return text;
+    }
+
+    function transform_markdown_and_save_html(file_path, md) {
+        conversion_attempted++;
+        if (fs.existsSync(file_path)) {
+            // Load markdown file
+            let md_txt = expand_variables(fs.readFileSync(file_path, 'utf8'));
+
+            // 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);
+            });
+            conversion_success++;
+            return true;
+        }
+        conversion_failed++;
+        console.error('MD file does not exist:', file_path);
+        return false;
+    }
+
+    // File callback for scan
+    const fileCallback = function (element) {
+        md_files.push(element.path);
+    };
+
+    const dreeOptions = {
+        descendants: true,
+        depth: 10,
+        extensions: ['md'],
+        hash: false,
+        normalize: true,
+        size: true,
+        sizeInBytes: true,
+        stat: false,
+        symbolicLinks: false
+    };
+
+    exports.run = function (source_path, md) {
         // 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
@@ -12,7 +74,73 @@
         //   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');
+
+        // 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);
+
+        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);
+
+        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);
+
+        // Make _work folder to copy everything into
+        if (fs.existsSync(work_path)) {
+            fs.rmSync(work_path, {
+                recursive: true,
+                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);
+        } 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){
+            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}`);
 
-        console.log("Build is not yet implemented");
+        // 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);
+        console.log(`          ZIP Creation Success: ${zip_path}\r\n`);
+        console.log('Build Complete\r\n');
     };
 })();

package/hdoc-help.js

@@ -7,20 +7,24 @@
         const helpText = `
 Command Line Usage
 
-    hdoc argument switches
+    hdoc <command> [switches]
 
-Arguments
+Commands
 
-- help
+ - help
     Outputs available arguments and switches
-- init
+
+ - init
     Initializes a new HDocBook project from a template, using runtime input variables
-- stats
+
+ - stats
     Returns statistics regarding the book you are working on. Supports a -v switch for verbose output
-- build
+
+ - build
     Performs a local build of the book, and outputs as a ZIP file.
-- serve
-    Starts a local web server on port 3000, serving the book content.
+
+ - serve
+    Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
 
 Example
 

package/hdoc-serve.js

@@ -5,13 +5,28 @@
    var path = require('path');
    const stream = require('stream');
    var express = require('express');
+   var port = 3000;
 
    exports.run = function (ui_path, source_path, md) {
 
+      for (let x = 0; x < process.argv.length; x++) {
+         // First two arguments are command, and script
+         if (x == 0 || x == 1)
+            continue;
+
+         if (process.argv[x] == '-port') {
+            x++;
+            if (x < process.argv.length) {
+               port = process.argv[x];
+            }
+         }
+      }   
+
       console.log('Hornbill HDocBook Preview/Dev Server', '\r\n');
-      console.log('    Server Path:', __dirname);
-      console.log('   UI Root Path:', ui_path);
+      //console.log('    Server Path:', __dirname);
+      //console.log('   UI Root Path:', ui_path);
       console.log('  Document Path:', source_path, '\r\n');
+      console.log('    Server Port:', port);
 
       // Get an express server instance
       var app = express();
@@ -44,7 +59,6 @@
          res.send(JSON.stringify(library, null, 3));
       });
 
-
       function content_type_for_ext(ext) {
          switch (ext) {
             case '.z':
@@ -351,11 +365,11 @@
          send_content_resource_404(req, res);
       });
 
-      var server = app.listen(3000, '0.0.0.0', function () {
+      var server = app.listen(port, '0.0.0.0', function () {
          var host = server.address().address;
          var port = server.address().port;
 
-         console.log('Server listening at http://%s:%s', host, port);
+         console.log('Server listening at http://127.0.0.1:%s', port);
          console.log('Document source path is: ' + source_path);
       });
 

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(ui_path, source_path, md);
+      builder.run(source_path, md);
    } 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.6.8",
+  "version": "0.7.0",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -25,6 +25,7 @@
   "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",