hdoc-tools 0.9.56 → 0.11.0

package/hdoc-help.js

@@ -1,10 +1,10 @@
 (function () {
-    'use strict';
+   'use strict';
 
-    exports.run = function() {
-        
-        // STEVE: The purpose of this function is to output information about hdoc arguments
-        const helpText = `
+   exports.run = function () {
+
+      // STEVE: The purpose of this function is to output information about hdoc arguments
+      const helpText = `
 Command Line Usage
 
     hdoc <command> [switches]
@@ -32,10 +32,16 @@ Commands
  - validate
     Validates the book content
 
+ - bump
+    Updates the semantic version number of the current book. If no options are specified, then the default of patch is applied:
+    - major - updates the major version of the book. i.e. - 1.4.5 would become 2.0.0
+    - minor - updates the minor version of the book. i.e. - 1.4.5 would become 1.5.0
+    - patch (default) - updates the patch version of the book. i.e. - 1.4.5 would become 1.4.6
+
 Example
 
     hdoc stats -v
 `;
-        console.log(helpText);
-    };
+      console.log(helpText);
+   };
 })();

package/hdoc-validate.js

@@ -27,7 +27,8 @@
         md_to_validate = [],
         exclude_links = {},
         exclude_spellcheck = {},
-        exclude_h1_count = {};
+        exclude_h1_count = {},
+        exclude_spellcheck_output = [];
 
     const excludeLink = async function (url) {
         if (exclude_links[url]) return true;
@@ -69,16 +70,22 @@
             }
         }
         if (Object.keys(spelling_errors).length) {
+            let exclude_output = {
+                document_path: sourceFile.relativePath.replace(path.extname(sourceFile.relativePath), ''),
+                words: []
+            };
             for (const word in spelling_errors) {
                 if (spelling_errors.hasOwnProperty(word)) {
                     words.push(word);
+                    exclude_output.words.push(word);
                 }
             }
+            exclude_spellcheck_output.push(exclude_output);
         }
         return words;
     };
 
-    const checkNavigation = async function (source_path, flat_nav) {
+    const checkNavigation = async function (source_path, flat_nav, excludes) {
         let nav_errors = [];
         for (let key in flat_nav) {
             if (flat_nav.hasOwnProperty(key)) {
@@ -126,7 +133,11 @@
                                 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}`);
+                                            if (!excludes[key]) {
+                                                nav_errors.push(`Navigation path [${key}] key contains a British English spelling: ${spelling} should be ${translate_output[spell_val][0][spelling].details}`);
+                                            } else if (!excludes[key].includes(spelling.toLowerCase())) {
+                                                nav_errors.push(`Navigation path [${key}] key contains a British English spelling: ${spelling} should be ${translate_output[spell_val][0][spelling].details}`);
+                                            }
                                         }
                                     }
                                 }
