hdoc-tools 0.17.32 → 0.17.33

package/hdoc-build-db.js

@@ -69,7 +69,7 @@
                 const fts5 = key === 'hdoc_index' ? true : false;
                 const table_created_error = this.create_table(response.db, key, db_schema[key], virtual, fts5);
                 if (table_created_error !== null) {
-                    console.log(table_created_error);
+                    console.error(table_created_error);
                 }
             }
         }
@@ -140,7 +140,7 @@
                 index_response = hdoc_index.insert_record(db, 'hdoc_index', db_schema.hdoc_index, index_vals);
             }
             if (!index_response.success) {
-                console.log(`Index record creation failed - ${doc_id}/${file.index_html.fm_props.title}: ${index_response.error}`);
+                console.error(`Index record creation failed - ${doc_id}/${file.index_html.fm_props.title}: ${index_response.error}`);
             } else {
                 // Now add metadata
                 const meta_vals = [
@@ -153,7 +153,7 @@
                 ];
                 const meta_response = await hdoc_index.insert_record(db, 'hdoc_meta', db_schema.hdoc_meta, meta_vals);
                 if (!meta_response.success) {
-                    console.log(`Index metadata record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${meta_response.error}`);
+                    console.error(`Index metadata record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${meta_response.error}`);
                 } else {
                     if (verbose) {
                         console.log(`Inserted index record ${index_response.row_id}: ${doc_id} - ${file.index_html.fm_props.title}`);
@@ -172,7 +172,7 @@
                         ];
                         const cont_response = await hdoc_index.insert_record(db, 'hdoc_contributors', db_schema.hdoc_contributors, contrib_vals);
                         if (!cont_response.success) {
-                            console.log(`Index document contributor record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${cont_response.error}`);
+                            console.error(`Index document contributor record creation failed - ${doc_id}/${index_response.row_id}/${file.index_html.fm_props.title}: ${cont_response.error}`);
                             continue;
                         }
                         if (verbose) {

package/hdoc-build-pdf.js

@@ -17,7 +17,7 @@
         try {
             footer_content = fs.readFileSync(path.join(template_path, 'template-footer.html'), 'utf8');
         } catch (err) {
-            console.log(`Error loading template: ${err}`);
+            console.error(`Error loading template: ${err}`);
         }
         return footer_content;
     };
@@ -27,7 +27,7 @@
         try {
             header_content = fs.readFileSync(path.join(template_path, 'template-header.html'), 'utf8');
         } catch (err) {
-            console.log(`Error loading template: ${err}`);
+            console.error(`Error loading template: ${err}`);
         }
         return header_content;
     };
@@ -73,7 +73,7 @@
                     image_b64 = `data:${mime_type};base64,${image_b64}`;
                     html_source = html_source.replace(imgs[i], image_b64);
                 } catch (err) {
-                    console.log('Error reading image from HTML source [', image_path, '] -', err);
+                    console.error('Error reading image from HTML source [', image_path, '] -', err);
                     return null;
                 }
             } else {
@@ -90,7 +90,7 @@
                         throw `Unexpected Status ${file_response.status}`;
                     }
                 } catch (err) {
-                    console.log(`Error downloading external source [${imgs[i]}] - ${err}`);
+                    console.error(`Error downloading external source [${imgs[i]}] - ${err}`);
                 }
             }
         }
@@ -112,7 +112,7 @@
                 hb_logo = hb_logo_file_buffer.toString("base64");
                 hb_logo = `data:image/svg+xml;base64,${hb_logo}`;
             } catch (err) {
-                console.log('Error reading logo from template:', err);
+                console.error('Error reading logo from template:', err);
                 return pdf_size;
             }
         }
@@ -139,7 +139,7 @@
                     content: css_templates[i]
                 });
             } catch (e) {
-                console.log(`Error applying template for [${target_file}]: ${e}`);
+                console.error(`Error applying template for [${target_file}]: ${e}`);
             }
         }
 
