hdoc-tools 0.9.55 → 0.10.0

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}`);
+                                                }
                                             }
                                         }
                                     }
@@ -384,28 +399,13 @@
                 // Check URL exists
                 if (!hdocbook_config.publicSource.startsWith('https://github.com') && !hdocbook_config.publicSource.startsWith('https://api.github.com')) {
                     meta_errors.push(`Value for publicSource in book metadata is not a recognised GitHub URL: ${hdocbook_config.publicSource}`);
-                } else {
-                    // 
                 }
             }
-
         }
 
-        // 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_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.`);
         }
-
         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) {
@@ -424,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
@@ -519,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.9.55",
+  "version": "0.10.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){