@@ -145,7 +156,11 @@
                                     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}`);
+                                                if (!excludes[key]) {
+                                                    nav_errors.push(`Navigation path [${key}] display text contains a British English spelling: ${spelling} should be ${translate_output[spell_val][j][spelling].details}`);
+                                                } else if (!excludes[key].includes(spelling.toLowerCase())) {
+                                                    nav_errors.push(`Navigation path [${key}] display text contains a British English spelling: ${spelling} should be ${translate_output[spell_val][j][spelling].details}`);
+                                                }
                                             }
                                         }
                                     }
@@ -391,22 +406,6 @@
         if (!hdocbook_config.audience || !(hdocbook_config.audience instanceof Array) || hdocbook_config.audience.length === 0) {
             meta_errors.push(`Property audience of type array in book metadata is mandatory.`);
         }
-
-        // Check navigation spellings
-        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('-----------------------');
-            for (let i = 0; i < meta_errors.length; i++) {
-                console.log(`- ${meta_errors[i]}`);
-            }
-            console.log(`\r\n${meta_errors.length} Validation Errors Found`);
-            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) {
@@ -425,6 +424,22 @@
             }
         }
 
+        // Check navigation spellings
+        const nav_errors = await checkNavigation(source_path, nav_items, exclude_spellcheck);
+        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('-----------------------');
+            for (let i = 0; i < meta_errors.length; i++) {
+                console.log(`- ${meta_errors[i]}`);
+            }
+            console.log(`\r\n${meta_errors.length} Validation Errors Found`);
+            return false;
+        }
+
+
         let excl_output = [];
 
         // Do spellchecking on markdown files
@@ -520,6 +535,10 @@
             }
             if (error_count > 0) {
                 console.log(`\r\n${error_count} Validation Errors Found`);
+                if (verbose) {
+                    console.log(`\n`);
+                    console.log(JSON.stringify(exclude_spellcheck_output, null, 2));
+                }
                 return false;
             }
         }

package/hdoc.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 (async function () {
    'use strict';
 
@@ -25,11 +25,12 @@
    // Default source path to working directory
    let source_path = process.cwd();
    let ui_path = path.join(__dirname, 'ui');
-   let   git_token = '',
-         command = '', // Our command to run
-         build_version = '',
-         verbose = false,
-         gen_exclude = false; // To generate spellcheck exclusions for all files
+   let git_token = '',
+      command = '', // Our command to run
+      build_version = '',
+      verbose = false,
+      gen_exclude = false,
+      bump_type = 'patch'; // To generate spellcheck exclusions for all files
 
    // Get options from command args
    for (let x = 0; x < process.argv.length; x++) {
@@ -39,6 +40,13 @@
       // Third argument is command
       if (x == 2) {
          command = process.argv[x];
+
+         if (command === 'bump') {
+            x++;
+            if (x < process.argv.length) {
+               bump_type = process.argv[x];
+            }
+         }
          continue;
       }
 
@@ -95,6 +103,9 @@
    } else if (command == 'help') {
       const help = require(path.join(__dirname, 'hdoc-help.js'));
       help.run();
+   } else if (command == 'bump') {
+      const bump = require(path.join(__dirname, 'hdoc-bump.js'));
+      bump.run(source_path, bump_type);
    } else {
       console.log('Unknown command:', command, '\r\n');
       console.log('Run hdoc help for information regarding this tool.\r\n');

package/package.json

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

package/ui/css/theme-default/styles/components/content.css

@@ -64,7 +64,11 @@
 /* eof nav tabs in doc content */
 
 
-
+.DocContent .code-badge-pre
+{
+  max-width: 100%!important;
+  min-width: 100%!important;
+}
 
 @media (min-width: 1000px) {
   
@@ -117,3 +121,4 @@
     width:100%;
     display:table;
 }
+

package/ui/css/theme-default/styles/components/htl-doc.css

@@ -723,4 +723,19 @@
    content: "/";
    padding-left: 5px;
    padding-right: 5px;
- }
+ }
+
+
+ 
+/* lighter bg for code blocks */
+.HTL-doc .hljs
+{
+  background: #494949;
+  width: 100%;
+}
+
+.dark .HTL-doc .hljs
+{
+  background: #000000;
+  width: 100%;
+}

package/ui/js/doc.hornbill.js

@@ -642,6 +642,7 @@ async function intialiseApp() {
 
 
     //-- get session info
+    /*
     let dummyResponse = {
         "type": "user",
         "userId": "doom-guy",
@@ -653,6 +654,7 @@ async function intialiseApp() {
         "validUntil": "2023-07-30 06:33:49Z"
     }
     dummyResponse.expiresDateTime = new Date(dummyResponse.validUntil).toLocaleDateString() + ' ' + new Date(dummyResponse.validUntil).toLocaleTimeString();
+    */
 
     fetchJsonFile("_api/session/").then(function(sessionData)
     {  
@@ -665,6 +667,7 @@ async function intialiseApp() {
             view.setSessionInfo(sessionData);
         }
     });
+
     //-- eof session stuff
 
     await fetchJsonFile("_books/library.json").then(function(data){