hdoc-tools 0.9.1 → 0.9.3

package/hdoc-build.js

@@ -793,7 +793,7 @@
         console.log(`       Static HTML Files Found: ${static_html_files.length}\n`);
 
         // Validate content
-        const validation_success = await hdoc_validate.run(work_path, doc_id, verbose, hdocbook_config, hdocbook_project);
+        const validation_success = await hdoc_validate.run(work_path, doc_id, verbose, hdocbook_config, hdocbook_project, bc);
         if (!validation_success) {
             process.exit(1);
         }

package/hdoc-validate.js

@@ -22,7 +22,8 @@
         warnings = {},
         errorcount = 0,
         html_files = [],
-        exclude_links = {};
+        exclude_links = {},
+        exclude_spellcheck = {};
 
     const load_product_families = async function() {
         try {
@@ -40,16 +41,19 @@
         return true;
     };
 
-    const checkBritishSpellings = async function (htmlFile) {
-        const htmlBody = fs.readFileSync(htmlFile.path, 'utf8');
-        const text = html2text.convert(htmlBody, {
-            wordwrap: null
-        });
-
+    const checkBritishSpelling = async function(source, excludes, text) {
+        if (!errors[source]) errors[source] = [];
         var options = {
             british: true,
             spelling: true
         };
+
+        let rel_source = source.replaceAll('\\', '/');
+        rel_source = rel_source.substring(0, rel_source.length - path.extname(source).length); 
+        if (rel_source.includes('/_work/')) {
+            rel_source = rel_source.split('/_work/')[1];
+        }
+        
         const translate_output = translator.translate(text, options);
         if(Object.keys(translate_output).length){
             for (const key in translate_output) {
@@ -58,7 +62,11 @@
                     for (let i = 0; i < translate_output[key].length; i++) {
                         for (const spelling in translate_output[key][i]) {
                             if (translate_output[key][i].hasOwnProperty(spelling)) {
-                                errors[htmlFile.relativePath].push(`${error_message} ${spelling}`);
+                                if (!excludes[rel_source]) {
+                                    errors[source].push(`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`);
+                                } else if (!excludes[rel_source].includes(spelling.toLowerCase())) {
+                                    errors[source].push(`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`);
+                                }
                             }
                         }
                     }
@@ -67,6 +75,14 @@
         }
     };
 
+    const checkBritishSpellings = async function (htmlFile, excludes) {
+        const htmlBody = fs.readFileSync(htmlFile.path, 'utf8');
+        const text = html2text.convert(htmlBody, {
+            wordwrap: null
+        });
+        checkBritishSpelling(htmlFile.path, excludes, text);
+    };
+
     const checkLinks = async function (source_path, htmlFile, links, hdocbook_config) {
         for (let i = 0; i < links.length; i++) {
 
@@ -74,6 +90,10 @@
             const valid_url = hdoc.valid_url(links[i]);
             if (!valid_url) {
                 // Could be a relative path, check
+                if (links[i].startsWith('/')) {
+                    const link_root = links[i].split('/')[0];
+                    if (link_root !== hdocbook_config.docId) continue;
+                }
                 isRelativePath(source_path, htmlFile, links[i]);
             } else {
                 messages[htmlFile.relativePath].push(`Link is a properly formatted external URL: ${links[i]}`);
@@ -222,7 +242,7 @@
         return links;
     };
 
-    exports.run = async function (source_path, doc_id, verbose, hdocbook_config, hdocbook_project) {
+    exports.run = async function (source_path, doc_id, verbose, hdocbook_config, hdocbook_project, nav_items) {
         console.log(`Performing Validation and Building SEO Link List...`);
 
         // Load product families
@@ -244,16 +264,21 @@
             console.log('-----------------------\r\n');
             console.log(`- Incorrect productFamily: ${hdocbook_config.productFamily}`)
             console.log(`\r\n1 Validation Errors Found\r\n`);
-            console.log(``)
             return false;
         }
 
-        if (hdocbook_project.validation && 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;
+        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;
+               });
+           }
+           if (hdocbook_project.validation.exclude_spellcheck && hdocbook_project.validation.exclude_spellcheck instanceof Array) {
+            hdocbook_project.validation.exclude_spellcheck.forEach(function(excl_sc) {
+                exclude_spellcheck[excl_sc.document_path] = excl_sc.words;
             });
         }
-
+        }
 
         let listContent = '';
         for (let i = 0; i < html_files.length; i++) {
@@ -264,7 +289,7 @@
             warnings[html_files[i].relativePath] = [];
 
             // Check for Britishisms
-            await checkBritishSpellings(html_files[i]);
+            await checkBritishSpellings(html_files[i], exclude_spellcheck);
 
             const links = getLinks(html_files[i]);
             if (links.href.length === 0) {

package/package.json

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