hdoc-tools 0.9.5 → 0.9.7

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

@@ -39,6 +39,12 @@ Performs a local build of the book, validates the links and static content are p
 
 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.
 
+### 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.
+
 ### serve
 
 Starts a local web server on port 3000, serving the book content.

package/hdoc-build.js

@@ -570,10 +570,6 @@
             const nav_a = nav_items[a];
             const parent_a = nav_a.text;
             if (nav_a.link) {
-                if (nav_a.link.includes('\\')) {
-                    console.log(`Navigation items should not contain backslashes: ${nav_a.link}`);
-                    process.exit(1);
-                }
                 bc[nav_a.link] = [{
                     text: nav_a.text,
                     link: nav_a.link
@@ -584,10 +580,6 @@
                     const nav_b = nav_a.items[b];
                     const parent_b = nav_b.text;
                     if (nav_b.link) {
-                        if (nav_b.link.includes('\\')) {
-                            console.log(`Navigation items should not contain backslashes: ${nav_b.link}`);
-                            process.exit(1);
-                        }
                         if (bc[nav_a.link]) {
                             bc[nav_b.link] = bc[nav_a.link];
                         } else {
@@ -607,10 +599,6 @@
                             const nav_c = nav_b.items[c];
                             const parent_c = nav_c.text;
                             if (nav_c.link) {
-                                if (nav_c.link.includes('\\')) {
-                                    console.log(`Navigation items should not contain backslashes: ${nav_c.link}`);
-                                    process.exit(1);
-                                }
                                 if (bc[nav_b.link]) {
                                     bc[nav_c.link] = bc[nav_b.link];
                                 } else {
@@ -633,10 +621,6 @@
                                 for (let d = 0; d < nav_c.items.length; d++) {
                                     const nav_d = nav_c.items[d];
                                     if (nav_d.link) {
-                                        if (nav_d.link.includes('\\')) {
-                                            console.log(`Navigation items should not contain backslashes: ${nav_d.link}`);
-                                            process.exit(1);
-                                        }
                                         if (bc[nav_c.link]) {
                                             bc[nav_d.link] = bc[nav_c.link];
                                         } else {
@@ -690,7 +674,13 @@
         // 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);
+        try {
+            hdocbook_project = require(hdocbook_project_config_path);
+        } catch (e) {
+            console.log('File not found: hdocbook-project.json\n');
+            console.log('hdoc build/validate needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
         doc_id = hdocbook_project.docId;
 
         if (!validate && hdocbook_project.pdfGeneration !== undefined && hdocbook_project.pdfGeneration.enable !== undefined) {
@@ -703,6 +693,7 @@
             work_hdocbook_path = path.join(work_path, doc_id, 'hdocbook.json');
 
         hdocbook_config = require(hdocbook_path);
+        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`);
 
@@ -833,6 +824,8 @@
             } catch (e) {
                 console.log('\nError creating ZIP: ' + e);
             }
+        } else {
+            console.log('\nValidation Complete\n');
         }
     };
 })();

package/hdoc-help.js

@@ -11,20 +11,23 @@ Command Line Usage
 
 Commands
 
+ - build
+    Performs a local build of the book, and outputs as a ZIP file
+
  - help
     Outputs available arguments and switches
 
  - init
     Initializes a new HDocBook project from a template, using runtime input variables
 
+- serve
+    Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
+
  - stats
     Returns statistics regarding the book you are working on. Supports a -v switch for verbose output
 
- - 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 content. Supports a -port N to use a different port
+ - validate
+    Validates the book content
 
 Example
 

package/hdoc-init.js

@@ -123,7 +123,12 @@
         // those files into place, with a few variable replacements.  
 
         console.log('Hornbill HDocBook Init', '\r\n');
+        
+        const curr_dirs =  source_path.split(path.sep);
+        let doc_id = curr_dirs[curr_dirs.length - 1];
+
         prompt.start();
+        promptProps[0].default = doc_id;
         prompt.get(promptProps, function (err, result) {
             if (err) {
                 console.error(err);

package/hdoc-validate.js

@@ -11,9 +11,14 @@
         hdoc = require(path.join(__dirname, 'hdoc-module.js')),
         translator = require('american-british-english-translator');
 
-    const agent = new https.Agent({  
-        rejectUnauthorized: false
-    });
+    const   agent = new https.Agent({  
+                rejectUnauthorized: false
+            }),
+            spellcheck_options = {
+                british: true,
+                spelling: true
+            },
+            regex_nav_paths = /[a-z-\/]+/g;
     
     let prod_families = {};
 
@@ -34,27 +39,21 @@
                 throw `Unexpected Status ${prods.status}`;
             }
         } catch (e) {
-            // Handle errors
             console.log(`Error returning product families: ${e}`);
             return false;
         }
         return true;
     };
 
-    const checkBritishSpelling = async function(source, excludes, text) {
-        if (!errors[source]) errors[source] = [];
-        var options = {
-            british: true,
-            spelling: true
-        };
-
-        let rel_source = source.replaceAll('\\', '/');
-        rel_source = rel_source.substring(0, rel_source.length - path.extname(source).length); 
-        if (rel_source.includes('/_work/')) {
-            rel_source = rel_source.split('/_work/')[1];
-        }
-        
-        const translate_output = translator.translate(text, options);
+    const spellcheckHTML = async function (htmlFile, excludes) {
+        const htmlBody = fs.readFileSync(htmlFile.path, 'utf8');
+        const text = html2text.convert(htmlBody, {
+            wordwrap: null,
+            selectors: [
+                { selector: 'code', format: 'skip'}
+              ]
+        });
+        const translate_output = translator.translate(text, spellcheck_options);
         if(Object.keys(translate_output).length){
             for (const key in translate_output) {
                 if (translate_output.hasOwnProperty(key)) {
@@ -62,10 +61,10 @@
                     for (let i = 0; i < translate_output[key].length; i++) {
                         for (const spelling in translate_output[key][i]) {
                             if (translate_output[key][i].hasOwnProperty(spelling)) {
-                                if (!excludes[rel_source]) {
-                                    errors[source].push(`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`);
-                                } else if (!excludes[rel_source].includes(spelling.toLowerCase())) {
-                                    errors[source].push(`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`);
+                                if (!excludes[htmlFile.relativePath]) {
+                                    errors[htmlFile.relativePath].push(`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`);
+                                } else if (!excludes[htmlFile.relativePath].includes(spelling.toLowerCase())) {
+                                    errors[htmlFile.relativePath].push(`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`);
                                 }
                             }
                         }
@@ -75,15 +74,59 @@
         }
     };
 
-    const checkBritishSpellings = async function (htmlFile, excludes) {
-        const htmlBody = fs.readFileSync(htmlFile.path, 'utf8');
-        const text = html2text.convert(htmlBody, {
-            wordwrap: null,
-            selectors: [
-                { selector: 'code', format: 'skip'}
-              ]
-        });
-        checkBritishSpelling(htmlFile.path, excludes, text);
+    const checkNavigation = async function (doc_id, flat_nav) {
+        let nav_errors = [];
+        for (const key in flat_nav) {
+            if (flat_nav.hasOwnProperty(key)) {
+                // doc paths should only contain a-z - characters
+                const invalid_chars = key.replace(regex_nav_paths, '');
+                if (invalid_chars !== '') {
+                    nav_errors.push(`Navigation path [${key}] contains the following invalid characters: [${[...invalid_chars].join('] [')}]`);
+                } 
+                
+                //Validate path
+                const paths = key.split('/');
+                for (let i = 0; i < paths.length; i++) {
+                    const path_words = paths[i].split('-');
+                    for (let j = 0; j < path_words.length; j++) {
+                        const translate_output = translator.translate(path_words[j], spellcheck_options);
+                        if(Object.keys(translate_output).length){
+                            for (const spell_val in translate_output) {
+                                if (translate_output.hasOwnProperty(spell_val)) {
+                                    for (const spelling in translate_output[spell_val][0]) {
+                                        if (translate_output[spell_val][0].hasOwnProperty(spelling)) {
+                                            nav_errors.push(`Navigation path [${key}] key contains a British English spelling: ${spelling} should be ${translate_output[spell_val][0][spelling].details}`);
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+
+                // Validate display names/bookmarks
+                for (let i = 0; i < flat_nav[key].length; i++) {
+                    if (flat_nav[key][i].link === key) {
+                        const translate_output = translator.translate(flat_nav[key][i].text, spellcheck_options);
+                        if(Object.keys(translate_output).length){
+                            for (const spell_val in translate_output) {
+                                if (translate_output.hasOwnProperty(spell_val)) {
+                                    for (let j = 0; j < translate_output[spell_val].length; j++) {
+                                        for (const spelling in translate_output[spell_val][j]) {
+                                            if (translate_output[spell_val][j].hasOwnProperty(spelling)) {
+                                                nav_errors.push(`Navigation path [${key}] display text contains a British English spelling: ${spelling} should be ${translate_output[spell_val][j][spelling].details}`);
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+
+            }
+        }
+        return nav_errors;
     };
 
     const checkLinks = async function (source_path, htmlFile, links, hdocbook_config) {
@@ -163,7 +206,7 @@
         symbolicLinks: false
     };
 
-    // File callbacks for html file scan
+    // File scan callback
     const fileCallback = function (element) {
         html_files.push(element);
     };
@@ -256,31 +299,43 @@
 
         // Check product family
         let valid_product = false;
+        let meta_errors = [];
         for (let i = 0; i < prod_families.products.length; i++) {
             if (prod_families.products[i].id === hdocbook_config.productFamily) {
                 valid_product = true;
             } 
         }
         if (!valid_product) {
+            meta_errors.push(`Incorrect productFamily: ${hdocbook_config.productFamily}`)
+        }
+
+        // Check navigation spellings
+        const nav_errors = await checkNavigation(doc_id, nav_items);
+        if (nav_errors.length > 0) meta_errors.push(...nav_errors);
+
+        if (meta_errors.length > 0) {
             console.log('\r\n-----------------------');
             console.log('   Validation Output   ');
-            console.log('-----------------------\r\n');
-            console.log(`- Incorrect productFamily: ${hdocbook_config.productFamily}`)
-            console.log(`\r\n1 Validation Errors Found\r\n`);
+            console.log('-----------------------');
+            console.log()
+            console.log(`\r\n${meta_errors.length} Validation Errors Found\r\n`);
+            for (let i = 0; i < meta_errors.length; i++) {
+                console.log(`- ${meta_errors[i]}`);
+            }
             return false;
         }
 
         if (hdocbook_project.validation) {
             if (hdocbook_project.validation.exclude_links && hdocbook_project.validation.exclude_links instanceof Array) {
-               hdocbook_project.validation.exclude_links.forEach(function(excl_link) {
+                hdocbook_project.validation.exclude_links.forEach(function(excl_link) {
                    exclude_links[excl_link] = true;
                });
-           }
-           if (hdocbook_project.validation.exclude_spellcheck && hdocbook_project.validation.exclude_spellcheck instanceof Array) {
-            hdocbook_project.validation.exclude_spellcheck.forEach(function(excl_sc) {
-                exclude_spellcheck[excl_sc.document_path] = excl_sc.words;
-            });
-        }
+            }
+            if (hdocbook_project.validation.exclude_spellcheck && hdocbook_project.validation.exclude_spellcheck instanceof Array) {
+                hdocbook_project.validation.exclude_spellcheck.forEach(function(excl_sc) {
+                    exclude_spellcheck[excl_sc.document_path] = excl_sc.words;
+                });
+            }
         }
 
         let listContent = '';
@@ -292,7 +347,7 @@
             warnings[html_files[i].relativePath] = [];
 
             // Check for Britishisms
-            await checkBritishSpellings(html_files[i], exclude_spellcheck);
+            await spellcheckHTML(html_files[i], exclude_spellcheck);
 
             const links = getLinks(html_files[i]);
             if (links.href.length === 0) {

package/hdoc.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 (async function () {
    'use strict';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.9.5",
+  "version": "0.9.7",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -21,7 +21,8 @@
     "validateNodeVer.js",
     "ui",
     "custom_modules",
-    "templates"
+    "templates",
+    "templates/init/.gitignore"
   ],
   "scripts": {
     "preinstall": "node validateNodeVer",

package/templates/init/.gitignore

@@ -0,0 +1,7 @@
+_work/
+node_modules/
+package-lock.json
+.wsuo
+VSWorkspaceState.json
+slnx.state
+slnx.sqlite

package/ui/index.html

@@ -224,7 +224,7 @@
                                                 (n) minutes to read
                                             </li>                                                                  
                                             <li class="ps-0 mt-0 nav-bar-item">
-                                                <a class="link c-pointer">(n) contributers</a>
+                                                <a class="link c-pointer">(n) contributors</a>
                                             </li>                                                    
                                         </ul>
                                     </div>