hdoc-tools 0.11.6 → 0.11.7

package/hdoc-build.js

@@ -36,6 +36,7 @@
         css_templates = [],
         doc_header_template = '',
         doc_header_template_non_git = '',
+        global_source_path = '',
         pdf_created = 0,
         pdf_enable = false,
         pdf_header_template = '',
@@ -474,7 +475,7 @@
                 contributors: contribs,
                 pdf_size: pdf_size,
                 md5: file_path.hash,
-                lastmod: file_path.stat.mtime.toISOString()
+                lastmod: file_path.hb_lastmod
             });
 
             // Add MD file to delete queue
@@ -538,6 +539,9 @@
     // File callback for build scan
     const build_file_callback = function (element) {
         if (element.extension === 'md') {
+            element.hb_source_path = path.join(global_source_path, element.relativePath);
+            const fstats = fs.statSync(element.hb_source_path);
+            element.hb_lastmod = `${fstats.mtime.toISOString().slice(0, 19)}Z`;
             md_files.push(element);
         } else {
             // File is html, see if there's a matching md file and if there is then ignore the html
@@ -545,6 +549,9 @@
             if (fs.existsSync(md_path)) {
                 return;
             }
+            element.hb_source_path = path.join(global_source_path, element.relativePath);
+            const fstats = fs.statSync(element.hb_source_path);
+            element.hb_lastmod = `${fstats.mtime.toISOString().slice(0, 19)}Z`;
             static_html_files.push(element);
         }
     };
@@ -576,6 +583,7 @@
         if (github_api_token !== '') {
             git_token = github_api_token;
         }
+        global_source_path = source_path;
         verbose = verbose_output;
 
         const start_time = Date.now();

package/hdoc-bump.js

