hdoc-tools 0.8.49 → 0.9.0

package/hdoc-build-db.js

@@ -69,7 +69,7 @@
         return response;
     };
 
-    exports.populate_index = function (db, doc_id, book_config, index_records, verbose = false) {
+    exports.populate_index = async function (db, doc_id, book_config, index_records, verbose = false) {
         let response = {
             success: false,
             index_success_count: 0,
@@ -91,7 +91,7 @@
                 index_records[i].index_html.preview,
                 book_config.productFamily
             ];
-            const index_response = hdoc_index.insert_record(db, 'hdoc_index', db_schema.hdoc_index, index_vals);
+            const index_response = await  hdoc_index.insert_record(db, 'hdoc_index', db_schema.hdoc_index, index_vals);
             if (!index_response.success) {
                 console.log(`Index record creation failed - ${doc_id}/${index_records[i].index_html.fm_props.title}: ${index_response.error}`);
                 continue;
@@ -106,7 +106,7 @@
                 index_records[i].metadata.last_commit,
                 index_records[i].pdf_size
             ];
-            const meta_response = hdoc_index.insert_record(db, 'hdoc_meta', db_schema.hdoc_meta, meta_vals);
+            const meta_response = await hdoc_index.insert_record(db, 'hdoc_meta', db_schema.hdoc_meta, meta_vals);
             if (!meta_response.success) {
                 console.log(`Index metadata record creation failed - ${doc_id}/${index_response.row_id}/${index_records[i].index_html.fm_props.title}: ${meta_response.error}`);
                 continue;
@@ -126,7 +126,7 @@
                     index_records[i].contributors[j].avatar_url,
                     index_records[i].contributors[j].html_url
                 ];
-                const cont_response = hdoc_index.insert_record(db, 'hdoc_contributors', db_schema.hdoc_contributors, contrib_vals);
+                const cont_response = await hdoc_index.insert_record(db, 'hdoc_contributors', db_schema.hdoc_contributors, contrib_vals);
                 if (!cont_response.success) {
                     console.log(`Index document contributor record creation failed - ${doc_id}/${index_response.row_id}/${index_records[i].index_html.fm_props.title}: ${cont_response.error}`);
                     continue;

package/hdoc-build.js

@@ -7,7 +7,7 @@
         mdfm = require('markdown-it-front-matter'),
         path = require('path'),
         URL = require("url").URL,
-        validate = require(path.join(__dirname, 'hdoc-validate.js')),
+        hdoc_validate = require(path.join(__dirname, 'hdoc-validate.js')),
         hdoc = require(path.join(__dirname, 'hdoc-module.js')),
         hdoc_build_db = require(path.join(__dirname, 'hdoc-build-db.js')),
         hdoc_build_pdf = require(path.join(__dirname, 'hdoc-build-pdf.js')),
@@ -667,11 +667,12 @@
         }
     };
 
-    exports.run = async function (source_path, verbose_output, github_api_token) {
+    exports.run = async function (source_path, verbose_output, github_api_token, validate) {
         if (github_api_token !== '') {
             git_token = github_api_token;
         }
         verbose = verbose_output;
+
         // GERRY: The purpose of this function is to create a zip file containing the hdocbook content, 
         // * Create a _work folder 
         // * copy the hdocbook content to the work folder
@@ -691,7 +692,8 @@
         const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
         hdocbook_project = require(hdocbook_project_config_path);
         doc_id = hdocbook_project.docId;
-        if (hdocbook_project.pdfGeneration !== undefined && hdocbook_project.pdfGeneration.enable !== undefined) {
+
+        if (!validate && hdocbook_project.pdfGeneration !== undefined && hdocbook_project.pdfGeneration.enable !== undefined) {
             pdf_enable = hdocbook_project.pdfGeneration.enable;
         }
 
@@ -791,7 +793,7 @@
         console.log(`       Static HTML Files Found: ${static_html_files.length}\n`);
 
         // Validate content
-        const validation_success = await 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);
         if (!validation_success) {
             process.exit(1);
         }
@@ -814,22 +816,23 @@
             process.exit(1);
         }
 
-        const index = hdoc_build_db.populate_index(db.db, doc_id, hdocbook_config, index_records, verbose);
+        const index = await hdoc_build_db.populate_index(db.db, doc_id, hdocbook_config, index_records, verbose);
         if (!index.success) {
             console.log(index.error);
             process.exit(1);
         }
 
-        try {
-            const zip_path = path.join(work_path, doc_id + '.zip');
-            await zip(work_path_content, zip_path);
-            console.log(`\nZIP Creation Success: ${zip_path}\n`);
-            console.log('  Build Started:', build_start_dt);
-            console.log(`Build Completed: ${new Date().toLocaleString()}\n`);
-
-        } catch (e) {
-            console.log('\nError creating ZIP: ' + e);
+        if (!validate) {
+            try {
+                const zip_path = path.join(work_path, doc_id + '.zip');
+                await zip(work_path_content, zip_path);
+                console.log(`\nZIP Creation Success: ${zip_path}\n`);
+                console.log('  Build Started:', build_start_dt);
+                console.log(`Build Completed: ${new Date().toLocaleString()}\n`);
+    
+            } catch (e) {
+                console.log('\nError creating ZIP: ' + e);
+            }
         }
-
     };
 })();

