hdoc-tools 0.6.4 → 0.6.6

package/hdoc-init.js

@@ -1,36 +1,147 @@
 (function () {
     'use strict';
 
+    // Required modules
     const prompt = require('prompt');
+    //const fs = require('fs');
+    const fs = require('fs-extra');
+    const path = require('path');
 
-    const properties = [{
-            name: 'documentId',
-            validator: /^[a-z-]+$/,
-            warning: 'Document ID must only contain lower case letters and dashes'
+    // Configure prompt module preferences
+    prompt.message = false;
+    const promptProps = [{
+            name: 'id',
+            description: 'Document ID',
+            validator: /^[a-z][a-z-]+[a-z]$/,
+            warning: 'Document ID must only contain lower case letters and dashes',
+            required: true
         },
         {
-            name: 'title'
+            name: 'title',
+            description: 'Title',
+            required: true
         },
         {
-            name: 'initialVersion',
-            validator: /^[a-z-]+$/,
-            warning: 'Document ID must only contain lower case letters and dashes'
+            name: 'description',
+            description: 'Description',
+            required: true
+        },
+        {
+            name: 'version',
+            description: 'Initial Version',
+            validator: /^[0-9]{1,3}[.][0-9]{1,3}[.][0-9]{1,3}$/,
+            warning: 'Version must formatted using semantic versioning - major.minor.patch, eg: 0.1.2',
+            required: true
+        },
+        {
+            name: 'author',
+            description: 'Package Author',
+            required: true
         }
     ];
 
-    exports.run = function (ui_path, source_path, md) {
+    const createBook = function(server_path, source_path, docProps) {
+        console.log('\r\nCreating book with the following properties:\r\n');
+        console.log('           Doc ID:', docProps.id);
+        console.log('            Title:', docProps.title);
+        console.log('      Description:', docProps.description);
+        console.log('           Author:', docProps.author);
+        console.log('  Initial Version:', docProps.version, '\r\n');
+
+        //Make folder in source path
+        const bookPath = path.join(source_path, docProps.id);
+        if (!fs.existsSync(bookPath)) {
+            
+            // Create target book folder
+            fs.mkdirSync(bookPath);
+            
+            // Now copy files over
+            const templatePath = path.join(server_path, 'templates','init');
+            console.log('Copying template from:', templatePath);
+
+            if (fs.existsSync(templatePath)) {
+                // If template path exists, do sync copy into book path
+                try {
+                    fs.copySync(templatePath, bookPath);
+                } catch (e){
+                    console.error('Error copying template:\r\n', e);
+                    process.exit(1);
+                }
+
+                // Rename _hdocbook folder to docId, sync as we need to wait 
+                // until this in complete for the next tasks to be successful
+                const bookContentRoot = path.join(bookPath, docProps.id);
+                try {
+                    fs.renameSync(path.join(bookPath, '_hdocbook'), bookContentRoot);
+                } catch (e) {
+                    console.error('Error renaming template folder:\r\n', e);
+                    process.exit(1);
+                }
+
+                // The file update tasks can now all be done async now 
+                // we have the file and folder structure in place
 
+                // Update hdocbook-project.json
+                const hdocBookProjectFilePath = path.join(bookPath, 'hdocbook-project.json');
+                const hdocBookProjectFile = require(hdocBookProjectFilePath);
+                hdocBookProjectFile.docId = docProps.id;
+                fs.writeFile(hdocBookProjectFilePath, JSON.stringify(hdocBookProjectFile, null, 2), function writeJSON(err) {
+                    if (err) return console.log('Error updating:',hdocBookProjectFilePath, '\r\n', err);
+                    console.log('Updated:', hdocBookProjectFilePath);
+                });
+
+                // Update root/hdocbook.json
+                const hdocBookFilePath = path.join(bookContentRoot, 'hdocbook.json');
+                const hdocbookFile = require(hdocBookFilePath);
+                hdocbookFile.docId = docProps.id;
+                hdocbookFile.title = docProps.title;
+                hdocbookFile.description = docProps.description;
+                hdocbookFile.version = docProps.version;
+                fs.writeFile(hdocBookFilePath, JSON.stringify(hdocbookFile, null, 2), function writeJSON(err) {
+                    if (err) return console.log('Error updating:',hdocBookFilePath, '\r\n', err);
+                    console.log('Updated:', hdocBookFilePath);
+                });
+
+                // Update hdocbook-project.json
+                const packageFilePath = path.join(bookPath, 'package.json');
+                const packageFile = require(packageFilePath);
+                packageFile.name = docProps.id;
+                packageFile.version = docProps.version;
+                hdocbookFile.description = docProps.description;
+                hdocbookFile.version = docProps.version;
+                hdocbookFile.author = docProps.author;
+                fs.writeFile(packageFilePath, JSON.stringify(packageFile, null, 2), function writeJSON(err) {
+                    if (err) return console.log('Error updating:',packageFilePath, '\r\n', err);
+                    console.log('Updated:', packageFilePath);
+                });
+
+            } else {
+                console.error('Template path does not exist:', templatePath);
+                process.exit(1);
+            }
+        } else {
+            console.error('Target book path already exists:', bookPath);
+            process.exit(1);
+        }
+    };
+
+    exports.run = function (server_path, source_path, md) {
         // GERRY: The init function should create a new starting point HDocBook folder structure
         // ready to run the preview server and start editing. 
         //
         // The init function should prompt for the ID of the doc book, title and initial version, then
         // create the required files and folders.  Its possible to just create a template and copy
-        // those files into place, with a few variable replacements. 
-        // 
-        // 
-
-        console.log("Init is not yet implemented");
+        // those files into place, with a few variable replacements.  
 
+        console.log('Hornbill HDocBook Init', '\r\n');
+        prompt.start();
+        prompt.get(promptProps, function (err, result) {
+            if (err) {
+                console.error(err);
+                return err;
+            }
+            createBook(server_path, source_path, result);
+        });
 
     };
 })();

package/hdoc-stats.js

@@ -5,7 +5,7 @@
     // Required modules
     // /const { STATUS_CODES } = require('http');
     const fs = require('fs');
-    var path = require('path');
+    const path = require('path');
     const dree = require('dree');
     const html2text = require('html-to-text');
     const { markdownToTxt } = require('markdown-to-txt');

package/hdoc.js

@@ -84,7 +84,7 @@ const { createCipheriv } = require('crypto');
       }
    }
 
-   console.log('Hornbill HDocBook Tools v', getHdocPackageVersion(packageFile), '\r\n');
+   console.log('Hornbill HDocBook Tools v' + getHdocPackageVersion(packageFile), '\r\n');
    console.log('    Server Path:', __dirname);
    console.log('  Document Path:', source_path, '\r\n');
 
@@ -99,7 +99,7 @@ const { createCipheriv } = require('crypto');
       stats.run(ui_path, source_path, md, verbose);
    } else if (command == 'init') {
       const init = require(path.join(__dirname, 'hdoc-init.js'));
-      init.run(ui_path, source_path, md);
+      init.run(__dirname, source_path, md);
    } else if (command == 'help') {
       const init = require(path.join(__dirname, 'hdoc-help.js'));
       init.run();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.6.4",
+  "version": "0.6.6",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -14,7 +14,8 @@
     "hdoc-serve.js",
     "hdoc-stats.js",
     "ui",
-    "custom_modules"
+    "custom_modules",
+    "templates"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -26,6 +27,7 @@
     "cookie-parser": "^1.4.6",
     "dree": "^3.4.2",
     "express": "^4.18.2",
+    "fs-extra": "^11.1.0",
     "hdoc-tools": "^0.1.0",
     "highlight.js": "^11.6.0",
     "html-to-text": "^8.2.1",
@@ -36,6 +38,7 @@
     "markdown-it-front-matter": "^0.2.3",
     "markdown-to-txt": "^2.0.1",
     "multer": "^1.4.5-lts.1",
+    "prompt": "^1.3.0",
     "stream": "0.0.2",
     "words-count": "^2.0.2"
   }