@@ -1,109 +1,109 @@
-(function () {
-    'use strict';
-
-    const fs = require('fs'),
-        path = require('path');
-
-    exports.run = function (source_path, bump_type) {
-        if (bump_type !== 'patch' && bump_type !== 'minor' && bump_type !== 'major') {
-            console.log(`Unsupported bump type: ${bump_type}`);
-            process.exit(1);
-        }
-        console.log(`Bumping ${bump_type} book version...\n`);
-
-        // Get document ID
-        const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
-        let hdocbook_project;
-        try {
-            hdocbook_project = require(hdocbook_project_config_path);
-        } catch (e) {
-            console.log('File not found: hdocbook-project.json:');
-            console.log(e, '\n');
-            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-        const doc_id = hdocbook_project.docId;
-
-        const book_path = path.join(source_path, doc_id),
-            hdocbook_path = path.join(book_path, 'hdocbook.json');
-
-        let hdocbook_config;
-        try {
-            hdocbook_config = require(hdocbook_path);
-        } catch (e) {
-            console.log('File not found: hdocbook.json');
-            console.log(e, '\n');
-            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-        const initial_version = hdocbook_config.version;
-        let hdocbook_version = hdocbook_config.version.split('.');
-        if (hdocbook_version.length !== 3) {
-            console.log(`Book version does not appear to be in a semantic versioning format: ${initial_version}`);
-            process.exit(1);
-        }
-
-        if (isNaN(hdocbook_version[0])) {
-            console.log(`Existing major version is not a number: ${hdocbook_version[0]}`);
-            process.exit(1);
-        }
-        if (isNaN(hdocbook_version[1])) {
-            console.log(`Existing minor version is not a number: ${hdocbook_version[1]}`);
-            process.exit(1);
-        }
-        if (isNaN(hdocbook_version[2])) {
-            console.log(`Existing patch version is not a number: ${hdocbook_version[2]}`);
-            process.exit(1);
-        }
-
-        switch (bump_type) {
-            case 'major':
-                try {
-                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10) + 1;
-                    hdocbook_version[1] = 0;
-                    hdocbook_version[2] = 0;
-                } catch (e) {
-                    console.log('Failed to update major version:');
-                    console.log(e);
-                    process.exit(1);
-                }
-                break;
-            case 'minor':
-                try {
-                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10);
-                    hdocbook_version[1] = parseInt(hdocbook_version[1], 10) + 1;
-                    hdocbook_version[2] = 0;
-                } catch (e) {
-                    console.log('Failed to update minor version:');
-                    console.log(e);
-                    process.exit(1);
-                }
-                break;
-            case 'patch':
-            default:
-                try {
-                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10);
-                    hdocbook_version[1] = parseInt(hdocbook_version[1], 10);
-                    hdocbook_version[2] = parseInt(hdocbook_version[2], 10) + 1;
-                } catch (e) {
-                    console.log('Failed to update patch version:');
-                    console.log(e);
-                    process.exit(1);
-                }
-                break;
-        }
-
-        hdocbook_config.version = hdocbook_version.join('.');
-
-        try {
-            fs.writeFileSync(hdocbook_path, JSON.stringify(hdocbook_config, null, 2));
-        } catch (e) {
-            console.log('Error writing bumped version to book config:', e);
-            process.exit(1);
-        }
-
-        console.log(`Book version updated from ${initial_version} to ${hdocbook_config.version}\n`);
-        return true;
-    };
-
+(function () {
+    'use strict';
+
+    const fs = require('fs'),
+        path = require('path');
+
+    exports.run = function (source_path, bump_type) {
+        if (bump_type !== 'patch' && bump_type !== 'minor' && bump_type !== 'major') {
+            console.log(`Unsupported bump type: ${bump_type}`);
+            process.exit(1);
+        }
+        console.log(`Bumping ${bump_type} book version...\n`);
+
+        // Get document ID
+        const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
+        let hdocbook_project;
+        try {
+            hdocbook_project = require(hdocbook_project_config_path);
+        } catch (e) {
+            console.log('File not found: hdocbook-project.json:');
+            console.log(e, '\n');
+            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+        const doc_id = hdocbook_project.docId;
+
+        const book_path = path.join(source_path, doc_id),
+            hdocbook_path = path.join(book_path, 'hdocbook.json');
+
+        let hdocbook_config;
+        try {
+            hdocbook_config = require(hdocbook_path);
+        } catch (e) {
+            console.log('File not found: hdocbook.json');
+            console.log(e, '\n');
+            console.log('hdoc bump needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+        const initial_version = hdocbook_config.version;
+        let hdocbook_version = hdocbook_config.version.split('.');
+        if (hdocbook_version.length !== 3) {
+            console.log(`Book version does not appear to be in a semantic versioning format: ${initial_version}`);
+            process.exit(1);
+        }
+
+        if (isNaN(hdocbook_version[0])) {
+            console.log(`Existing major version is not a number: ${hdocbook_version[0]}`);
+            process.exit(1);
+        }
+        if (isNaN(hdocbook_version[1])) {
+            console.log(`Existing minor version is not a number: ${hdocbook_version[1]}`);
+            process.exit(1);
+        }
+        if (isNaN(hdocbook_version[2])) {
+            console.log(`Existing patch version is not a number: ${hdocbook_version[2]}`);
+            process.exit(1);
+        }
+
+        switch (bump_type) {
+            case 'major':
+                try {
+                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10) + 1;
+                    hdocbook_version[1] = 0;
+                    hdocbook_version[2] = 0;
+                } catch (e) {
+                    console.log('Failed to update major version:');
+                    console.log(e);
+                    process.exit(1);
+                }
+                break;
+            case 'minor':
+                try {
+                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10);
+                    hdocbook_version[1] = parseInt(hdocbook_version[1], 10) + 1;
+                    hdocbook_version[2] = 0;
+                } catch (e) {
+                    console.log('Failed to update minor version:');
+                    console.log(e);
+                    process.exit(1);
+                }
+                break;
+            case 'patch':
+            default:
+                try {
+                    hdocbook_version[0] = parseInt(hdocbook_version[0], 10);
+                    hdocbook_version[1] = parseInt(hdocbook_version[1], 10);
+                    hdocbook_version[2] = parseInt(hdocbook_version[2], 10) + 1;
+                } catch (e) {
+                    console.log('Failed to update patch version:');
+                    console.log(e);
+                    process.exit(1);
+                }
+                break;
+        }
+
+        hdocbook_config.version = hdocbook_version.join('.');
+
+        try {
+            fs.writeFileSync(hdocbook_path, JSON.stringify(hdocbook_config, null, 2));
+        } catch (e) {
+            console.log('Error writing bumped version to book config:', e);
+            process.exit(1);
+        }
+
+        console.log(`Book version updated from ${initial_version} to ${hdocbook_config.version}\n`);
+        return true;
+    };
+
 })();

package/hdoc-create.js

@@ -1,91 +1,91 @@
-(function () {
-    'use strict';
-
-    const fs = require('fs-extra'),
-          path = require('path'),
-          hdoc = require(path.join(__dirname, 'hdoc-module.js'));
-    
-    let doc_id,
-        processed_links = {},
-        file_count = 0,
-        folder_count = 0;
-
-    exports.run = async function (source_path) {
-
-        console.log('Hornbill HDocBook Create', '\n');
-        console.log('Path:', source_path, '\n');
-
-        // Load the hdocbook-project.json file to get the docId
-        // use the docId to get the book config
-        const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
-        let hdocbook_project = {};
-        try {
-            hdocbook_project = require(hdocbook_project_config_path);
-        } catch (e) {
-            console.log(`File not found: ${hdocbook_project_config_path}\n`);
-            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-        doc_id = hdocbook_project.docId;
-
-        const book_path = path.join(source_path, doc_id),
-            hdocbook_path = path.join(book_path, 'hdocbook.json');
-        
-        let hdocbook = {};
-        try {
-            hdocbook = require(hdocbook_path);
-        } catch (e) {
-            console.log(`File not found: ${hdocbook_path}\n`);
-            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-
-        // Get paths from breadcrumb builder
-        let nav_paths = hdoc.build_breadcrumbs(hdocbook.navigation.items);
-        for (const key in nav_paths) {
-            if (nav_paths.hasOwnProperty(key)) {
-                for (let i = 0; i < nav_paths[key].length; i++) {
-                    if (!processed_links[nav_paths[key][i].link]) {
-                        nav_paths[key][i].path = path.join(source_path, nav_paths[key][i].link);
-                        await add_doc(nav_paths[key][i]);
-                    }
-                }
-            }
-        }
-        console.log('\n-----------------------');
-        console.log(' Docs Creation Summary');
-        console.log('-----------------------\n');
-        console.log(`  Files Created: ${file_count}`);
-        console.log(`Folders Created: ${folder_count}\n`);
-    };
-
-    const add_doc = async function(doc_info) {
-
-        // Does folder exist? Create if not
-        const folder = path.dirname(doc_info.path);
-        if (!fs.existsSync(folder)) {
-            try {
-                fs.mkdirSync(folder, true);
-                console.log('Folder created:', folder);
-                folder_count++;
-            } catch {
-                console.log('\nError creating folder', folder, ':', e);
-                return;
-            }
-        }
-
-        // Does file exist? Create if not
-        if (!fs.existsSync(doc_info.path + '.md') && !fs.existsSync(doc_info.path + '.htm') && !fs.existsSync(doc_info.path + '.html')) {
-            try {
-                const file_path = doc_info.path + '.md';
-                fs.writeFileSync(file_path, `# ${doc_info.text}\n`);
-                console.log('  File created:', file_path);
-                processed_links[doc_info.link] = true;
-                file_count++;
-            } catch (e) {
-                console.log('\nError creating file', doc_info.path, ':', e);
-            }
-        }
-    }
-
+(function () {
+    'use strict';
+
+    const fs = require('fs-extra'),
+          path = require('path'),
+          hdoc = require(path.join(__dirname, 'hdoc-module.js'));
+    
+    let doc_id,
+        processed_links = {},
+        file_count = 0,
+        folder_count = 0;
+
+    exports.run = async function (source_path) {
+
+        console.log('Hornbill HDocBook Create', '\n');
+        console.log('Path:', source_path, '\n');
+
+        // Load the hdocbook-project.json file to get the docId
+        // use the docId to get the book config
+        const hdocbook_project_config_path = path.join(source_path, 'hdocbook-project.json');
+        let hdocbook_project = {};
+        try {
+            hdocbook_project = require(hdocbook_project_config_path);
+        } catch (e) {
+            console.log(`File not found: ${hdocbook_project_config_path}\n`);
+            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+        doc_id = hdocbook_project.docId;
+
+        const book_path = path.join(source_path, doc_id),
+            hdocbook_path = path.join(book_path, 'hdocbook.json');
+        
+        let hdocbook = {};
+        try {
+            hdocbook = require(hdocbook_path);
+        } catch (e) {
+            console.log(`File not found: ${hdocbook_path}\n`);
+            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+
+        // Get paths from breadcrumb builder
+        let nav_paths = hdoc.build_breadcrumbs(hdocbook.navigation.items);
+        for (const key in nav_paths) {
+            if (nav_paths.hasOwnProperty(key)) {
+                for (let i = 0; i < nav_paths[key].length; i++) {
+                    if (!processed_links[nav_paths[key][i].link]) {
+                        nav_paths[key][i].path = path.join(source_path, nav_paths[key][i].link);
+                        await add_doc(nav_paths[key][i]);
+                    }
+                }
+            }
+        }
+        console.log('\n-----------------------');
+        console.log(' Docs Creation Summary');
+        console.log('-----------------------\n');
+        console.log(`  Files Created: ${file_count}`);
+        console.log(`Folders Created: ${folder_count}\n`);
+    };
+
+    const add_doc = async function(doc_info) {
+
+        // Does folder exist? Create if not
+        const folder = path.dirname(doc_info.path);
+        if (!fs.existsSync(folder)) {
+            try {
+                fs.mkdirSync(folder, true);
+                console.log('Folder created:', folder);
+                folder_count++;
+            } catch {
+                console.log('\nError creating folder', folder, ':', e);
+                return;
+            }
+        }
+
+        // Does file exist? Create if not
+        if (!fs.existsSync(doc_info.path + '.md') && !fs.existsSync(doc_info.path + '.htm') && !fs.existsSync(doc_info.path + '.html')) {
+            try {
+                const file_path = doc_info.path + '.md';
+                fs.writeFileSync(file_path, `# ${doc_info.text}\n`);
+                console.log('  File created:', file_path);
+                processed_links[doc_info.link] = true;
+                file_count++;
+            } catch (e) {
+                console.log('\nError creating file', doc_info.path, ':', e);
+            }
+        }
+    }
+
 })();

package/hdoc-db.js

@@ -1,95 +1,95 @@
-(function () {
-    'use strict';
-
-    const html2text = require('html-to-text'),
-        path = require('path'),
-        hdoc = require(path.join(__dirname, 'hdoc-module.js'));
-
-    exports.create_table = function (db, table_name, columns, virtual, fts5) {
-        let create_sql = ['CREATE'];
-        if (virtual) create_sql.push('VIRTUAL');
-        create_sql.push('TABLE');
-        create_sql.push(table_name);
-        if (fts5) create_sql.push('USING fts5(');
-        else create_sql.push('(');
-        for (let i = 0; i < columns.length; i++) {
-            if (i !== 0) create_sql.push(`,${columns[i]}`);
-            else create_sql.push(columns[i]);
-        }
-        create_sql.push(');');
-        try {
-            db.exec(create_sql.join('\n'));
-            return null;
-        } catch (e) {
-            return e;
-        }
-    };
-
-    exports.insert_record = function (db, table, columns, values) {
-        let response = {
-            success: false,
-            row_id: 0,
-            error: null
-        };
-        let queryProps = [];
-        queryProps.push(`INSERT INTO ${table}`);
-        let cols = '(';
-        let vals = 'VALUES (';
-        for (let i = 0; i < columns.length; i++) {
-            if (i === 0) {
-                cols += `${columns[i].replace('UNINDEXED', '').replace('INTEGER', '').trim()}`;
-                vals += '?';
-            } else {
-                cols += `, ${columns[i].replace('UNINDEXED', '').replace('INTEGER', '').trim()}`;
-                vals += ', ?';
-            }
-        }
-        cols += ')';
-        vals += ')';
-        queryProps.push(cols);
-        queryProps.push(vals);
-
-        try {
-            const stmt = db.prepare(queryProps.join(' '));
-            const info = stmt.run(values);
-            response.row_id = info.lastInsertRowid;
-            response.success = true;
-        } catch (e) {
-            response.error = e;
-        }
-        return response;
-    };
-
-    exports.transform_html_for_index = function (html_txt) {
-        let response = {
-            text: '',
-            preview: '',
-            fm_props: {}
-        };
-
-        // Get frontmatter properties
-        const fm_headers = hdoc.getHTMLFrontmatterHeader(html_txt);
-        response.fm_props = fm_headers.fm_properties;
-
-        // Convert HTML into plain text
-        response.text = html2text.convert(html_txt, {
-            ignoreHref: true,
-            ignoreImage: true,
-            uppercaseHeadings: false,
-            wordwrap: null
-        });
-
-        // Convert HTML into preview text
-        response.preview = html2text.convert(html_txt, {
-            baseElement: 'p',
-            ignoreHref: true,
-            ignoreImage: true,
-            uppercaseHeadings: false,
-            wordwrap: null
-        });
-        response.preview = hdoc.truncate_string(response.preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
-        return response;
-    };
-
-
+(function () {
+    'use strict';
+
+    const html2text = require('html-to-text'),
+        path = require('path'),
+        hdoc = require(path.join(__dirname, 'hdoc-module.js'));
+
+    exports.create_table = function (db, table_name, columns, virtual, fts5) {
+        let create_sql = ['CREATE'];
+        if (virtual) create_sql.push('VIRTUAL');
+        create_sql.push('TABLE');
+        create_sql.push(table_name);
+        if (fts5) create_sql.push('USING fts5(');
+        else create_sql.push('(');
+        for (let i = 0; i < columns.length; i++) {
+            if (i !== 0) create_sql.push(`,${columns[i]}`);
+            else create_sql.push(columns[i]);
+        }
+        create_sql.push(');');
+        try {
+            db.exec(create_sql.join('\n'));
+            return null;
+        } catch (e) {
+            return e;
+        }
+    };
+
+    exports.insert_record = function (db, table, columns, values) {
+        let response = {
+            success: false,
+            row_id: 0,
+            error: null
+        };
+        let queryProps = [];
+        queryProps.push(`INSERT INTO ${table}`);
+        let cols = '(';
+        let vals = 'VALUES (';
+        for (let i = 0; i < columns.length; i++) {
+            if (i === 0) {
+                cols += `${columns[i].replace('UNINDEXED', '').replace('INTEGER', '').trim()}`;
+                vals += '?';
+            } else {
+                cols += `, ${columns[i].replace('UNINDEXED', '').replace('INTEGER', '').trim()}`;
+                vals += ', ?';
+            }
+        }
+        cols += ')';
+        vals += ')';
+        queryProps.push(cols);
+        queryProps.push(vals);
+
+        try {
+            const stmt = db.prepare(queryProps.join(' '));
+            const info = stmt.run(values);
+            response.row_id = info.lastInsertRowid;
+            response.success = true;
+        } catch (e) {
+            response.error = e;
+        }
+        return response;
+    };
+
+    exports.transform_html_for_index = function (html_txt) {
+        let response = {
+            text: '',
+            preview: '',
+            fm_props: {}
+        };
+
+        // Get frontmatter properties
+        const fm_headers = hdoc.getHTMLFrontmatterHeader(html_txt);
+        response.fm_props = fm_headers.fm_properties;
+
+        // Convert HTML into plain text
+        response.text = html2text.convert(html_txt, {
+            ignoreHref: true,
+            ignoreImage: true,
+            uppercaseHeadings: false,
+            wordwrap: null
+        });
+
+        // Convert HTML into preview text
+        response.preview = html2text.convert(html_txt, {
+            baseElement: 'p',
+            ignoreHref: true,
+            ignoreImage: true,
+            uppercaseHeadings: false,
+            wordwrap: null
+        });
+        response.preview = hdoc.truncate_string(response.preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
+        return response;
+    };
+
+
 })();