hdoc-tools 0.17.16 → 0.17.18

package/README.md

@@ -37,6 +37,8 @@ Returns statistics regarding the book you are working on:
 
 If the -v switch is provided, then more verbose output is output, which includes a list of each MD and HTML file found, the file sizes, and file-specific word count.
 
+The book statistics do not include counts for any externally hosted content injected into the book content using the [[INCLUDE]] tags.
+
 ### build
 
 Performs a local build of the book, validates the links and static content are present and correct and outputs as a ZIP file.

package/hdoc-build-db.js

@@ -115,7 +115,10 @@
             indexPromises.push(index_records[i]);
         }
         await Promise.all(indexPromises.map(async (file) => {
-            let index_path_name = file.relative_path.replace('\\', '/');
+            let index_path_name = file.relative_path.replaceAll('\\', '/');
+            if (index_path_name.endsWith('/index.md') || index_path_name.endsWith('/index.html') || index_path_name.endsWith('/index.htm')) {
+                index_path_name = index_path_name.substring(0, index_path_name.lastIndexOf('/'));
+            }
             index_path_name = '/' + index_path_name.replace(path.extname(file.relative_path), '');
             let index_response = {
                 success: true,

package/hdoc-build.js

@@ -90,6 +90,8 @@
             let fm_headers = [];
             let existing_fm_headers = false;
             let doc_type = 'Article';
+            let doc_title = '',
+                doc_description = '';
 
             // Check if we have a frontmatter comment
             const fm_header = hdoc.getHTMLFrontmatterHeader(html_txt);
@@ -106,6 +108,7 @@
                     } else {
                         // We have a value for the title property
                         fm_title_found = true;
+                        doc_title = fm_header.fm_properties.title.trim();
                     }
                 }
 
@@ -139,15 +142,42 @@
                             id: 'title',
                             value: html_heading[0].children[0].data
                         });
+                        doc_title = html_heading[0].children[0].data;
                     } else {
                         // No header tag, no frontmatter title, output a warning 
                         console.log(`[WARNING] No frontmatter title property, or ${h_tags_to_search.join(', ')} tags detected in ${file_path.path}`);
                     }
                 }
+
+                // Do we have a description header?
+                if (fm_header.fm_properties && fm_header.fm_properties.description !== undefined) {
+                    if (fm_header.fm_properties.description === '') {
+                        const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ['p']);
+                        if (html_p_tag && html_p_tag[0] && html_p_tag[0].children && html_p_tag[0].children[0] && html_p_tag[0].children[0].data) {
+                            fm_headers.push({
+                                id: 'description',
+                                value: `${doc_title}: ${html_p_tag[0].children[0].data.split('.')[0] + '.'}`.trim()
+                            });
+                        }
+                    } else {
+                        fm_headers.push({
+                            id: 'description',
+                            value: fm_header.fm_properties.description.trim()
+                        });
+                    }
+                } else {
+                    const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ['p']);
+                    if (html_p_tag && html_p_tag[0] && html_p_tag[0].children && html_p_tag[0].children[0] && html_p_tag[0].children[0].data) {
+                        fm_headers.push({
+                            id: 'description',
+                            value: `${doc_title}: ${html_p_tag[0].children[0].data.split('.')[0] + '.'}`.trim()
+                        });
+                    }
+                }
             } else {
                 // We have no frontmatter headers, get and build one from the html headings
                 const html_heading = hdoc.getFirstHTMLHeading(html_txt, h_tags_to_search);
-
+                let doc_title = '';
                 // Add the title
                 if (html_heading && html_heading[0] && html_heading[0].children && html_heading[0].children[0] && html_heading[0].children[0].data) {
                     // We've found a heading tag, add that as a title to the frontmatter content
@@ -155,6 +185,7 @@
                         id: 'title',
                         value: html_heading[0].children[0].data
                     });
+                    doc_title = html_heading[0].children[0].data;
                 } else if (file_path.name !== 'description_ext.md' && file_path.name !== 'article_ext.md') {
                     // No header tag, no frontmatter title, output a warning 
                     console.log(`[WARNING] No frontmatter title property, or ${h_tags_to_search.join(', ')} tags detected in ${file_path.path}`);
@@ -167,6 +198,14 @@
                     id: 'reading-time',
                     value: read_time_mins
                 });
+
+                const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ['p']);
+                if (html_p_tag && html_p_tag[0] && html_p_tag[0].children && html_p_tag[0].children[0] && html_p_tag[0].children[0].data) {
+                    fm_headers.push({
+                        id: 'description',
+                        value: `${doc_title}: ${html_p_tag[0].children[0].data.split('.')[0] + '.'}`.trim()
+                    });
+                }
             }
 
             // Add doc type
@@ -357,6 +396,7 @@
 
             let fm_contains_title = false,
                 fm_contains_reading_time = false,
+                fm_contains_description = false,
                 doc_title = '',
                 doc_type = 'Article';
 
@@ -382,6 +422,9 @@
                             book_read_time += parseInt(fm_val.trim(), 10);
                             fm_contains_reading_time = true;
                         }
+                        if (fm_id.trim() === 'description') {
+                            fm_contains_description = true;
+                        }
                     }
                 });
             }
