hdoc-tools 0.9.18 → 0.9.20

package/README.md

@@ -41,13 +41,15 @@ If the -v switch is provided, then more verbose output is output, which includes
 
 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 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 a more verbose output is provided, which includes a list of all HTML files created and checked for embedded links and static content.
 
-### build
+Use the --set-version argument to set the version number of the built book.
+
+### validate
 
 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 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 a 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.
 

package/hdoc-build.js

@@ -724,7 +724,7 @@
         const validation_success = await hdoc_validate.run(work_path, doc_id, verbose, hdocbook_config, hdocbook_project, bc);
         if (!validation_success) {
             const end_time = Date.now();
-            console.log(`Time Taken: ${get_duration(start_time, end_time)}\n`);
+            console.log(`\nTime Taken: ${get_duration(start_time, end_time)}\n`);
             process.exit(1);
         }
 
@@ -737,9 +737,10 @@
                 console.log(`Error deleting ${md_files_delete[i]}: ${e}`);
             }
         }
-
+    
         // Add book read timing to the hdocbook.json
         hdocbook_config.readingTime = Math.ceil(book_read_time + ((book_read_time / 100) * 10));
+        hdocbook_config.navigation.items = hdoc.strip_drafts(hdocbook_config.navigation.items);
         try {
             fs.writeFileSync(work_hdocbook_path, JSON.stringify(hdocbook_config, null, 2));
             console.log('\nhdocbook.json update success:', work_hdocbook_path);

package/hdoc-module.js

@@ -290,7 +290,22 @@
         return response;
     };
 