package/templates/init/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Hornbill Docs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/templates/init/README.md

@@ -0,0 +1,9 @@
+# HDocBook documentation
+This is an example of a simple static content documentation project that is compatible with the Hornbill Docs system
+
+Make sure that you have installed hdoc-tools   
+
+  npm install hdoc-tools -g
+
+To preview the documentation in a browser, you can open a terminal window and run the dev preview server with the 
+command `hdoc serve` and in a local browser go to the url `http://localhost:3000`

package/templates/init/_hdocbook/hdocbook.json

@@ -0,0 +1,15 @@
+{
+    "docId": "--docId--",
+    "title": "--title--",
+    "description": "--description--",
+    "publicSource": "--publicSource--",
+    "version": "0.0.1",
+    "navigation": {
+        "items": [
+            {
+                "text": "Welcome",
+                "expand": true
+            }
+        ]
+    }
+}

package/templates/init/_hdocbook/index.md

@@ -0,0 +1,5 @@
+---
+layout: article-toc
+---
+# Welcome 
+This is your first page

package/templates/init/hdocbook-project.json

@@ -0,0 +1,3 @@
+{
+    "docId": "hdoc-guide"
+}

package/templates/init/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "hdoc-guide",
+  "version": "0.1.0",
+  "description": "",
+  "main": "hdocbook.js",
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+  },
+  "dependencies": {
+  }
+}