hdoc-tools 0.5.1 → 0.6.1

package/hdoc-build.js

@@ -1,15 +1,18 @@
+(function () {
+    'use strict';
 
-exports.run = function(ui_path, 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
-    // * Render all markdown into side-by-side HTML file
-    // * Replace SERVER_VARS embedded in documents with the right base path, version information etc.
-    // * Build an index (sqlite FTS5) by extracting text from all HTML content in  the work 
-    //   folder, conceptually we are making a little mini websirte 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
+    exports.run = function(ui_path, 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
+        // * Render all markdown into side-by-side HTML file
+        // * Replace SERVER_VARS embedded in documents with the right base path, version information etc.
+        // * Build an index (sqlite FTS5) by extracting text from all HTML content in  the work 
+        //   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("Build is not yet implemented")
-}
+        console.log("Build is not yet implemented");
+    };
+})();

package/hdoc-init.js

@@ -0,0 +1,36 @@
+(function () {
+    'use strict';
+
+    const prompt = require('prompt');
+
+    const properties = [{
+            name: 'documentId',
+            validator: /^[a-z-]+$/,
+            warning: 'Document ID must only contain lower case letters and dashes'
+        },
+        {
+            name: 'title'
+        },
+        {
+            name: 'initialVersion',
+            validator: /^[a-z-]+$/,
+            warning: 'Document ID must only contain lower case letters and dashes'
+        }
+    ];
+
+    exports.run = function (ui_path, source_path, md) {
+
+        // GERRY: The init function should create a new starting point HDocBook folder structure
+        // ready to run the preview server and start editing. 
+        //
+        // The init function should prompt for the ID of the doc book, title and initial version, then
+        // create the required files and folders.  Its possible to just create a template and copy
+        // those files into place, with a few variable replacements. 
+        // 
+        // 
+
+        console.log("Init is not yet implemented");
+
+
+    };
+})();

package/hdoc-serve.js

