hdoc-tools 0.6.2 → 0.6.3

package/README.md

@@ -0,0 +1,42 @@
+# hdoc-tools
+
+Hornbill HDocBook Development Support Tool.
+
+## Usage
+
+<code>hdoc argument switches</code>
+
+## Arguments
+
+The arguments available to this command-line tool are as follows.
+
+### help
+
+Outputs available arguments and switches.
+
+### init
+
+Initializes a new HDocBook project from a template, using runtime input variables.
+
+### stats
+
+Returns statistics regarding the book you are working on:
+
+- Document ID
+- Version
+- Title
+- Description
+- Public Source
+- Total Book Word Count
+- Number of Markdown Files in the Book
+- Number of Static HTML Files in the Book
+
+If the -v switch is provided, then a more verbose output is output, which includes a list of each MD and HTML file found, the file sizes, and file-specific word count.
+
+### 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.

package/hdoc-serve.js

@@ -8,17 +8,17 @@
 
    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");
+      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");
+      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);
@@ -27,7 +27,7 @@
       var docId = hdocbook_project.docId;
 
       // Get the path of the book.json file
-      const hdocbook_path = path.join(source_path, docId, "hdocbook.json");
+      const hdocbook_path = path.join(source_path, docId, 'hdocbook.json');
 
       // Pull in the book config file
       var hdocbook_config = require(hdocbook_path);
@@ -40,67 +40,67 @@
                title: hdocbook_config.title
             }]
          };
-         res.setHeader("Content-Type", "application/json");
+         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";
+            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";
+               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");
+         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);
+         text = text.replaceAll('{{BUILD_DATE}}', build_date);
          return text;
       }
 
@@ -114,7 +114,7 @@
             let md_txt = expand_variables(fs.readFileSync(file_path).toString());
 
             // Render markdown into HTML
-            let frontmatter_content = "";
+            let frontmatter_content = '';
             var html_txt = md.render(md_txt.toString());
 
             if (frontmatter_content.length) {
@@ -125,10 +125,10 @@
 
                const base64 = buff.toString('base64');
 
-               res.setHeader("X-frontmatter", base64);
+               res.setHeader('X-frontmatter', base64);
             }
 
-            res.setHeader("Content-Type", "text/html");
+            res.setHeader('Content-Type', 'text/html');
             res.send(html_txt);
             return true;
          }
@@ -140,11 +140,11 @@
 
          let contentType = content_type_for_ext(path.extname(file_path));
 
-         if (path.extname(file_path) == ".md") {
-            res.setHeader("Content-Disposition", "inline");
+         if (path.extname(file_path) == '.md') {
+            res.setHeader('Content-Disposition', 'inline');
          }
 
-         res.setHeader("Content-Type", contentType);
+         res.setHeader('Content-Type', contentType);
 
          res.send(content_txt);
       }
@@ -152,7 +152,7 @@
       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);
+         res.setHeader('Content-Type', contentType);
 
          const r = fs.createReadStream(file_path);
          const ps = new stream.PassThrough();
@@ -162,15 +162,15 @@
             (err) => {
                if (err) {
                   console.log(err); // No such file or any other kind of error
-                  return res.sendStatus(400).send("Unexpected 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");
+         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,
@@ -199,19 +199,19 @@
 
          let segs = url.split('/');
 
-         if (segs.length == 4 && segs[1] == "content" && segs[3] == "book.json") {
+         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.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");
+               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") {
+         } 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 = {
@@ -222,28 +222,28 @@
                      version: hdocbook_config.version
                   }]
                };
-               res.setHeader("Content-Type", "application/json");
+               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");
+               res.setHeader('Content-Type', 'text/html');
+               res.status(404).send('Specified bookId ' + segs[2] + ' not found');
             }
             return;
          }
 
-         url = url.replace("/content/", "/");
+         url = url.replace('/content/', '/');
 
-         console.log("URL Requested: ", url);
+         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"))) {
+         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"));
+               send_file(req, res, path.join(ui_file_path, 'index.html'));
                return;
             }
             // Return a 404 error here
@@ -255,21 +255,21 @@
             return;
          }
 
-         if (path.extname(file_path) == ".html") {
+         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");
+               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"))) {
+            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") {
+         } 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);
@@ -277,25 +277,25 @@
             }
          } 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")) {
+            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"))) {
+            } 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"));
+            } 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")) {
+            } 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"));
+            } 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)) {
@@ -312,11 +312,11 @@
 
          let segs = req.url.split('/');
 
-         if (segs.length > 3 && segs[2] == "content") {
+         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 url = req.url.replace('/content/', '/');
             let file_path = path.join(source_path, url);
 
             // If the file exists, send it.
@@ -332,12 +332,12 @@
 
          let ui_file_path = path.join(ui_path, req.url);
 
-         console.log("URL Root: ", 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"));
+            send_content_file(req, res, path.join(ui_path, 'index.html'));
             return;
          }
 
@@ -351,12 +351,12 @@
          send_content_resource_404(req, res);
       });
 
-      var server = app.listen(3000, "0.0.0.0", function () {
+      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);
+         console.log('Server listening at http://%s:%s', host, port);
+         console.log('Document source path is: ' + source_path);
       });
 
    };

package/hdoc-stats.js

@@ -3,8 +3,9 @@
     'use strict';
     
     // Required modules
-    const { STATUS_CODES } = require('http');
+    // /const { STATUS_CODES } = require('http');
     const fs = require('fs');