package/hdoc-db.js

@@ -25,7 +25,7 @@
         }
     };
 
-    exports.insert_record = function (db, table, columns, values) {
+    exports.insert_record = async function (db, table, columns, values) {
         let response = {
             success: false,
             row_id: 0,

package/hdoc-validate.js

@@ -5,13 +5,17 @@
         cheerio = require('cheerio'),
         dree = require('dree'),
         fs = require('fs'),
+        html2text = require('html-to-text'),
         https = require('https'),
         path = require('path'),
-        hdoc = require(path.join(__dirname, 'hdoc-module.js'));
+        hdoc = require(path.join(__dirname, 'hdoc-module.js')),
+        translator = require('american-british-english-translator');
 
-        const agent = new https.Agent({  
-            rejectUnauthorized: false
-        });
+    const agent = new https.Agent({  
+        rejectUnauthorized: false
+    });
+    
+    let prod_families = {};
 
     let errors = {},
         messages = {},
@@ -20,6 +24,48 @@
         html_files = [],
         exclude_links = {};
 
+    const load_product_families = async function() {
+        try {
+            const prods = await axios.get('https://docs.hornbill.com/_books/products.json', { httpsAgent: agent });
+            if (prods.status === 200) {
+                prod_families = prods.data;
+            } else {
+                throw `Unexpected Status ${prods.status}`;
+            }
+        } catch (e) {
+            // Handle errors
+            console.log(`Error returning product families: ${e}`);
+            return false;
+        }
+        return true;
+    };
+
+    const checkBritishSpellings = async function (htmlFile) {
+        const htmlBody = fs.readFileSync(htmlFile.path, 'utf8');
+        const text = html2text.convert(htmlBody, {
+            wordwrap: null
+        });
+
+        var options = {
+            british: true,
+            spelling: true
+        };
+        const translate_output = translator.translate(text, 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:`;
+                    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}`);
+                            }
+                        }
+                    }
+                }
+            }      
+        }
+    };
 
     const checkLinks = async function (source_path, htmlFile, links, hdocbook_config) {
         for (let i = 0; i < links.length; i++) {
@@ -40,10 +86,15 @@
                 if (valid_url.protocol === 'mailto:') {
                     continue;
                 }
+
                 // Skip if the link is excluded in the project config
                 if (exclude_links[links[i]]) {
                     continue;
                 }
+                if (links[i].toLowerCase().includes('docs.hornbill.com') || links[i].toLowerCase().includes('docs-internal.hornbill.com')) {
+                    errors[htmlFile.relativePath].push(`Links to Hornbill Docs should rooted and not fully-qualified: ${links[i]}`);
+                    continue;
+                }
 
                 try {
                     await axios.get(links[i], { httpsAgent: agent });
@@ -172,16 +223,37 @@
     };
 
     exports.run = async function (source_path, doc_id, verbose, hdocbook_config, hdocbook_project) {
+        console.log(`Performing Validation and Building SEO Link List...`);
+
+        // Load product families
+        await load_product_families();
+
         // Get a list of HTML files in source_path
         dree.scan(source_path, dreeOptions, fileCallback);
 
+        // Check product family
+        let valid_product = false;
+        for (let i = 0; i < prod_families.products.length; i++) {
+            if (prod_families.products[i].id === hdocbook_config.productFamily) {
+                valid_product = true;
+            } 
+        }
+        if (!valid_product) {
+            console.log('\r\n-----------------------');
+            console.log('   Validation Output   ');
+            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;
             });
         }
 
-        console.log(`Performing Validation and Building SEO Link List...`);
 
         let listContent = '';
         for (let i = 0; i < html_files.length; i++) {
@@ -191,6 +263,9 @@
             messages[html_files[i].relativePath] = [];
             warnings[html_files[i].relativePath] = [];
 
+            // Check for Britishisms
+            await checkBritishSpellings(html_files[i]);
+
             const links = getLinks(html_files[i]);
             if (links.href.length === 0) {
                 messages[html_files[i].relativePath].push('No links found in file');

package/hdoc.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 (async function () {
    'use strict';
 
@@ -68,7 +68,10 @@
       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);
+      await builder.run(source_path, verbose, git_token, false);
+   } else if (command == 'validate') {
+      const builder = require(path.join(__dirname, 'hdoc-build.js'));
+      await builder.run(source_path, verbose, git_token, true);
    } 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.8.49",
+  "version": "0.9.0",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -30,6 +30,7 @@
   "author": "Hornbill Technologies Ltd",
   "license": "ISC",
   "dependencies": {
+    "american-british-english-translator": "^0.2.1",
     "axios": "^1.3.2",
     "better-sqlite3": "^8.0.1",
     "body-parser": "^1.20.1",