@@ -165,7 +165,7 @@
 
             pdf_size = pdf_gen.byteLength;
         } catch (err) {
-            console.log(`Error generating PDF ${target_file} - ${err}`);
+            console.error(`Error generating PDF ${target_file} - ${err}`);
         }
         await page.close();
         return pdf_size;

package/hdoc-build.js

@@ -184,7 +184,7 @@
             doc_title = html_heading[0].children[0].data;
           } else {
             // No header tag, no frontmatter title, output a warning
-            console.log(
+            console.info(
               `[WARNING] No frontmatter title property, or ${h_tags_to_search.join(
                 ", "
               )} tags detected in ${file_path.path}`
@@ -262,7 +262,7 @@
           file_path.name !== "article_ext.md"
         ) {
           // No header tag, no frontmatter title, output a warning
-          console.log(
+          console.info(
             `[WARNING] No frontmatter title property, or ${h_tags_to_search.join(
               ", "
             )} tags detected in ${file_path.path}`
@@ -327,7 +327,7 @@
         );
 
         if (!contributors.success) {
-          console.log(
+          console.error(
             `Error retrieving contributors from Github: ${contributors.error}`
           );
         } else {
@@ -473,7 +473,7 @@
       try {
         fs.writeFileSync(file_path.path, html_txt);
       } catch (err) {
-        console.log("Error writing:", target_file, "\n", err);
+        console.error("Error writing:", target_file, "\n", err);
       }
     }
   };
@@ -612,7 +612,7 @@
           file_path.name !== "article_ext.md"
         ) {
           // No header tag, no frontmatter title, output a warning
-          console.log(
+          console.info(
             `[WARNING] No frontmatter title property, or h1, h2 or h3 header tags detected in ${file_path.path}`
           );
         }
@@ -674,7 +674,7 @@
         );
 
         if (!contributors.success) {
-          console.log(
+          console.error(
             `Error retrieving contributors from Github: ${contributors.error}`
           );
         } else {
@@ -706,7 +706,7 @@
               JSON.stringify(contributors, null, 2)
             );
           } catch (err) {
-            console.log("Error writing:", target_file, "\n", err);
+            console.error("Error writing:", target_file, "\n", err);
           }
         }
         fm_headers.push({
@@ -816,7 +816,7 @@
       try {
         fs.writeFileSync(target_file, html_txt);
       } catch (err) {
-        console.log("Error writing:", target_file, "\n", err);
+        console.error("Error writing:", target_file, "\n", err);
       }
 
       if (
@@ -859,7 +859,7 @@
           try {
             json_tidy = JSON.stringify(JSON.parse(json_tidy), null, 2);
           } catch (e) {
-            console.log(
+            console.info(
               `[WARNING] Could not tidy JSON in file [${file}]: ${e}`
             );
           }
@@ -886,7 +886,7 @@
               lineSeparator: "\n",
             });
           } catch (e) {
-            console.log(`[WARNING] Could not tidy XML in file [${file}]: ${e}`);
+            console.info(`[WARNING] Could not tidy XML in file [${file}]: ${e}`);
           }
           markdown = markdown.replace(
             xml_to_tidy[i],
@@ -980,7 +980,7 @@
       }
     } else {
       if (verbose) {
-        console.log(
+        console.info(
           `[WARNING] Path is not present in navigation items: ${logical_path}`
         );
       }
@@ -1098,8 +1098,8 @@
     try {
       hdocbook_project = require(hdocbook_project_config_path);
     } catch (e) {
-      console.log("File not found: hdocbook-project.json\n");
-      console.log(
+      console.error("File not found: hdocbook-project.json\n");
+      console.error(
         "hdoc build/validate needs to be run in the root of a HDoc Book.\n"
       );
       process.exit(1);
@@ -1139,14 +1139,14 @@
       if (build_version.match(regex_version)) {
         hdocbook_config.version = build_version;
       } else {
-        console.log(
+        console.info(
           `\n[WARNING] Argument build version [${build_version}] does not match expected pattern, defaulting to version specified in book [${hdocbook_config.version}]\n`
         );
       }
     }
 
     if (!hdocbook_config.version.match(regex_version)) {
-      console.log(
+      console.error(
         `ERROR: Version number does not match required format - ${hdocbook_config.version}\n`
       );
       process.exit(1);
@@ -1164,7 +1164,7 @@
     console.log(`Loading product families...`);
     const prods = await hdoc.load_product_families();
     if (!prods.success) {
-      console.log(`${prods.errors}\n`);
+      console.error(`${prods.errors}\n`);
       process.exit(1);
     } else {
       prod_families = prods.prod_families;
@@ -1182,7 +1182,7 @@
         try {
           css_templates.push(fs.readFileSync(css_files[i], "utf8"));
         } catch (e) {
-          console.log(`Error reading file[${css_files[i]}]: ${e}`);
+          console.error(`Error reading file[${css_files[i]}]: ${e}`);
         }
       }
     }
@@ -1194,8 +1194,8 @@
         console.log("\r\n-----------------------");
         console.log("   Validation Output   ");
         console.log("-----------------------");
-      console.log(`${errors_filename.length} files do not meet filename requirements:`);
-      console.log(` - ${errors_filename.join("\n - ")}`);
+      console.error(`${errors_filename.length} files do not meet filename requirements:`);
+      console.error(` - ${errors_filename.join("\n - ")}`);
       console.log()
       process.exit(1);
     }
@@ -1235,7 +1235,7 @@
         built_file_hashes[i].path + ":" + built_file_hashes[i].hash + "|";
     }
     if (concat_hash === "|") {
-      console.log("No hash of content has been returned.");
+      console.error("No hash of content has been returned.");
       process.exit(1);
     }
 
@@ -1246,7 +1246,7 @@
       fs.writeFileSync(checksum_path, hash);
       console.log("Hash file creation success:", checksum_path);
     } catch (e) {
-      console.log("\nError creating", checksum_path, ":", e);
+      console.error("\nError creating", checksum_path, ":", e);
       process.exit(1);
     }
 
@@ -1264,7 +1264,7 @@
         "utf8"
       );
     } catch (err) {
-      console.log(`Error reading document header template: ${err}`);
+      console.error(`Error reading document header template: ${err}`);
       process.exit(1);
     }
 
@@ -1273,7 +1273,7 @@
       try {
         pdf_template = fs.readFileSync(pdf_template_file_path, "utf8");
       } catch (err) {
-        console.log(`Error reading PDF template: ${err}`);
+        console.error(`Error reading PDF template: ${err}`);
         process.exit(1);
       }
     }
@@ -1286,7 +1286,7 @@
       console.log(
         `\n${bc_build.errors.length} errors found when processing navigation:\n`
       );
-      console.log(` - ${bc_build.errors.join("\n\n - ")}`);
+      console.error(` - ${bc_build.errors.join("\n\n - ")}`);
       console.log("\n");
       process.exit(1);
     }