+    var path = require('path');
     const dree = require('dree');
     const html2text = require('html-to-text');
     const { markdownToTxt } = require('markdown-to-txt');
@@ -82,18 +83,20 @@
         //
         // 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';
+
+        console.log('Hornbill HDocBook Stats', '\r\n');
+
+        const project_json_path = path.join(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);
+            console.error('Required project file does not exist:', project_json_path);
             return;
         } else {
             // Book config exists - load book details 
@@ -101,53 +104,71 @@
             try {
                 book_details = JSON.parse(fs.readFileSync(project_json_path, 'utf8'));
             } catch (e) {
-                console.error('Error reading book configuration: ', e);
+                console.error('Error reading book configuration:\r\n', e);
+                return;
+            }
+            const bookPath = path.join(source_path, book_details.docId);
+
+            //Load book config
+            let bookConfig;
+            try {
+                bookConfig = JSON.parse(fs.readFileSync(path.join(bookPath, 'hdocbook.json'), 'utf8'));
+            } catch (e) {
+                console.error('Could not load book configuration:\r\n', e);
                 return;
             }
 
             // Scan content path directory, send file info to callback for processing
-            dree.scan(source_path + '/' + book_details.docId, dreeOptions, fileCallback);
+            dree.scan(bookPath, dreeOptions, fileCallback);
             
             if (verbose) {
                 // Output verbose stats 
 
                 // Output information about all markdown files in the book
-                console.log('--------------');
-                console.log('   Markdown   ');
-                console.log('--------------\r\n');
+                console.log('--------------------');
+                console.log('   Markdown Files   ');
+                console.log('--------------------\r\n');
                 if (stats.totalMDFiles === 0) {
-                    console.log('\r\nNo markdown files found\r\n');
+                    console.log('No markdown files found.\r\n');
                 } else {
                     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');
+                            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('---------------\r\n');
+                console.log('-----------------------');
+                console.log('   Static HTML Files   ');
+                console.log('-----------------------\r\n');
                 if (stats.totalStaticHTMLFiles === 0) {
-                    console.log('No static HTML files found\r\n');
+                    console.log('No static HTML files found.\r\n');
                 } else {
                     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');
+                            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');
+            console.log('----------------------');
+            console.log('   Book Information   ');
+            console.log('----------------------\r\n');
+            console.log('          Document ID:', bookConfig.docId);
+            console.log('              Version:', bookConfig.version, '\r\n');
+            console.log('                Title:', bookConfig.title);
+            console.log('          Description:', bookConfig.description);
+            console.log('        Public Source:', bookConfig.publicSource, '\r\n');
+            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,5 +1,7 @@
 #!/usr/bin/env node
 
+const { createCipheriv } = require('crypto');
+
 (function () {
    'use strict';
 
@@ -28,6 +30,19 @@
       frontmatter_content = fm;
    });
 
+   const packageFile = path.join(__dirname, 'package.json');
+   const getHdocPackageVersion = function (packagePath) {
+      if (fs.existsSync(packagePath)) {
+         try {
+            return JSON.parse(fs.readFileSync(packagePath, 'utf8')).version;
+         } catch (e) {
+            console.error('Could not parse package file: ', packagePath, ' - ', JSON.stringify(e));
+            process.exit(1);
+         }
+      } else {
+         console.error('Package file not found: ', packagePath);
+      }
+   };
    const tips = require(__dirname + '/custom_modules/tips.js');
 
    md.use(tips, {
@@ -36,9 +51,9 @@
 
    // Default source path to working directory
    let source_path = process.cwd();
-   let ui_path = path.join(__dirname, "ui");
+   let ui_path = path.join(__dirname, 'ui');
 
-   let command = ""; // Our command to run
+   let command = ''; // Our command to run
    let verbose = false;
 
    // Get options from command args
@@ -52,40 +67,44 @@
          continue;
       }
 
-      if (process.argv[x] == "-path") {
+      if (process.argv[x] == '-path') {
          x++;
          if (x < process.argv.length) {
             source_path = process.argv[x];
          }
-      } else if (process.argv[x] == "-ui-path") {
+      } else if (process.argv[x] == '-ui-path') {
          x++;
          if (x < process.argv.length) {
             ui_path = process.argv[x];
          }
       }
 
-      if (process.argv[x] === "-v") {
+      if (process.argv[x] === '-v') {
          verbose = true;
       }
    }
 
-   console.log("Hornbill HDocBook Tools v0.1", "\r\n");
-   console.log("    Server Path:", __dirname);
-   console.log("  Document Path:", source_path, "\r\n");
+   console.log('Hornbill HDocBook Tools v', getHdocPackageVersion(packageFile), '\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"));
+   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"));
+   } 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"));
+   } else if (command == 'stats') {
+      const stats = require(path.join(__dirname, 'hdoc-stats.js'));
       stats.run(ui_path, source_path, md, verbose);
-   } else if (command == "init") {
-      const init = require(path.join(__dirname, "hdoc-init.js"));
+   } else if (command == 'init') {
+      const init = require(path.join(__dirname, 'hdoc-init.js'));
       init.run(ui_path, source_path, md);
+   } else if (command == 'help') {
+      const init = require(path.join(__dirname, 'hdoc-help.js'));
+      init.run();
    } else {
-      console.log("Unknown command: " + command);
+      console.log('Unknown command:', command, '\r\n');
+      console.log('Run hdoc help for information regarding this tool.\r\n');
    }
 })();

package/package.json

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