hdoc-tools 0.11.1 → 0.11.3

package/hdoc-build-db.js

@@ -1,9 +1,9 @@
 (function () {
     'use strict';
 
-    const   path = require('path'),
-            hdoc_index = require(path.join(__dirname, 'hdoc-db.js')),
-            database = require('better-sqlite3');
+    const path = require('path'),
+        hdoc_index = require(path.join(__dirname, 'hdoc-db.js')),
+        database = require('better-sqlite3');
 
     const db_schema = {
         hdoc_index: [
@@ -15,7 +15,8 @@
             'doc_content',
             'doc_preview UNINDEXED',
             'doc_family_id',
-            'doc_md5_hash UNINDEXED'
+            'doc_md5_hash UNINDEXED',
+            'lastmod'
         ],
         hdoc_meta: [
             'resource_url',
@@ -95,7 +96,8 @@
                 file.index_html.text,
                 file.index_html.preview,
                 book_config.productFamily,
-                file.md5
+                file.md5,
+                file.lastmod
             ];
             const index_response = hdoc_index.insert_record(db, 'hdoc_index', db_schema.hdoc_index, index_vals);
             if (!index_response.success) {
@@ -118,7 +120,7 @@
                         console.log(`Inserted index record ${index_response.row_id}: ${doc_id} - ${file.index_html.fm_props.title}`);
                         console.log(`Inserted index metadata record for index ID: ${meta_response.row_id}`);
                     }
-        
+
                     // Now add contributor records
                     for (let j = 0; j < file.contributors.length; j++) {
                         const contrib_vals = [
@@ -136,7 +138,7 @@
                         }
                         if (verbose) {
                             console.log(`Inserted document contributor recordL ${cont_response.row_id}`);
-                        }   
+                        }
                     }
                     response.index_success_count++;
                 }

package/hdoc-build.js

@@ -467,14 +467,14 @@
             }
 
             const index_details = hdoc_index.transform_html_for_index(html_txt);
-
             index_records.push({
                 relative_path: relative_path,
                 index_html: index_details,
                 metadata: metadata,
                 contributors: contribs,
                 pdf_size: pdf_size,
-                md5: file_path.hash
+                md5: file_path.hash,
+                lastmod: file_path.stat.mtime.toISOString()
             });
 
             // Add MD file to delete queue
@@ -563,6 +563,7 @@
         hash: true,
         extensions: ['md', 'html', 'htm'],
         normalize: true,
+        stat: true
     };
 
     const md5DreeOptions = {

package/hdoc-bump.js

@@ -0,0 +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;
+    };
+
+})();

package/hdoc-ver.js

@@ -0,0 +1,43 @@
+(function () {
+    'use strict';
+
+    const fs = require('fs'),
+        path = require('path');
+
+    exports.run = function (source_path) {
+        console.log(`Retrieving 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 ver 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 ver needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+        if (hdocbook_config.version && hdocbook_config.version !== '') {
+            console.log(`Book version: ${hdocbook_config.version}\n`);
+        } else {
+            console.log(`Error - this book has no version defined.\n`);
+            process.exit(1);
+        }
+    };
+
+})();

package/hdoc.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 (async function () {
    'use strict';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.11.1",
+  "version": "0.11.3",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -12,6 +12,7 @@
     "hdoc-build.js",
     "hdoc-build-db.js",
     "hdoc-build-pdf.js",
+    "hdoc-bump.js",
     "hdoc-create.js",
     "hdoc-help.js",
     "hdoc-init.js",
@@ -19,6 +20,7 @@
     "hdoc-serve.js",
     "hdoc-stats.js",
     "hdoc-validate.js",
+    "hdoc-ver.js",
     "validateNodeVer.js",
     "ui",
     "custom_modules",