@@ -1338,10 +1338,10 @@
     // Output to console
     console.log(`\n                MD files found: ${conversion_attempted}`);
     console.log(`Successfully converted to HTML: ${conversion_success}`);
-    console.log(`             Failed to convert: ${conversion_failed}\n`);
+    console.error(`             Failed to convert: ${conversion_failed}\n`);
     console.log(`                Includes Found: ${includes_found}`);
     console.log(`              Includes Success: ${includes_success}`);
-    console.log(`               Includes Failed: ${includes_failed}\n`);
+    console.error(`               Includes Failed: ${includes_failed}\n`);
     console.log(
       `       Static HTML Files Found: ${static_html_files.length}\n`
     );
@@ -1378,7 +1378,7 @@
     await Promise.all(
       filePromiseArray.map(async (file) => {
         fs.unlink(file, (err) => {
-          if (err) console.log(`Error deleting ${file}: ${e}`);
+          if (err) console.error(`Error deleting ${file}: ${e}`);
         });
       })
     );
@@ -1397,7 +1397,7 @@
       );
       console.log("\nhdocbook.json update success:", work_hdocbook_path);
     } catch (e) {
-      console.log("\nError creating", work_hdocbook_path, ":", e);
+      console.error("\nError creating", work_hdocbook_path, ":", e);
       process.exit(1);
     }
 
