hdoc-tools 0.9.14 → 0.9.16

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/README.md

@@ -35,26 +35,28 @@ Returns statistics regarding the book you are working on:
 - 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.
+If the -v switch is provided, then 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, validates the links and static content are present and correct, and outputs as a ZIP file.
+Performs a local build of the book, validates the links and static content are present and correct and outputs as a ZIP file.
 
-If the -v switch is provided, then a more verbose output is provided, which includes a list of all HTML files created and checked for embedded links and static content.
+If the -v switch is provided, then more verbose output is provided, which includes a list of all HTML files created and checked for embedded links and static content.
 
 ### build
 
 Performs a minimum local build of the book, then validates the links and static content are present and correct.
 
-If the -v switch is provided, then a more verbose output is provided, which includes a list of all HTML files created and checked for embedded links and static content.
+If the -v switch is provided, then more verbose output is provided, which includes a list of all HTML files created and checked for embedded links and static content.
+
+Use the --set-version argument to set the version number of the built book.
 
 ### serve
 
 Starts a local web server on port 3000, serving the book content.
 
 To preview the documentation in a browser, you can open a terminal window and run the dev preview server with the 
-command `hdoc serve` and in a local browser go to the url `http://localhost:3000`
+command `hdoc serve` and in a local browser go to the URL `http://localhost:3000`
 
 ## Installation
 

package/hdoc-build.js

@@ -22,7 +22,8 @@
         pdf_header_template_path = path.join(__dirname, 'templates', 'pdf-header.html'),
         non_git_pdf_header_template_path = path.join(__dirname, 'templates', 'pdf-header-non-git.html'),
         pdf_template_path = path.join(__dirname, 'templates', 'pdf'),
-        pdf_template_file_path = path.join(pdf_template_path, 'template.html');
+        pdf_template_file_path = path.join(pdf_template_path, 'template.html'),
+        regex_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}$/;
 
     let bc = {}, // Breadcrumbs map
         book_read_time = 0,
@@ -565,7 +566,7 @@
         sorted: true
     };
 
-    exports.run = async function (source_path, verbose_output, github_api_token, validate) {
+    exports.run = async function (source_path, verbose_output, github_api_token, validate, build_version = '') {
         if (github_api_token !== '') {
             git_token = github_api_token;
         }
@@ -607,6 +608,15 @@
             work_hdocbook_path = path.join(work_path, doc_id, 'hdocbook.json');
 
         hdocbook_config = require(hdocbook_path);
+        if (build_version !== '')  {
+            hdocbook_config.version = build_version;
+        }
+
+        if (!hdocbook_config.version.match(regex_version)) {
+            console.log(`ERROR: Version number does not match required format - ${hdocbook_config.version}\n`);
+            process.exit(1);
+        } 
+
         if (hdocbook_config.publicSource.endsWith('.git')) hdocbook_config.publicSource = hdocbook_config.publicSource.substring(0, hdocbook_config.publicSource.length - 4);
 
         console.log(`Building: ${doc_id} v${hdocbook_config.version}...\n`);

package/hdoc-help.js

@@ -12,7 +12,7 @@ Command Line Usage
 Commands
 
  - build
-    Performs a local build of the book, and outputs as a ZIP file
+    Performs a local build of the book, and outputs as a ZIP file. Use non-mandatory argument '--set-version 1.2.3' to set the version number of the built book
 
  - createDocs
     Creates folder structure and markdown documents as defined in the HDocBook navigation item links 
@@ -23,7 +23,7 @@ Commands
  - init
     Initializes a new HDocBook project from a template, using runtime input variables
 
-- serve
+ - serve
     Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
 
  - stats

package/hdoc-validate.js

@@ -19,7 +19,8 @@
             },
             regex_nav_paths = /[a-z0-9-\/]+/g;
     
-    let prod_families = {};
+    let prod_families = {},
+        prods_supported = [];
 
     let errors = {},
         messages = {},
@@ -35,6 +36,9 @@
             const prods = await axios.get('https://docs.hornbill.com/_books/products.json', { httpsAgent: agent });
             if (prods.status === 200) {
                 prod_families = prods.data;
+                for (let i = 0; i < prod_families.products.length; i++) {
+                    prods_supported.push(prod_families.products[i].id);
+                }
             } else {
                 throw `Unexpected Status ${prods.status}`;
             }
@@ -323,7 +327,12 @@
             } 
         }
         if (!valid_product) {
-            meta_errors.push(`Incorrect productFamily: ${hdocbook_config.productFamily}`)
+            let val_prod_error = `Incorrect productFamily: ${hdocbook_config.productFamily}. Supported values:`;
+            for (let i = 0; i < prods_supported.length; i++) {
+                val_prod_error += `\n  - ${prods_supported[i]}`
+            }
+            meta_errors.push(val_prod_error)
+            
         }
 
         // Check navigation spellings

package/hdoc.js

@@ -24,9 +24,10 @@
    // Default source path to working directory
    let source_path = process.cwd();
    let ui_path = path.join(__dirname, 'ui');
-   let git_token = '';
-   let command = '', // Our command to run
-      verbose = false;
+   let   git_token = '',
+         command = '', // Our command to run
+         build_version = '',
+         verbose = false;
 
    // Get options from command args
    for (let x = 0; x < process.argv.length; x++) {
@@ -51,11 +52,16 @@
          if (x < process.argv.length) {
             ui_path = process.argv[x];
          }
-      } else if (process.argv[x] == '-git-token') {
+      } else if (process.argv[x] == '--git-token') {
          x++;
          if (x < process.argv.length) {
             git_token = process.argv[x];
          }
+      } else if (process.argv[x] == '--set-version') {
+         x++;
+         if (x < process.argv.length) {
+            build_version = process.argv[x];
+         }
       }
    }
 
@@ -68,7 +74,7 @@
       server.run(ui_path, source_path);
    } else if (command == 'build') {
       const builder = require(path.join(__dirname, 'hdoc-build.js'));
-      await builder.run(source_path, verbose, git_token, false);
+      await builder.run(source_path, verbose, git_token, false, build_version);
    } else if (command == 'createDocs') {
       const creator = require(path.join(__dirname, 'hdoc-create.js'));
       await creator.run(source_path);

package/package.json

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