@@ -1,367 +1,363 @@
-const fs = require('fs');
-var path = require('path');
-const stream = require('stream');
-var express = require('express');
-
-exports.run = function(ui_path, source_path, md) {
-   
-    console.log("Hornbill HDocBook Preview/Dev Server", "\r\n");
-    console.log("    Server Path:", __dirname);
-    console.log("   UI Root Path:", ui_path);
-    console.log("  Document Path:", source_path, "\r\n");
-    
-    // Get an express server instance
-    var app = express();
-    
-    // In the root of the project there is a hdocbook.json file which includes
-    // the id of the hdocbook we are working with
-    const hdocbook_project_config_path = path.join(source_path, "hdocbook-project.json");
-    
-    // Load the hdocbook config  file
-    var hdocbook_project = require(hdocbook_project_config_path);
-    
-    // Get the ID of the hdocbook we are serving
-    var docId = hdocbook_project.docId;
-    
-    // Get the path of the book.json file
-    const hdocbook_path = path.join(source_path, docId, "hdocbook.json");
-    
-    // Pull in the book config file
-    var hdocbook_config = require(hdocbook_path);
-    var hdocbook_mtime = fs.statSync(hdocbook_path).mtime;
-    
-    app.get('/content/library.json', function (req, res) {
-       let library = {
-          books: [
-             {
-                docId: hdocbook_config.docId,
-                title: hdocbook_config.title
-             }
-          ]
-       }
-       res.setHeader("Content-Type", "application/json");
-       res.send(JSON.stringify(library, null, 3));
-    });
-    
-    
-    function content_type_for_ext(ext) {
-       switch (ext)
-       {
-          case ".z":
-             return "application/x-compress";
-          case ".tgz":
-             return "application/x-compressed";
-          case ".gz":
-             return "application/x-gzip";
-          case ".zip":
-             return "application/x-zip-compressed";
-          case ".xml":
-             return "application/xml";
-          case ".bmp":
-             return "image/bmp";
-          case ".gif":
-             return "image/gif";
-          case ".jpg":
-             return "image/jpeg";
-          case ".png":
-             return "image/png";
-          case ".tiff":
-             return "image/tiff";
-          case ".ico":
-             return "image/x-icon";
-          case ".png":
-             return "image/png";
-          case ".svg":
-             return "image/svg+xml";
-          case ".css":
-             return "text/css";
-          case ".htm":
-          case ".html":
-             return "text/html";
-          case ".txt":
-             return "text/plain";
-          case ".md":
-             return "text/plain";
-          case ".json":
-             return "application/json";
-          case ".js":
-             return "application/javascript";
-          default:
-             return "application/octet-stream";
-       }
-    }
-    
-    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_send_html(req, res, file_path) {
-    
-       if(fs.existsSync(file_path)) {
-          // we have a markdown representation of the requested HTML file, transform and return
-          // it to the caller
-    
-          // Load markdown file
-          let md_txt = expand_variables(fs.readFileSync(file_path).toString());
-    
-          // Render markdown into HTML
-          frontmatter_content = "";
-          var html_txt = md.render(md_txt.toString());
-    
-          if(frontmatter_content.length) {
-    
-             const obj = yaml.load(frontmatter_content);
-    
-             const buff = Buffer.from(JSON.stringify(obj), 'utf-8');
-    
-             const base64 = buff.toString('base64');
-    
-             res.setHeader("X-frontmatter", base64);
-          }
-    
-          res.setHeader("Content-Type", "text/html");
-          res.send(html_txt);
-          return true;
-       }
-       return false;
-    }
-    
-    function send_content_file(req, res, file_path) {
-       let content_txt = expand_variables(fs.readFileSync(file_path).toString());
-    
-       let contentType = content_type_for_ext(path.extname(file_path));
-    
-       if(path.extname(file_path) == ".md") {
-          res.setHeader("Content-Disposition", "inline");
-       }
-    
-       res.setHeader("Content-Type", contentType);
-    
-       res.send(content_txt);
-    }
-    
-    function send_file(req, res, file_path) {
-       // Need to set the content type here??
-       let contentType = content_type_for_ext(path.extname(file_path));
-       res.setHeader("Content-Type", contentType);
-       
-       const r = fs.createReadStream(file_path) 
-       const ps = new stream.PassThrough() 
-       stream.pipeline(
-          r,
-          ps, 
-          (err) => {
-          if (err) {
-             console.log(err) // No such file or any other kind of error
-             return res.sendStatus(400).send("Unexpected error"); 
-          }
-       })
-       ps.pipe(res) 
-    }
-    
-    function send_content_resource_404(req, res) {
-       res.setHeader("Content-Type", "text/html");
-       res.status(404).send("Content resource not found");
-    }
-    
-    // 1. If we request a file with a .html file extension, and that file DOES NOT exist,
-    // we will look for the same file but with a .md extension. If we find that 
-    // corresponding markdown file, we will transform that markdown file to HTML and 
-    // return the HTML content
-    //
-    // 2. If we request a file, without any file extension then we will look for that file
-    // with a .md extension, and if that file exists, we will transform that markdown 
-    // file to HTML and return that file. 
-    //
-    // For all other requests, we are going to look on the filesystem.  If we request 
-    // a specific file with its extension (including .md files), then we will simply 
-    // return the file verbatum as a static file.
-    //
-    // If we request a file without an extension and that file does not exist, we will
-    // assume that is a folder, will append index.html and look for that file, if present
-    // we will send it, if not present we will look for index.md, and if thats present 
-    // we will transform to HTML and return that
-    //
-    // Anything else in this handler will return a 404 error
-    
-    app.get('/content/*', function (req, res) {
-       
-       let url = req.url;
-    
-       let segs = url.split('/');
-    
-       if(segs.length == 4 && segs[1] == "content" && segs[3] == "book.json") {
-          // Special case of a virtual file here, we need to check  the book ID and
-          // if its our book, send the json
-          if(hdocbook_config.docId == segs[2]) {
-             res.setHeader("Content-Type", "application/json");
-             res.send(JSON.stringify(hdocbook_config, null, 3));
-          } else {
-             // Return a 404 error here
-             res.setHeader("Content-Type", "text/html");
-             res.status(404).send("Specified bookId " + segs[2] + " not found");
-          }  
-          return;
-       } else if (segs.length == 3 && segs[1] == "content" && segs[2] == "index.json") {
-          // For development mode, we always have an index with one book in it, the one being developed
-          if (hdocbook_config) { 
-             let index = {
-                   books: [
-                      {
-                         docId: hdocbook_config.docId,
-                         title: hdocbook_config.title,
-                         description: hdocbook_config.description, 
-                         version: hdocbook_config.version
-                      }
-                   ]
-             };
-             res.setHeader("Content-Type", "application/json");
-             res.send(JSON.stringify(index, null, 3));
-          } else {
-             // Return a 404 error here
-             res.setHeader("Content-Type", "text/html");
-             res.status(404).send("Specified bookId " + segs[2] + " not found");
-          }
-          return;
-       }
-    
-       url = url.replace("/content/", "/");
-    
-       console.log("URL Requested: ", url);
-    
-       let file_path = path.join(source_path, url);
-       let ui_file_path = path.join(ui_path, url);
-    
-       // If the requested file is found in the UI folder
-       if(url == "/") 
-       {
-          if(fs.existsSync(path.join(ui_file_path, "index.html"))) {
-             // We want the index.html, send it here
-             send_file(req, res, path.join(ui_file_path, "index.html"));
-             return;
-          }
-          // Return a 404 error here
-          send_content_resource_404(req, res);
-          return;
-       } else if(fs.existsSync(ui_file_path)) {
-          // File is found in  the UI folder, that takes priority, send the file
-          send_file(req, res, ui_file_path);
-          return;
-       }
-    
-       if(path.extname(file_path) == ".html") {
-          // 1a. check for html files, and send/transform as required
-          if(fs.existsSync(file_path)) {
-             // HTML file exists on disk, just return it verbatum
-             res.setHeader("Content-Type", "text/html");
-             send_file(req, res, file_path);
-             return true;
-          } 
-    
-          if(fs.existsSync(file_path.replace(".html", ".md"))){
-             if(transform_markdown_and_send_html(req, res, file_path.replace(".html", ".md"))) {
-                return;
-             }
-          }
-       } else if(path.extname(file_path) == ".md") {
-          // If the markdown file exists, just send to caller as is
-          if(fs.existsSync(file_path)) {
-             send_content_file(req, res, file_path);
-             return true;
-          } 
-       } else if(path.extname(file_path).length == 0) 
-       {
-          // 2. If we request a file, without any file extension
-          if(fs.existsSync(file_path + ".md")) {
-             if(transform_markdown_and_send_html(req, res, file_path + ".md")) {
-                return;
-             }
-          } else if(fs.existsSync(path.join(file_path + "index.md"))) {
-             if(transform_markdown_and_send_html(req, res, path.join(file_path, "index.md"))) {
-                return;
-             }
-          } else if(fs.existsSync(path.join(file_path + "index.html"))) {
-             console.log("jdhsfkjhdkjfhjkshdkfjhkjsdf", file_path);
-             res.setHeader("Content-Type", "text/html");
-             send_content_file(req, res, path.join(file_path + "index.html"));
-             return;
-          } else if(fs.existsSync(file_path + "/index.md")) {
-             if(transform_markdown_and_send_html(req, res, file_path + "/index.md")) {
-                return;
-             }
-          } else if(fs.existsSync(path.join(file_path + "/index.html"))) {
-             res.setHeader("Content-Type", "text/html");
-             send_content_file(req, res, path.join(file_path + "/index.html"));
-             return;
-          }
-       } else if(fs.existsSync(file_path)) {
-          send_file(req, res, file_path);
-          return;
-       }
-    
-       // Return a 404 error here
-       send_content_resource_404(req, res);
-    })
-    
-    // Cacth all
-    app.get('/*', function (req, res) {
-    
-       let segs = req.url.split('/');
-    
-       if(segs.length > 3 && segs[2] == "content") {
-          // In this case we are looking for static content within the book
-    
-          // Creat the file path
-          let url = req.url.replace("/content/", "/");
-          let file_path = path.join(source_path, url);
-    
-          // If the file exists, send it.
-          if(fs.existsSync(file_path) == true) {
-             send_file(req, res, file_path);
-             return;
-          }
-    
-          // All else fails, we have not file to return, so return a 404 error here
-          send_content_resource_404(req, res);
-          return;
-       }
-    
-       let ui_file_path = path.join(ui_path, req.url);
-    
-       console.log("URL Root: ", req.url);
-    
-       // To suport the SPA application behaviour, if there is no file extension present, then
-       // we simply return the /index.html file content to the client
-       if(path.extname(ui_file_path).length == 0) {
-          send_content_file(req, res, path.join(ui_path, "index.html"));
-          return;
-       } 
-    
-       // If the file exists, send it.
-       if(fs.existsSync(ui_file_path) == true) {
-          send_content_file(req, res, ui_file_path);
-          return;
-       }
-    
-       // All else fails, we have not file to return, so return a 404 error here
-       send_content_resource_404(req, res);
-    });
-    
-    var server = app.listen(3000, "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("Document source path is: " + source_path);
-    })
-    
-}
+(function () {
+   'use strict';
+
+   const fs = require('fs');
+   var path = require('path');
+   const stream = require('stream');
+   var express = require('express');
+
+   exports.run = function (ui_path, source_path, md) {
+
+      console.log("Hornbill HDocBook Preview/Dev Server", "\r\n");
+      console.log("    Server Path:", __dirname);
+      console.log("   UI Root Path:", ui_path);
+      console.log("  Document Path:", source_path, "\r\n");
+
+      // Get an express server instance
+      var app = express();
+
+      // In the root of the project there is a hdocbook.json file which includes
+      // the id of the hdocbook we are working with
+      const hdocbook_project_config_path = path.join(source_path, "hdocbook-project.json");
+
+      // Load the hdocbook config  file
+      var hdocbook_project = require(hdocbook_project_config_path);
+
+      // Get the ID of the hdocbook we are serving
+      var docId = hdocbook_project.docId;
+
+      // Get the path of the book.json file
+      const hdocbook_path = path.join(source_path, docId, "hdocbook.json");
+
+      // Pull in the book config file
+      var hdocbook_config = require(hdocbook_path);
+      var hdocbook_mtime = fs.statSync(hdocbook_path).mtime;
+
+      app.get('/content/library.json', function (req, res) {
+         let library = {
+            books: [{
+               docId: hdocbook_config.docId,
+               title: hdocbook_config.title
+            }]
+         };
+         res.setHeader("Content-Type", "application/json");
+         res.send(JSON.stringify(library, null, 3));
+      });
+
+
+      function content_type_for_ext(ext) {
+         switch (ext) {
+            case ".z":
+               return "application/x-compress";
+            case ".tgz":
+               return "application/x-compressed";
+            case ".gz":
+               return "application/x-gzip";
+            case ".zip":
+               return "application/x-zip-compressed";
+            case ".xml":
+               return "application/xml";
+            case ".bmp":
+               return "image/bmp";
+            case ".gif":
+               return "image/gif";
+            case ".jpg":
+               return "image/jpeg";
+            case ".png":
+               return "image/png";
+            case ".tiff":
+               return "image/tiff";
+            case ".ico":
+               return "image/x-icon";
+            case ".png":
+               return "image/png";
+            case ".svg":
+               return "image/svg+xml";
+            case ".css":
+               return "text/css";
+            case ".htm":
+            case ".html":
+               return "text/html";
+            case ".txt":
+               return "text/plain";
+            case ".md":
+               return "text/plain";
+            case ".json":
+               return "application/json";
+            case ".js":
+               return "application/javascript";
+            default:
+               return "application/octet-stream";
+         }
+      }
+
+      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_send_html(req, res, file_path) {
+
+         if (fs.existsSync(file_path)) {
+            // we have a markdown representation of the requested HTML file, transform and return
+            // it to the caller
+
+            // Load markdown file
+            let md_txt = expand_variables(fs.readFileSync(file_path).toString());
+
+            // Render markdown into HTML
+            let frontmatter_content = "";
+            var html_txt = md.render(md_txt.toString());
+
+            if (frontmatter_content.length) {
+
+               const obj = yaml.load(frontmatter_content);
+
+               const buff = Buffer.from(JSON.stringify(obj), 'utf-8');
+
+               const base64 = buff.toString('base64');
+
+               res.setHeader("X-frontmatter", base64);
+            }
+
+            res.setHeader("Content-Type", "text/html");
+            res.send(html_txt);
+            return true;
+         }
+         return false;
+      }
+
+      function send_content_file(req, res, file_path) {
+         let content_txt = expand_variables(fs.readFileSync(file_path).toString());
+
+         let contentType = content_type_for_ext(path.extname(file_path));
+
+         if (path.extname(file_path) == ".md") {
+            res.setHeader("Content-Disposition", "inline");
+         }
+
+         res.setHeader("Content-Type", contentType);
+
+         res.send(content_txt);
+      }
+
+      function send_file(req, res, file_path) {
+         // Need to set the content type here??
+         let contentType = content_type_for_ext(path.extname(file_path));
+         res.setHeader("Content-Type", contentType);
+
+         const r = fs.createReadStream(file_path);
+         const ps = new stream.PassThrough();
+         stream.pipeline(
+            r,
+            ps,
+            (err) => {
+               if (err) {
+                  console.log(err); // No such file or any other kind of error
+                  return res.sendStatus(400).send("Unexpected error");
+               }
+            });
+         ps.pipe(res);
+      }
+
+      function send_content_resource_404(req, res) {
+         res.setHeader("Content-Type", "text/html");
+         res.status(404).send("Content resource not found");
+      }
+
+      // 1. If we request a file with a .html file extension, and that file DOES NOT exist,
+      // we will look for the same file but with a .md extension. If we find that 
+      // corresponding markdown file, we will transform that markdown file to HTML and 
+      // return the HTML content
+      //
+      // 2. If we request a file, without any file extension then we will look for that file
+      // with a .md extension, and if that file exists, we will transform that markdown 
+      // file to HTML and return that file. 
+      //
+      // For all other requests, we are going to look on the filesystem.  If we request 
+      // a specific file with its extension (including .md files), then we will simply 
+      // return the file verbatim as a static file.
+      //
+      // If we request a file without an extension and that file does not exist, we will
+      // assume that is a folder, will append index.html and look for that file, if present
+      // we will send it, if not present we will look for index.md, and if thats present 
+      // we will transform to HTML and return that
+      //
+      // Anything else in this handler will return a 404 error
+
+      app.get('/content/*', function (req, res) {
+
+         let url = req.url;
+
+         let segs = url.split('/');
+
+         if (segs.length == 4 && segs[1] == "content" && segs[3] == "book.json") {
+            // Special case of a virtual file here, we need to check  the book ID and
+            // if its our book, send the json
+            if (hdocbook_config.docId == segs[2]) {
+               res.setHeader("Content-Type", "application/json");
+               res.send(JSON.stringify(hdocbook_config, null, 3));
+            } else {
+               // Return a 404 error here
+               res.setHeader("Content-Type", "text/html");
+               res.status(404).send("Specified bookId " + segs[2] + " not found");
+            }
+            return;
+         } else if (segs.length == 3 && segs[1] == "content" && segs[2] == "index.json") {
+            // For development mode, we always have an index with one book in it, the one being developed
+            if (hdocbook_config) {
+               let index = {
+                  books: [{
+                     docId: hdocbook_config.docId,
+                     title: hdocbook_config.title,
+                     description: hdocbook_config.description,
+                     version: hdocbook_config.version
+                  }]
+               };
+               res.setHeader("Content-Type", "application/json");
+               res.send(JSON.stringify(index, null, 3));
+            } else {
+               // Return a 404 error here
+               res.setHeader("Content-Type", "text/html");
+               res.status(404).send("Specified bookId " + segs[2] + " not found");
+            }
+            return;
+         }
+
+         url = url.replace("/content/", "/");
+
+         console.log("URL Requested: ", url);
+
+         let file_path = path.join(source_path, url);
+         let ui_file_path = path.join(ui_path, url);
+
+         // If the requested file is found in the UI folder
+         if (url == "/") {
+            if (fs.existsSync(path.join(ui_file_path, "index.html"))) {
+               // We want the index.html, send it here
+               send_file(req, res, path.join(ui_file_path, "index.html"));
+               return;
+            }
+            // Return a 404 error here
+            send_content_resource_404(req, res);
+            return;
+         } else if (fs.existsSync(ui_file_path)) {
+            // File is found in  the UI folder, that takes priority, send the file
+            send_file(req, res, ui_file_path);
+            return;
+         }
+
+         if (path.extname(file_path) == ".html") {
+            // 1a. check for html files, and send/transform as required
+            if (fs.existsSync(file_path)) {
+               // HTML file exists on disk, just return it verbatim
+               res.setHeader("Content-Type", "text/html");
+               send_file(req, res, file_path);
+               return true;
+            }
+
+            if (fs.existsSync(file_path.replace(".html", ".md"))) {
+               if (transform_markdown_and_send_html(req, res, file_path.replace(".html", ".md"))) {
+                  return;
+               }
+            }
+         } else if (path.extname(file_path) == ".md") {
+            // If the markdown file exists, just send to caller as is
+            if (fs.existsSync(file_path)) {
+               send_content_file(req, res, file_path);
+               return true;
+            }
+         } else if (path.extname(file_path).length == 0) {
+            // 2. If we request a file, without any file extension
+            if (fs.existsSync(file_path + ".md")) {
+               if (transform_markdown_and_send_html(req, res, file_path + ".md")) {
+                  return;
+               }
+            } else if (fs.existsSync(path.join(file_path + "index.md"))) {
+               if (transform_markdown_and_send_html(req, res, path.join(file_path, "index.md"))) {
+                  return;
+               }
+            } else if (fs.existsSync(path.join(file_path + "index.html"))) {
+               res.setHeader("Content-Type", "text/html");
+               send_content_file(req, res, path.join(file_path + "index.html"));
+               return;
+            } else if (fs.existsSync(file_path + "/index.md")) {
+               if (transform_markdown_and_send_html(req, res, file_path + "/index.md")) {
+                  return;
+               }
+            } else if (fs.existsSync(path.join(file_path + "/index.html"))) {
+               res.setHeader("Content-Type", "text/html");
+               send_content_file(req, res, path.join(file_path + "/index.html"));
+               return;
+            }
+         } else if (fs.existsSync(file_path)) {
+            send_file(req, res, file_path);
+            return;
+         }
+
+         // Return a 404 error here
+         send_content_resource_404(req, res);
+      });
+
+      // Catch all
+      app.get('/*', function (req, res) {
+
+         let segs = req.url.split('/');
+
+         if (segs.length > 3 && segs[2] == "content") {
+            // In this case we are looking for static content within the book
+
+            // Create the file path
+            let url = req.url.replace("/content/", "/");
+            let file_path = path.join(source_path, url);
+
+            // If the file exists, send it.
+            if (fs.existsSync(file_path) == true) {
+               send_file(req, res, file_path);
+               return;
+            }
+
+            // All else fails, we have not file to return, so return a 404 error here
+            send_content_resource_404(req, res);
+            return;
+         }
+
+         let ui_file_path = path.join(ui_path, req.url);
+
+         console.log("URL Root: ", req.url);
+
+         // To support the SPA application behavior, if there is no file extension present, then
+         // we simply return the /index.html file content to the client
+         if (path.extname(ui_file_path).length == 0) {
+            send_content_file(req, res, path.join(ui_path, "index.html"));
+            return;
+         }
+
+         // If the file exists, send it.
+         if (fs.existsSync(ui_file_path) == true) {
+            send_content_file(req, res, ui_file_path);
+            return;
+         }
+
+         // All else fails, we have not file to return, so return a 404 error here
+         send_content_resource_404(req, res);
+      });
+
+      var server = app.listen(3000, "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("Document source path is: " + source_path);
+      });
+
+   };
+})();

