hdoc-tools 0.11.0 → 0.11.2

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-help.js

@@ -38,6 +38,9 @@ Commands
     - minor - updates the minor version of the book. i.e. - 1.4.5 would become 1.5.0
     - patch (default) - updates the patch version of the book. i.e. - 1.4.5 would become 1.4.6
 
+ - ver
+    Returns the version of the current book
+
 Example
 
     hdoc stats -v

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

@@ -106,6 +106,9 @@
    } else if (command == 'bump') {
       const bump = require(path.join(__dirname, 'hdoc-bump.js'));
       bump.run(source_path, bump_type);
+   } else if (command == 'ver') {
+      const ver = require(path.join(__dirname, 'hdoc-ver.js'));
+      ver.run(source_path);
    } else {
       console.log('Unknown command:', command, '\r\n');
       console.log('Run hdoc help for information regarding this tool.\r\n');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.11.0",
+  "version": "0.11.2",
   "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",