-    
+    exports.strip_drafts = function (nav_items) {
+        let return_nav = nav_items;
+        recurse_nav(return_nav);
+        return return_nav;
+    };
+    const recurse_nav = function(nav_items) {
+        for (const key in nav_items) {
+            if (nav_items[key].draft) {
+                nav_items.splice(key, 1);
+                recurse_nav(nav_items);
+            } else if (nav_items[key].items) {
+                recurse_nav(nav_items[key].items);
+            }
+        }
+    };
+
     exports.build_breadcrumbs = function (nav_items) {
         let bc = {};
         // Steve - need to rework this to use recursion, as it's hard-coded for a maximum of 4 levels deep right now

package/hdoc-validate.js

@@ -8,17 +8,18 @@
         https = require('https'),
         path = require('path'),
         hdoc = require(path.join(__dirname, 'hdoc-module.js')),
-        translator = require('american-british-english-translator');
-
-    const   agent = new https.Agent({  
-                rejectUnauthorized: false
-            }),
-            spellcheck_options = {
-                british: true,
-                spelling: true
-            },
-            regex_nav_paths = /[a-z0-9-\/]+/g;
-    
+        translator = require('american-british-english-translator'),
+        { trueCasePathSync } = require('true-case-path');
+
+    const agent = new https.Agent({
+            rejectUnauthorized: false
+        }),
+        spellcheck_options = {
+            british: true,
+            spelling: true
+        },
+        regex_nav_paths = /[a-z0-9-\/]+/g;
+
     let prod_families = {},
         prods_supported = [];
 
@@ -31,9 +32,11 @@
         exclude_links = {},
         exclude_spellcheck = {};
 
-    const load_product_families = async function() {
+    const load_product_families = async function () {
         try {
-            const prods = await axios.get('https://docs.hornbill.com/_books/products.json', { httpsAgent: agent });
+            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++) {
@@ -51,9 +54,9 @@
 
     const spellcheckContent = async function (sourceFile, excludes) {
         const text = fs.readFileSync(sourceFile.path, 'utf8');
-        const source_path = sourceFile.relativePath.replace('.'+sourceFile.extension, '');
+        const source_path = sourceFile.relativePath.replace('.' + sourceFile.extension, '');
         const translate_output = translator.translate(text, spellcheck_options);
-        if(Object.keys(translate_output).length){
+        if (Object.keys(translate_output).length) {
 
             for (const key in translate_output) {
                 if (translate_output.hasOwnProperty(key)) {
@@ -70,11 +73,11 @@
                         }
                     }
                 }
-            }      
+            }
         }
     };
 
-    const checkNavigation = async function (doc_id, flat_nav) {
+    const checkNavigation = async function (source_path, flat_nav) {
         let nav_errors = [];
         for (const key in flat_nav) {
             if (flat_nav.hasOwnProperty(key)) {
@@ -82,15 +85,33 @@
                 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
+                }
+
+                // Validate path exists - key should be a html file at this point
+                let file_exists = true;
+                let file_name = path.join(source_path, key + '.html');
+                if (!fs.existsSync(file_name)) {
+                    file_name = path.join(source_path, key + '.htm');
+                    if (!fs.existsSync(file_name)) {
+                        file_exists = false;
+                        nav_errors.push(`Navigation path [${key}] file does not exist.`);
+                    }
+                }
+
+                if (file_exists) {
+                    const true_file = trueCasePathSync(file_name);
+                    if (true_file !== file_name) {
+                        nav_errors.push(`Navigation path [${key}] does not match filename case [${path.basename(true_file)}].`);
+                    }
+                }
+
+                // 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){
+                        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]) {
@@ -108,7 +129,7 @@
                 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){
+                        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++) {
@@ -163,7 +184,9 @@
                 }
 
                 try {
-                    await axios.get(links[i], { httpsAgent: agent });
+                    await axios.get(links[i], {
+                        httpsAgent: agent
+                    });
                     messages[htmlFile.relativePath].push(`Link is a valid external URL: ${links[i]}`);
                 } catch (e) {
                     // Handle errors
@@ -197,15 +220,17 @@
     const checkTags = async function (htmlFile) {
         const htmlBody = fs.readFileSync(htmlFile.path, 'utf8');
         const $ = cheerio.load(htmlBody);
-        
+
         const h1_tags = $('h1').map(function () {
             return $(this);
         }).get();
+
         if (h1_tags.length && h1_tags.length > 1) {
+            //console.log("PATH: ", htmlFile.path); //hdoc-guide/hdocbook/markdown.html
             let error_msg = `${h1_tags.length} <h1> tags found in content: `;
             for (let i = 0; i < h1_tags.length; i++) {
-                error_msg  += h1_tags[i].text();
-                if (i <  h1_tags.length - 1) error_msg += '; ';
+                error_msg += h1_tags[i].text();
+                if (i < h1_tags.length - 1) error_msg += '; ';
             }
             errors[htmlFile.relativePath].push(error_msg);
         }
@@ -214,7 +239,7 @@
     const dreeOptions = {
         descendants: true,
         depth: 10,
-        extensions: ['htm', 'html','md'],
+        extensions: ['htm', 'html', 'md'],
         hash: false,
         normalize: true,
         size: false,
@@ -324,7 +349,7 @@
         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) {
             let val_prod_error = `Incorrect productFamily: ${hdocbook_config.productFamily}. Supported values:`;
@@ -332,18 +357,17 @@
                 val_prod_error += `\n  - ${prods_supported[i]}`
             }
             meta_errors.push(val_prod_error)
-            
+
         }
 
         // Check navigation spellings
-        const nav_errors = await checkNavigation(doc_id, nav_items);
+        const nav_errors = await checkNavigation(source_path, 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('-----------------------');
-            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]}`);
@@ -353,12 +377,12 @@
 
         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) {
-                   exclude_links[excl_link] = true;
-               });
+                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) {
+                hdocbook_project.validation.exclude_spellcheck.forEach(function (excl_sc) {
                     exclude_spellcheck[excl_sc.document_path] = excl_sc.words;
                 });
             }
@@ -437,21 +461,20 @@
         console.log('\r\n-----------------------');
         console.log('   Validation Output   ');
         console.log('-----------------------');
-
-        for (const key in errors) {
-            if (errors.hasOwnProperty(key) && errors[key].length > 0) {
-                console.log(`\r\n${errors[key].length} error(s) in ${key}`);
-                for (let i = 0; i < errors[key].length; i++) {
-                    console.log(` - ${errors[key][i]}`);
-                    errorcount++;
-                }
-            }
-        }
-
         if (errorcount > 0) {
             console.log(`\r\n${errorcount} Validation Errors Found\r\n`);
+            for (const key in errors) {
+                if (errors.hasOwnProperty(key) && errors[key].length > 0) {
+                    console.log(`\r\n${errors[key].length} error(s) in ${key}`);
+                    for (let i = 0; i < errors[key].length; i++) {
+                        console.log(` - ${errors[key][i]}`);
+                        errorcount++;
+                    }
+                }
+            }
             return false;
         }
+
         console.log(`\r\nNo Validation Errors Found!\r\n`);
         return true;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.9.18",
+  "version": "0.9.20",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -52,6 +52,7 @@
     "prompt": "^1.3.0",
     "puppeteer": "^19.8.0",
     "stream": "0.0.2",
+    "true-case-path": "^2.2.1",
     "words-count": "^2.0.2",
     "zip-a-folder": "^1.1.5"
   }