package/hdoc-stats.js

@@ -0,0 +1,146 @@
+
+(function () {
+    'use strict';
+    
+    // Required modules
+    const { STATUS_CODES } = require('http');
+    const fs = require('fs');
+    const dree = require('dree');
+    const html2text = require('html-to-text');
+    const { markdownToTxt } = require('markdown-to-txt');
+    const wordsCount = require('words-count').default;  
+    
+    // Regex to remove Hornbill-specific tags 
+    const hbMDTagRegex = /(:{3}[ ]note)|(:{3}[ ]tip)|(:{3}[ ]important)|(:{3}[ ]caution)|(:{3}[ ]warning)|(:{3})/g;
+    
+    let stats = {
+        totalMDFiles: 0,
+        totalStaticHTMLFiles: 0,
+        totalWordCount: 0,
+        mdFiles: {},
+        staticHTMLFiles: {} 
+    };
+    // File callback for scan
+    const fileCallback = function(element) {
+        if (element.extension === 'md' ) {
+            
+            // Read markdown file as string
+            const md = fs.readFileSync(element.path, 'utf8');
+            
+            // Strip out standard MD tags
+            let text = markdownToTxt(md);
+            
+            // Strip out any Hornbill Docs specific markdown tags 
+            text = text.replaceAll(hbMDTagRegex, '');
+            
+            // Do the wordcount and add to status
+            const wordCount = wordsCount(text);
+            stats.totalWordCount += wordCount;
+            stats.mdFiles[element.relativePath] = {
+                wordCount: wordCount,
+                sizeInBytes: element.sizeInBytes
+            };
+            stats.totalMDFiles++;
+        } else {
+            // file must be html
+            const mdFilePath = element.path.slice(0, element.path.lastIndexOf('.')) + '.md';
+            if (!fs.existsSync(mdFilePath)) {
+                //Do we have a matching MD file - if not, then word count the HTML
+                stats.totalStaticHTMLFiles++;
+                const html = fs.readFileSync(element.path, 'utf8');
+                const text = html2text.convert(html, {
+                    wordwrap: null
+                });
+                const wordCount = wordsCount(text);
+                stats.totalWordCount += wordCount;
+                stats.staticHTMLFiles[element.relativePath] = {
+                    wordCount: wordCount,
+                    sizeInBytes: element.sizeInBytes
+                };
+            }
+        }
+    };
+
+    const dreeOptions = {
+        descendants: true,
+        depth: 10,
+        extensions: ['md','html','htm'],
+        hash: false,
+        normalize: true,
+        size: true,
+        sizeInBytes: true,
+        stat: false,
+        symbolicLinks: false
+    };
+
+    exports.run = function(ui_path, source_path, md, 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
+        // we generally need to know the word count of the content in order to get a quote for things like
+        // copy editing. reviewing and translations. 
+        //
+        // For each .md file, and for each static .HTML file (that is html files that we have not generated) we
+        // should do a word count, excluding MD or HTML tags
+        console.log('Hornbill HDocBook Stats', '\r\n');
+
+        // STEVE: Get the docId (book root) from the hdocbook-project.json
+        // From there, loop through looking for:
+        // * HTML files without a matching MD, and word count those
+        // * MD files, and word count those
+        
+        const project_json_path = source_path + '/hdocbook-project.json';
+
+        if (!fs.existsSync(project_json_path)) {
+            // Book config does not exist
+            console.error('Required project file does not exist: ', project_json_path);
+            return;
+        } else {
+            // Book config exists - load book details 
+            let book_details;
+            try {
+                book_details = JSON.parse(fs.readFileSync(project_json_path, 'utf8'));
+            } catch (e) {
+                console.error('Error reading book configuration: ', e);
+                return;
+            }
+
+            // Scan content path directory, send file info to callback for processing
+            dree.scan(source_path + '/' + book_details.docId, dreeOptions, fileCallback);
+            
+            if (verbose) {
+                // Output verbose stats 
+
+                // Output information about all markdown files in the book
+                console.log('--------------');
+                console.log('   Markdown   ');
+                console.log('--------------');
+                for (const key in stats.mdFiles) {
+                    if (stats.mdFiles.hasOwnProperty(key)) {
+                        console.log('Relative Path: ', key);
+                        console.log('   Word Count: ', stats.mdFiles[key].wordCount);
+                        console.log('File Size (B): ', stats.mdFiles[key].sizeInBytes, '\r\n');
+                    }
+                }
+
+                // Output information about all static HTML in the book
+                console.log('---------------');
+                console.log('  Static HTML  ');
+                console.log('---------------');
+                for (const key in stats.staticHTMLFiles) {
+                    if (stats.staticHTMLFiles.hasOwnProperty(key)) {
+                        console.log('Relative Path: ', key);
+                        console.log('   Word Count: ', stats.staticHTMLFiles[key].wordCount);
+                        console.log('File Size (B): ', stats.staticHTMLFiles[key].sizeInBytes, '\r\n');
+                    }
+                }
+            }
+
+            // Output stats
+            console.log('  Total Book Word Count: ' + stats.totalWordCount);
+            console.log('         Markdown Files: ' + stats.totalMDFiles);
+            console.log('      Static HTML Files: ' + stats.totalStaticHTMLFiles + '\r\n');
+
+        }
+    };
+})();