@@ -389,7 +432,7 @@
             // Add doc type
             fm_headers.push({
                 id: 'type',
-                value: doc_type
+                value: doc_type,
             });
 
             // Does frontmatter tag contain a title property
@@ -410,6 +453,17 @@
                 }
             }
 
+            // Does frontmatter contain a description header, generate one if not
+            if (!fm_contains_description) {
+                const html_p_tag = hdoc.getFirstHTMLHeading(html_txt, ['p']);
+                if (html_p_tag && html_p_tag[0] && html_p_tag[0].children && html_p_tag[0].children[0] && html_p_tag[0].children[0].data) {
+                    fm_headers.push({
+                        id: 'description',
+                        value: `${doc_title}: ${html_p_tag[0].children[0].data.split('.')[0] + '.'}`
+                    });
+                }
+            }
+
             // Does frontmatter tag contain a reading-time property
             if (!fm_contains_reading_time) {
                 const read_time_mins = hdoc.get_html_read_time(html_txt);

package/hdoc-help.js

@@ -27,7 +27,8 @@ Commands
     Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
 
  - stats
-    Returns statistics regarding the book you are working on. Supports a -v switch for verbose output
+    Returns statistics regarding the book you are working on. Supports a -v switch for verbose output.
+    The book statistics do not include counts for any externally hosted content injected into the book content using the [[INCLUDE]] tags.
 
  - validate
     Validates the book content

package/hdoc-validate.js

@@ -86,6 +86,77 @@
         return words;
     };
 
+    const checkInline = async function (source_path, inline, excludes) {
+        let inline_errors = [];
+        for (let i = 0; i < inline.length; i++) {
+            const title = inline[i].title,
+                link = inline[i].link;
+
+            // Validate link segment spellings
+            const paths = link.split('/');
+            for (let i = 0; i < paths.length; i++) {
+                const path_words = paths[i].split('-');
+                for (let j = 0; j < path_words.length; j++) {
+                    const translate_output = translator.translate(path_words[j], spellcheck_options);
+                    if (Object.keys(translate_output).length) {
+                        for (const spell_val in translate_output) {
+                            if (translate_output.hasOwnProperty(spell_val)) {
+                                for (const spelling in translate_output[spell_val][0]) {
+                                    if (translate_output[spell_val][0].hasOwnProperty(spelling)) {
+                                        if (!excludes[link]) {
+                                            inline_errors.push(`Inline Link [${link}] contains a British English spelling: ${spelling} should be ${translate_output[spell_val][0][spelling].details}`);
+                                        } else if (!excludes[link].includes(spelling.toLowerCase())) {
+                                            inline_errors.push(`Inline Link [${link}] contains a British English spelling: ${spelling} should be ${translate_output[spell_val][0][spelling].details}`);
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+
+            // Validate display names
+            const translate_output = translator.translate(title, spellcheck_options);
+            if (Object.keys(translate_output).length) {
+                for (const spell_val in translate_output) {
+                    if (translate_output.hasOwnProperty(spell_val)) {
+                        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)) {
+                                    if (!excludes[link]) {
+                                        inline_errors.push(`Inline title for link [${link}] contains a British English spelling: ${spelling} should be ${translate_output[spell_val][j][spelling].details}`);
+                                    } else if (!excludes[link].includes(spelling.toLowerCase())) {
+                                        inline_errors.push(`Inline title for link [${link}] contains a British English spelling: ${spelling} should be ${translate_output[spell_val][j][spelling].details}`);
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+
+            // Validate path exists - link should be a html file at this point as its after the content has been built
+            let file_exists = true;
+            let file_name = path.join(source_path, link + '.html');
+            if (!fs.existsSync(file_name)) {
+                file_name = path.join(source_path, link + '.htm');
+                if (!fs.existsSync(file_name)) {
+                    file_name = path.join(source_path, link, 'index.html');
+                    if (!fs.existsSync(file_name)) {
+                        file_name = path.join(source_path, link, 'index.htm');
+                        if (!fs.existsSync(file_name)) {
+                            file_exists = false;
+                            inline_errors.push(`Inline link [${link}] file does not exist.`);
+                        }
+                    }
+                }
+            }
+        }
+
+        return inline_errors;
+    };
+
     const checkNavigation = async function (source_path, flat_nav, excludes) {
         let nav_errors = [];
         for (let key in flat_nav) {
@@ -506,10 +577,16 @@
             }
         }
 
-        // Check navigation spellings
+        // Check navigation spellings & paths exist
         const nav_errors = await checkNavigation(source_path, nav_items, exclude_spellcheck);
         if (nav_errors.length > 0) meta_errors.push(...nav_errors);
 
+        // Check inline content spellings & paths exist
+        if (hdocbook_config.inline && hdocbook_config.inline.length > 0) {
+            const inline_errors = await checkInline(source_path, hdocbook_config.inline, exclude_spellcheck);
+            if (inline_errors.length > 0) meta_errors.push(...inline_errors);
+        }
+
         // Check redirects
         const redirect_errors = await checkRedirects(source_path);
         if (redirect_errors.length > 0) meta_errors.push(...redirect_errors);

package/package.json

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