hdoc-tools 0.9.39 → 0.9.41

package/hdoc-build.js

@@ -24,6 +24,7 @@
         non_git_pdf_header_template_path = path.join(__dirname, 'templates', 'pdf-header-non-git.html'),
         pdf_template_path = path.join(__dirname, 'templates', 'pdf'),
         pdf_template_file_path = path.join(pdf_template_path, 'template.html'),
+        regex_set_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{0,6}$/,
         regex_version = /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,6}$/;
 
     let bc = {}, // Breadcrumbs map
@@ -574,7 +575,7 @@
         sorted: true
     };
 
-    exports.run = async function (source_path, verbose_output, github_api_token, validate, build_version = '') {
+    exports.run = async function (source_path, verbose_output, github_api_token, validate, gen_exclude, build_version = '') {
         if (github_api_token !== '') {
             git_token = github_api_token;
         }
@@ -620,7 +621,11 @@
 
         hdocbook_config = require(hdocbook_path);
         if (build_version !== '')  {
-            hdocbook_config.version = build_version;
+            if (build_version.match(regex_version)) {
+                hdocbook_config.version = build_version;
+            } else {
+                console.log(`\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)) {
@@ -640,17 +645,19 @@
             prods_supported = prods.prods_supported;
         }
 
-        console.log('Caching CSS for PDF generation...');
-        const css_files = [
-            path.join(pdf_template_path, 'css', 'custom-block.css'),
-            path.join(pdf_template_path, 'css', 'hdocs-pdf.css'),
-            path.join(pdf_template_path, 'css', 'vars.css')
-        ];
-        for (let i = 0; i < css_files.length; i++) {
-            try {
-                css_templates.push(fs.readFileSync(css_files[i], 'utf8'));
-            } catch (e) {
-                console.log(`Error reading file [${css_files[i]}]: ${e}`);
+        if (!validate) {
+            console.log('Caching CSS for PDF generation...');
+            const css_files = [
+                path.join(pdf_template_path, 'css', 'custom-block.css'),
+                path.join(pdf_template_path, 'css', 'hdocs-pdf.css'),
+                path.join(pdf_template_path, 'css', 'vars.css')
+            ];
+            for (let i = 0; i < css_files.length; i++) {
+                try {
+                    css_templates.push(fs.readFileSync(css_files[i], 'utf8'));
+                } catch (e) {
+                    console.log(`Error reading file [${css_files[i]}]: ${e}`);
+                }
             }
         }
         
@@ -779,7 +786,7 @@
         }
 
         // Validate content
-        const validation_success = await hdoc_validate.run(work_path, doc_id, verbose, hdocbook_config, hdocbook_project, bc, prod_families, prods_supported);
+        const validation_success = await hdoc_validate.run(work_path, doc_id, verbose, hdocbook_config, hdocbook_project, bc, prod_families, prods_supported, gen_exclude);
         if (!validation_success) {
             const end_time = Date.now();
             console.log(`\nTime Taken: ${get_duration(start_time, end_time)}\n`);

package/hdoc-validate.js

@@ -30,11 +30,12 @@
         exclude_h1_count = {};
 
     const spellcheckContent = async function (sourceFile, excludes) {
+        let spelling_errors = {};
+        let words = [];
         const text = fs.readFileSync(sourceFile.path, 'utf8');
         const source_path = sourceFile.relativePath.replace('.' + sourceFile.extension, '');
         const translate_output = translator.translate(text, spellcheck_options);
         if (Object.keys(translate_output).length) {
-
             for (const key in translate_output) {
                 if (translate_output.hasOwnProperty(key)) {
                     let error_message = `Line ${key} - British spelling:`;
@@ -43,8 +44,10 @@
                             if (translate_output[key][i].hasOwnProperty(spelling) && (typeof translate_output[key][i][spelling].details === 'string')) {
                                 if (!excludes[source_path]) {
                                     errors[sourceFile.relativePath].push(`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`);
+                                    spelling_errors[spelling] = true;
                                 } else if (!excludes[source_path].includes(spelling.toLowerCase())) {
                                     errors[sourceFile.relativePath].push(`${error_message} ${spelling} should be ${translate_output[key][i][spelling].details}`);
+                                    spelling_errors[spelling] = true;
                                 }
                             }
                         }
@@ -52,7 +55,14 @@
                 }
             }
         }
-        return;
+        if (Object.keys(spelling_errors).length) {
+            for (const word in spelling_errors) {
+                if (spelling_errors.hasOwnProperty(word)) {
+                    words.push(word);
+                }
+            }
+        }
+        return words;
     };
 
     const checkNavigation = async function (source_path, flat_nav) {
@@ -322,7 +332,7 @@
         return links;
     };
 
-    exports.run = async function (source_path, doc_id, verbose, hdocbook_config, hdocbook_project, nav_items, prod_families, prods_supported) {
+    exports.run = async function (source_path, doc_id, verbose, hdocbook_config, hdocbook_project, nav_items, prod_families, prods_supported, gen_exclude) {
         console.log(`Performing Validation and Building SEO Link List...`);
         
         // Get a list of HTML files in source_path
@@ -378,6 +388,7 @@
             }
         }
 
+        let excl_output = [];
         
         // Do spellchecking on markdown files
         let md_files_spellchecked = {};
@@ -389,9 +400,9 @@
             mdPromiseArray.push(md_to_validate[i]);
         }
         await Promise.all(mdPromiseArray.map(async (file) => {
-            //await transform_markdown_and_save_html(file);
             // Initiate maps for errors and verbose messages for markdown file
-            await spellcheckContent(file, exclude_spellcheck);
+            const exclusions = await spellcheckContent(file, exclude_spellcheck);
+            if (gen_exclude && exclusions.length > 0) excl_output.push({document_path: file.relativePath.replace('.' + file.extension, ''), words: exclusions});
             md_files_spellchecked[file.relativePath.replace('.' + file.extension, '')] = true;
         }));
 
@@ -407,7 +418,8 @@
         await Promise.all(mdPromiseArray.map(async (file) => {
             // Check for British spellings in static HTML content
             if (!md_files_spellchecked[file.relativePath.replace('.' + file.extension, '')]) {
-                await spellcheckContent(file, exclude_spellcheck);
+                const exclusions = await spellcheckContent(file, exclude_spellcheck);
+                if (gen_exclude && exclusions.length > 0) excl_output.push({document_path: file.relativePath.replace('.' + file.extension, ''), words: exclusions});
             }
 
             const links = getLinks(file);
@@ -430,6 +442,7 @@
             listContent += '\r\n';
         }));
 
+        if (gen_exclude) console.log(JSON.stringify(excl_output, null, 2));
 
         try {
             // Write list
@@ -474,7 +487,7 @@
             }
         }
 
-        console.log(`\r\nNo Validation Errors Found!`);
+        console.log(`\r\nNo Validation Errors Found!\n`);
         return true;
     };
 })();

package/hdoc.js

@@ -28,7 +28,8 @@
    let   git_token = '',
          command = '', // Our command to run
          build_version = '',
-         verbose = false;
+         verbose = false,
+         gen_exclude = false; // To generate spellcheck exclusions for all files
 
    // Get options from command args
    for (let x = 0; x < process.argv.length; x++) {
@@ -63,6 +64,8 @@
          if (x < process.argv.length) {
             build_version = process.argv[x];
          }
+      } else if (process.argv[x] == '-e') {
+         gen_exclude = true;
       }
    }
    source_path = trueCasePathSync(source_path);
@@ -76,13 +79,13 @@
       server.run(ui_path, source_path);
    } else if (command == 'build') {
       const builder = require(path.join(__dirname, 'hdoc-build.js'));
-      await builder.run(source_path, verbose, git_token, false, build_version);
+      await builder.run(source_path, verbose, git_token, false, gen_exclude, build_version);
    } else if (command == 'createDocs') {
       const creator = require(path.join(__dirname, 'hdoc-create.js'));
       await creator.run(source_path);
    } else if (command == 'validate') {
       const builder = require(path.join(__dirname, 'hdoc-build.js'));
-      await builder.run(source_path, verbose, git_token, true);
+      await builder.run(source_path, verbose, git_token, true, gen_exclude, build_version);
    } else if (command == 'stats') {
       const stats = require(path.join(__dirname, 'hdoc-stats.js'));
       stats.run(ui_path, source_path, verbose);

package/package.json

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