hdoc-tools 0.17.20 → 0.17.21

package/hdoc-build.js

@@ -923,8 +923,17 @@
             }
         }
         console.log(`Processing navigation breadcrumbs...`);
-        bc = hdoc.build_breadcrumbs(hdocbook_config.navigation.items);
-
+        const bc_build = hdoc.build_breadcrumbs(hdocbook_config.navigation.items);
+        if (bc_build.errors.length > 0) {
+            console.log('\r\n-----------------------');
+            console.log('   Validation Output   ');
+            console.log('-----------------------');
+            console.log(`\n${bc_build.errors.length} errors found when processing navigation:\n`);
+            console.log(` - ${bc_build.errors.join('\n\n - ')}`);
+            console.log('\n');
+            process.exit(1);
+        }
+        bc = bc_build.bc;
         console.log(`Processing content...`);
         // Get a list of MD files in work_path
         dree.scan(work_path, dreeOptions, build_file_callback);

package/hdoc-module.js

@@ -424,7 +424,10 @@
     };
 
     exports.build_breadcrumbs = function (nav_items) {
-        const bc = {};
+        let response = {
+            bc: {},
+            errors: []
+        };
         const buildBreadcrumb = (items, parentLinks) => {
 
             // Process parent links
@@ -441,6 +444,13 @@
 
             // Loop through items, build breadcrumb
             for (let i = 0; i < items.length; i++) {
+                if (!items[i].text) {
+                    response.errors.push(`The following Nav Item is missing its text property: ${JSON.stringify(items[i])}`);
+                }
+
+                if (!items[i].link && !items[i].items) {
+                    response.errors.push(`The following Nav Item is missing has no link or items property: ${JSON.stringify(items[i])}`);
+                }
                 const item = items[i];
                 if (!parentlink && item.link) {
                     parentLinks[0].link = item.link;
@@ -450,7 +460,7 @@
                 const breadcrumb = [...parentLinks, { text, link }];
 
                 if (link) {
-                    bc[link] = breadcrumb;
+                    response.bc[link] = breadcrumb;
                 }
 
                 if (subItems) {
@@ -460,7 +470,7 @@
         };
 
         buildBreadcrumb(nav_items, []);
-        return bc;
+        return response;
     };
 
     exports.load_product_families = async function () {

package/package.json

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