@@ -1406,7 +1406,7 @@
     console.log(`Building the Index`);
     let db = hdoc_build_db.create_db(work_path, doc_id);
     if (db.error && db.error !== null) {
-      console.log(db.error);
+      console.error(db.error);
       process.exit(1);
     }
     // Populate primary index tables
@@ -1418,7 +1418,7 @@
       verbose
     );
     if (!index.success) {
-      console.log(index.error);
+      console.error(index.error);
       process.exit(1);
     }
 
@@ -1435,7 +1435,7 @@
       );
       if (!redirects_index.success) {
         for (let i = 0; i < index.errors.length; i++) {
-          console.log(index.errors[i]);
+          console.error(index.errors[i]);
         }
         process.exit(1);
       }
@@ -1461,7 +1461,7 @@
         console.log("  Build Started:", build_start_dt);
         console.log(`Build Completed: ${new Date().toLocaleString()}\n`);
       } catch (e) {
-        console.log("\nError creating ZIP: " + e);
+        console.error("\nError creating ZIP: " + e);
       }
     } else {
       console.log("\nValidation Complete\n");

package/hdoc-bump.js

@@ -6,7 +6,7 @@
 
     exports.run = function (source_path, bump_type) {
         if (bump_type !== 'patch' && bump_type !== 'minor' && bump_type !== 'major') {
-            console.log(`Unsupported bump type: ${bump_type}`);
+            console.error(`Unsupported bump type: ${bump_type}`);
             process.exit(1);
         }
         console.log(`Bumping ${bump_type} book version...\n`);
@@ -17,9 +17,9 @@
         try {
             hdocbook_project = require(hdocbook_project_config_path);
         } catch (e) {
-            console.log('File not found: hdocbook-project.json:');
-            console.log(e, '\n');
-            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
+            console.error('File not found: hdocbook-project.json:');
+            console.error(e, '\n');
+            console.error('hdoc bump needs to be run in the root of a HDoc Book.\n');
             process.exit(1);
         }
         const doc_id = hdocbook_project.docId;
@@ -31,28 +31,28 @@
         try {
             hdocbook_config = require(hdocbook_path);
         } catch (e) {
-            console.log('File not found: hdocbook.json');
-            console.log(e, '\n');
-            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
+            console.error('File not found: hdocbook.json');
+            console.error(e, '\n');
+            console.error('hdoc bump needs to be run in the root of a HDoc Book.\n');
             process.exit(1);
         }
         const initial_version = hdocbook_config.version;
         let hdocbook_version = hdocbook_config.version.split('.');
         if (hdocbook_version.length !== 3) {
-            console.log(`Book version does not appear to be in a semantic versioning format: ${initial_version}`);
+            console.error(`Book version does not appear to be in a semantic versioning format: ${initial_version}`);
             process.exit(1);
         }
 
         if (isNaN(hdocbook_version[0])) {
-            console.log(`Existing major version is not a number: ${hdocbook_version[0]}`);
+            console.error(`Existing major version is not a number: ${hdocbook_version[0]}`);
             process.exit(1);
         }
         if (isNaN(hdocbook_version[1])) {
-            console.log(`Existing minor version is not a number: ${hdocbook_version[1]}`);
+            console.error(`Existing minor version is not a number: ${hdocbook_version[1]}`);
             process.exit(1);
         }
         if (isNaN(hdocbook_version[2])) {
-            console.log(`Existing patch version is not a number: ${hdocbook_version[2]}`);
+            console.error(`Existing patch version is not a number: ${hdocbook_version[2]}`);
             process.exit(1);
         }
 
@@ -63,8 +63,8 @@
                     hdocbook_version[1] = 0;
                     hdocbook_version[2] = 0;
                 } catch (e) {
-                    console.log('Failed to update major version:');
-                    console.log(e);
+                    console.error('Failed to update major version:');
+                    console.error(e);
                     process.exit(1);
                 }
                 break;
@@ -74,8 +74,8 @@
                     hdocbook_version[1] = parseInt(hdocbook_version[1], 10) + 1;
                     hdocbook_version[2] = 0;
                 } catch (e) {
-                    console.log('Failed to update minor version:');
-                    console.log(e);
+                    console.error('Failed to update minor version:');
+                    console.error(e);
                     process.exit(1);
                 }
                 break;