package/hdoc.js

@@ -1,94 +1,89 @@
 #!/usr/bin/env node
 
-const fs = require('fs');
-var path = require('path');
-const stream = require('stream');
-const yaml = require('js-yaml');
-const mdfm = require('markdown-it-front-matter');
-var hljs = require('highlight.js') // https://highlightjs.org/
-const md = require('markdown-it') ({
-    // enable everything
-    html: true,
-    linkify: true,
-    typographer: true,
-   //  highlight: function (str, lang) {
-   //      if (lang && hljs.getLanguage(lang)) {
-   //        try {
-   //          return hljs.highlight(lang, str, true).value;
-   //        } catch (__) {}
-   //      }
-   //  }
-});
-const html2text = require('html-to-text');
-
-var frontmatter_content;
-md.use(mdfm, function(fm) {
-   frontmatter_content = fm;
-});
-
-const tips = require(__dirname + '/custom_modules/tips.js');
-
-md.use(tips, {links: true});
-
-// Default source path to working directory
-const source_path = process.cwd();
-const ui_path = path.join(__dirname, "ui");
-
-var command = ""; // Our command to run
-
-
-
-// Get options from command args
-for(x = 0; x < process.argv.length; x++)
-{
-   // First two arguments are command, and script
-   if(x == 0 || x == 1)
-      continue;
-   // Third argument is command
-   if(x == 2) {
-      command = process.argv[x];
-      continue;
+(function () {
+   'use strict';
+
+   const fs = require('fs');
+   var path = require('path');
+   const stream = require('stream');
+   const yaml = require('js-yaml');
+   const mdfm = require('markdown-it-front-matter');
+   var hljs = require('highlight.js'); // https://highlightjs.org/
+   const md = require('markdown-it')({
+      // enable everything
+      html: true,
+      linkify: true,
+      typographer: true,
+      //  highlight: function (str, lang) {
+      //      if (lang && hljs.getLanguage(lang)) {
+      //        try {
+      //          return hljs.highlight(lang, str, true).value;
+      //        } catch (__) {}
+      //      }
+      //  }
+   });
+
+   var frontmatter_content;
+   md.use(mdfm, function (fm) {
+      frontmatter_content = fm;
+   });
+
+   const tips = require(__dirname + '/custom_modules/tips.js');
+
+   md.use(tips, {
+      links: true
+   });
+
+   // Default source path to working directory
+   let source_path = process.cwd();
+   let ui_path = path.join(__dirname, "ui");
+
+   var command = ""; // Our command to run
+
+   // Get options from command args
+   for (let x = 0; x < process.argv.length; x++) {
+      // First two arguments are command, and script
+      if (x == 0 || x == 1)
+         continue;
+      // Third argument is command
+      if (x == 2) {
+         command = process.argv[x];
+         continue;
+      }
+
+      if (process.argv[x] == "-path") {
+         x++;
+         if (x < process.argv.length) {
+            source_path = process.argv[x];
+         }
+      } else if (process.argv[x] == "-ui-path") {
+         x++;
+         if (x < process.argv.length) {
+            ui_path = process.argv[x];
+         }
+      }
    }
 
-   if(process.argv[x] == "-path") {
-      x++;
-      if(x < process.argv.length)
-      {
-         source_path = process.argv[x];
-      }    
-   } else if(process.argv[x] == "-ui-path") {
-      x++;
-      if(x < process.argv.length)
-      {
-          ui_path = process.argv[x];
-      }    
+   console.log("Hornbill HDocBook Tools v0.1", "\r\n");
+   console.log("    Server Path:", __dirname);
+   console.log("  Document Path:", source_path, "\r\n");
+
+   if (command == "serve") {
+      const server = require(path.join(__dirname, "hdoc-serve.js"));
+      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);
+   } else if (command == "stats") {
+      const stats = require(path.join(__dirname, "hdoc-stats.js"));
+      stats.run(ui_path, source_path, md);
+   } else if (command == "statsv") {
+      const stats = require(path.join(__dirname, "hdoc-stats.js"));
+      stats.run(ui_path, source_path, md, true);
+   } else if (command == "init") {
+      const init = require(path.join(__dirname, "hdoc-init.js"));
+      init.run(ui_path, source_path, md);
+   } else {
+      console.log("Unknown command: " + command);
    }
-}
-
-console.log("Hornbill HDocBook Tools v0.1", "\r\n");
-console.log("    Server Path:", __dirname);
-console.log("  Document Path:", source_path, "\r\n");
-
-if(command == "serve") {
-   const server = require(path.join(__dirname, "hdoc-serve.js"));
-
-   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);
-} else if(command == "stats") {
-
-   const stats = require(path.join(__dirname, "hdoc-stats.js"));
-
-   stats.run(ui_path, source_path, md);
-} else if(command == "init") {
-
-   const init = require(path.join(__dirname, "hdoc-init.js"));
-
-   init.run(ui_path, source_path, md);
-} else {
-   console.log("Unknown command: " + command);
-}
-
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.5.1",
+  "version": "0.6.1",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -9,6 +9,8 @@
   "files": [
     "hdoc.js",
     "hdoc-serve.js",
+    "hdoc-stats.js",
+    "hdoc-init.js",
     "hdoc-build.js",
     "ui",
     "custom_modules"
@@ -21,15 +23,19 @@
   "dependencies": {
     "body-parser": "^1.20.1",
     "cookie-parser": "^1.4.6",
+    "dree": "^3.4.2",
     "express": "^4.18.2",
     "hdoc-tools": "^0.1.0",
     "highlight.js": "^11.6.0",
     "html-to-text": "^8.2.1",
     "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
     "markdown-it": "^13.0.1",
     "markdown-it-container": "^3.0.0",
     "markdown-it-front-matter": "^0.2.3",
+    "markdown-to-txt": "^2.0.1",
     "multer": "^1.4.5-lts.1",
-    "stream": "0.0.2"
+    "stream": "0.0.2",
+    "words-count": "^2.0.2"
   }
 }

package/ui/js/doc.hornbill.js

@@ -9,18 +9,18 @@ var global = {stateParams:{},lastLayoutClass:""};
 var docAppMethods = {
     switchViewTheme:function()
     {
-        if(ThemePreference)document.documentElement.classList.remove(ThemePreference)
+        if(ThemePreference)document.documentElement.classList.remove(ThemePreference);
 
         if(ThemePreference === 'dark')
         {
             ThemePreference = 'light';
         }
         else{
-            ThemePreference = 'dark'
+            ThemePreference = 'dark';
         }
 
-        localStorage.setItem('hdocbook-theme-appearance',ThemePreference)
-        document.documentElement.classList.add(ThemePreference)
+        localStorage.setItem('hdocbook-theme-appearance',ThemePreference);
+        document.documentElement.classList.add(ThemePreference);
     },
     renderNavigation:function()
     {
@@ -146,7 +146,7 @@ function highlightNavigationLinkFromUrl(matchLinkHref)
         }
         catch(e)
         {
-            console.log("BAD navigation menu item found",el.href)
+            console.log("BAD navigation menu item found",el.href);
         }
 
         if(checkUrl)
@@ -371,7 +371,7 @@ function setBrowserViewUrl(strHrefToLoad,viewData,fromPageRefresh,fromPopState)
    }    
 
    //-- store global params
-   global.stateParams = viewData
+   global.stateParams = viewData;
 
    if(!fromPopState)
    {
@@ -479,7 +479,7 @@ async function intialiseApp() {
                     //-- we are loading root so select for link
                     loadBookDefaultLink();   
                 }
-            },200)
-        })
-    })
+            },200);
+        });
+    });
  }