hdoc-tools 0.9.21 → 0.9.23

package/hdoc-build-db.js

@@ -50,7 +50,7 @@
             error: null,
             db: null
         };
-        console.log('Performing SQlite index creation...');
+        console.log('\nPerforming SQlite index creation...');
         let db_name = path.join(db_path, doc_id, 'index.db');
         response.db = new database(db_name);
         response.db.pragma('encoding="UTF-8"');
@@ -142,8 +142,7 @@
             
         }
         response.success = true;
-        console.log(`\nIndex Build Complete:`);
-        console.log(`${response.index_success_count} document index records created.`);
+        console.log(`\nIndex Build Complete: ${response.index_success_count} document index records created.`);
         return response;
     };
 })();

package/hdoc-build.js

@@ -35,6 +35,7 @@
         conversion_failed = 0,
         doc_header_template = '',
         doc_header_template_non_git = '',
+        pdf_created = 0,
         pdf_enable = false,
         pdf_header_template = '',
         pdf_header_template_non_git = '',
@@ -242,6 +243,7 @@
                 const pdf_file_path = file_path.path.replace(path.extname(file_path.path), '.pdf');
                 pdf_size = await hdoc_build_pdf.generate_pdf(browser, pdf_template_path, pdf_template, hdocbook_config, pdf_txt, pdf_file_path, verbose);
             }
+            if (pdf_size > 0) pdf_created++;
 
             html_txt = `${fm_header_content}\n${doc_header}\n${html_txt}`;
 
@@ -452,7 +454,7 @@
                 const pdf_file_path = file_path.path.replace(path.extname(file_path.path), '.pdf');
                 pdf_size = await hdoc_build_pdf.generate_pdf(browser, pdf_template_path, pdf_template, hdocbook_config, pdf_txt, pdf_file_path, verbose);
             }
-
+            if (pdf_size > 0) pdf_created++;
             html_txt = `${fm_header}\n${doc_header}\n${html_txt}`;
 
             // Save HTML into HTML file
@@ -712,13 +714,16 @@
         }
 
         // Output to console
-        console.log(`                MD files found: ${conversion_attempted}`);
+        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.log(`                Includes Found: ${includes_found}`);
         console.log(`              Includes Success: ${includes_success}`);
         console.log(`               Includes Failed: ${includes_failed}\n`);
         console.log(`       Static HTML Files Found: ${static_html_files.length}\n`);
+        if (!validate) {
+            console.log(`             PDF Files Created: ${pdf_created}\n`);
+        }
 
         // Validate content
         const validation_success = await hdoc_validate.run(work_path, doc_id, verbose, hdocbook_config, hdocbook_project, bc);

package/hdoc-validate.js

@@ -26,11 +26,11 @@
     let errors = {},
         messages = {},
         warnings = {},
-        errorcount = 0,
         html_to_validate = [],
         md_to_validate = [],
         exclude_links = {},
-        exclude_spellcheck = {};
+        exclude_spellcheck = {},
+        exclude_h1_count = {};
 
     const load_product_families = async function () {
         try {
@@ -224,15 +224,18 @@
     };
 
     const checkTags = async function (htmlFile) {
+        // Check if file  is excluded from tag check
+        const file_no_ext = htmlFile.relativePath.replace(path.extname(htmlFile.relativePath), '');
+        if (exclude_h1_count[file_no_ext]) return;
+
+        // Check tags
         const htmlBody = fs.readFileSync(htmlFile.path, 'utf8');
         const $ = cheerio.load(htmlBody);
 
         const h1_tags = $('h1').map(function () {
             return $(this);
         }).get();
-
         if (h1_tags.length && h1_tags.length > 1) {
-            //console.log("PATH: ", htmlFile.path); //hdoc-guide/hdocbook/markdown.html
             let error_msg = `${h1_tags.length} <h1> tags found in content: `;
             for (let i = 0; i < h1_tags.length; i++) {
                 error_msg += h1_tags[i].text();
@@ -374,10 +377,10 @@
             console.log('\r\n-----------------------');
             console.log('   Validation Output   ');
             console.log('-----------------------');
-            console.log(`\r\n${meta_errors.length} Validation Errors Found\r\n`);
             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;
         }
 
@@ -392,6 +395,11 @@
                     exclude_spellcheck[excl_sc.document_path] = excl_sc.words;
                 });
             }
+            if (hdocbook_project.validation.exclude_h1_count && hdocbook_project.validation.exclude_h1_count instanceof Array) {
+                hdocbook_project.validation.exclude_h1_count.forEach(function (excl_h1) {
+                    exclude_h1_count[excl_h1] = true;
+                });
+            }
         }
 
         // Do spellchecking on markdown files
@@ -434,7 +442,7 @@
 
             // Check for multiple H1 tags
             await checkTags(html_to_validate[i]);
-
+            
             // Build list content for Google 
             listContent += `/${html_to_validate[i].relativePath.replace(path.extname(html_to_validate[i].relativePath), '')}`;
             if (i < html_to_validate.length - 1) {
@@ -467,21 +475,24 @@
         console.log('\r\n-----------------------');
         console.log('   Validation Output   ');
         console.log('-----------------------');
-        if (errorcount > 0) {
-            console.log(`\r\n${errorcount} Validation Errors Found\r\n`);
+        if (Object.keys(errors).length > 0) {
+            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}`);
                     for (let i = 0; i < errors[key].length; i++) {
                         console.log(` - ${errors[key][i]}`);
-                        errorcount++;
+                        error_count++
                     }
                 }
             }
-            return false;
+            if (error_count > 0) {
+                console.log(`\r\n${error_count} Validation Errors Found`);
+                return false;
+            }
         }
 
-        console.log(`\r\nNo Validation Errors Found!\r\n`);
+        console.log(`\r\nNo Validation Errors Found!`);
         return true;
     };
 })();

package/package.json

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

package/ui/index.html

@@ -99,14 +99,14 @@
                         <i v-bind:class="{'bi bi-chevron-right': !asection.expand,'bi bi-chevron-down': asection.expand}" class="bi"></i>
                     </div>
                 </div>
-                <a class="title-text">{{asection.text}}</a>
+                <a class="title-text"><i v-if="asection.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This section is set to draft."></i> {{asection.text}}</a>
             </div>
             <div v-show="asection.expand && asection.items" v-for="(navSectionItem, index) in asection.items" class="items">
 
                 <!-- if navSectionItem has no items show clickable link -->
                 <div v-if="!navSectionItem.items">
                     <a class="DocLink link noitems" v-bind:href="navSectionItem.link" v-bind:target="navSectionItem.target || ''" style="padding-left: 0px;">
-                        <span class="link-text">{{navSectionItem.text}} <i v-if="navSectionItem.target" class="bi bi-box-arrow-up-right"></i> </span>
+                        <span class="link-text"><i v-if="navSectionItem.draft" class="bi bi-exclamation-triangle-fill text-danger" title="This page is set to draft."></i> {{navSectionItem.text}} <i v-if="navSectionItem.target" class="bi bi-box-arrow-up-right"></i> </span>
                     </a>
                 </div>