@@ -86,8 +86,8 @@
                     hdocbook_version[1] = parseInt(hdocbook_version[1], 10);
                     hdocbook_version[2] = parseInt(hdocbook_version[2], 10) + 1;
                 } catch (e) {
-                    console.log('Failed to update patch version:');
-                    console.log(e);
+                    console.error('Failed to update patch version:');
+                    console.error(e);
                     process.exit(1);
                 }
                 break;
@@ -98,7 +98,7 @@
         try {
             fs.writeFileSync(hdocbook_path, JSON.stringify(hdocbook_config, null, 2));
         } catch (e) {
-            console.log('Error writing bumped version to book config:', e);
+            console.error('Error writing bumped version to book config:', e);
             process.exit(1);
         }
 

package/hdoc-create.js

@@ -22,8 +22,8 @@
         try {
             hdocbook_project = require(hdocbook_project_config_path);
         } catch (e) {
-            console.log(`File not found: ${hdocbook_project_config_path}\n`);
-            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
+            console.error(`File not found: ${hdocbook_project_config_path}\n`);
+            console.error('hdoc create needs to be run in the root of a HDoc Book.\n');
             process.exit(1);
         }
         doc_id = hdocbook_project.docId;
@@ -35,8 +35,8 @@
         try {
             hdocbook = require(hdocbook_path);
         } catch (e) {
-            console.log(`File not found: ${hdocbook_path}\n`);
-            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
+            console.error(`File not found: ${hdocbook_path}\n`);
+            console.error('hdoc create needs to be run in the root of a HDoc Book.\n');
             process.exit(1);
         }
 
@@ -73,7 +73,7 @@
                 console.log('Folder created:', folder);
                 folder_count++;
             } catch {
-                console.log('\nError creating folder', folder, ':', e);
+                console.error('\nError creating folder', folder, ':', e);
                 return;
             }
         }
@@ -87,7 +87,7 @@
                 processed_links[doc_info.link] = true;
                 file_count++;
             } catch (e) {
-                console.log('\nError creating file', doc_info.path, ':', e);
+                console.error('\nError creating file', doc_info.path, ':', e);
             }
         }
     }

package/hdoc-init.js

@@ -75,7 +75,7 @@
             const hdocBookProjectFile = require(hdocBookProjectFilePath);
             hdocBookProjectFile.docId = docProps.id;
             fs.writeFile(hdocBookProjectFilePath, JSON.stringify(hdocBookProjectFile, null, 2), function writeJSON(err) {
-                if (err) return console.log('Error updating:', hdocBookProjectFilePath, '\r\n', err);
+                if (err) return console.error('Error updating:', hdocBookProjectFilePath, '\r\n', err);
                 console.log('Updated:', hdocBookProjectFilePath);
             });
 
@@ -92,7 +92,7 @@
                 "link": docProps.id + '/index'
             }];
             fs.writeFile(hdocBookFilePath, JSON.stringify(hdocbookFile, null, 2), function writeJSON(err) {
-                if (err) return console.log('Error updating:', hdocBookFilePath, '\r\n', err);
+                if (err) return console.error('Error updating:', hdocBookFilePath, '\r\n', err);
                 console.log('Updated:', hdocBookFilePath);
             });
 
@@ -105,7 +105,7 @@
             hdocbookFile.version = docProps.version;
             hdocbookFile.author = docProps.author;
             fs.writeFile(packageFilePath, JSON.stringify(packageFile, null, 2), function writeJSON(err) {
-                if (err) return console.log('Error updating:', packageFilePath, '\r\n', err);
+                if (err) return console.error('Error updating:', packageFilePath, '\r\n', err);
                 console.log('Updated:', packageFilePath);
             });
 

package/hdoc-module.js

@@ -25,7 +25,7 @@
         },
         onRetry: (retryCount, error, requestConfig) => {
             retried = true;
-            console.log(`\n[WARNING] API call failed - ${error.message}\nEndpoint: ${requestConfig.url}\nRetrying: ${retryCount}`);
+            console.info(`\n[WARNING] API call failed - ${error.message}\nEndpoint: ${requestConfig.url}\nRetrying: ${retryCount}`);
         },
     });
 

package/hdoc-validate.js

@@ -601,9 +601,9 @@
             console.log('   Validation Output   ');
             console.log('-----------------------');
             for (let i = 0; i < meta_errors.length; i++) {
-                console.log(`- ${meta_errors[i]}`);
+                console.error(`- ${meta_errors[i]}`);
             }
-            console.log(`\r\n${meta_errors.length} Validation Errors Found`);
+            console.error(`\r\n${meta_errors.length} Validation Errors Found`);
             return false;
         }
 
@@ -694,18 +694,18 @@
             let error_count = 0;
             for (const key in errors) {
                 if (errors.hasOwnProperty(key) && errors[key].length > 0) {
-                    console.log(`\r\n${errors[key].length} error(s) in ${key}`);
+                    console.error(`\r\n${errors[key].length} error(s) in ${key}`);
                     for (let i = 0; i < errors[key].length; i++) {
-                        console.log(` - ${errors[key][i]}`);
+                        console.error(` - ${errors[key][i]}`);
                         error_count++
                     }
                 }
             }
             if (error_count > 0) {
-                console.log(`\r\n${error_count} Validation Errors Found`);
+                console.error(`\r\n${error_count} Validation Errors Found`);
                 if (verbose) {
                     console.log(`\n`);
-                    console.log(JSON.stringify(exclude_spellcheck_output, null, 2));
+                    console.error(JSON.stringify(exclude_spellcheck_output, null, 2));
                 }
                 return false;
             }

package/hdoc-ver.js

@@ -13,9 +13,9 @@
         try {
             hdocbook_project = require(hdocbook_project_config_path);
         } catch (e) {
-            console.log('File not found: hdocbook-project.json:');
+            console.error('File not found: hdocbook-project.json:');
             console.log(e, '\n');
-            console.log('hdoc ver needs to be run in the root of a HDoc Book.\n');
+            console.error('hdoc ver needs to be run in the root of a HDoc Book.\n');
             process.exit(1);
         }
         const doc_id = hdocbook_project.docId;
@@ -27,15 +27,15 @@
         try {
             hdocbook_config = require(hdocbook_path);
         } catch (e) {
-            console.log('File not found: hdocbook.json');
+            console.error('File not found: hdocbook.json');
             console.log(e, '\n');
-            console.log('hdoc ver needs to be run in the root of a HDoc Book.\n');
+            console.error('hdoc ver needs to be run in the root of a HDoc Book.\n');
             process.exit(1);
         }
         if (hdocbook_config.version && hdocbook_config.version !== '') {
             console.log(`Book version: ${hdocbook_config.version}\n`);
         } else {
-            console.log(`Error - this book has no version defined.\n`);
+            console.error(`Error - this book has no version defined.\n`);
             process.exit(1);
         }
     };

package/package.json

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

package/ui/js/doc.hornbill.js

@@ -611,7 +611,6 @@ async function intialiseApp() {
     }).then(function () {
         // Get hdocbook.json
         fetchJsonFile("_books/" + view.docId + "/hdocbook.json").then(function (data) {
-            //console.log(view.docApp.library.books[0].nav_inline)
             view.docApp.book = data;
             view.bookId = data.docId;
             view.docApp.title = data.title || "";