hdoc-tools 0.7.7 → 0.7.9

package/README.md

@@ -1,42 +1,9 @@
-# hdoc-tools
+# HDocBook documentation
+This is an example of a simple static content documentation project that is compatible with the Hornbill Docs system
 
-Hornbill HDocBook Development Support Tool.
+Make sure that you have installed hdoc-tools   
 
-## Usage
+  npm install hdoc-tools -g
 
-<code>hdoc argument switches</code>
-
-## Arguments
-
-The arguments available to this command-line tool are as follows.
-
-### help
-
-Outputs available arguments and switches.
-
-### init
-
-Initializes a new HDocBook project from a template, using runtime input variables.
-
-### stats
-
-Returns statistics regarding the book you are working on:
-
-- Document ID
-- Version
-- Title
-- Description
-- Public Source
-- Total Book Word Count
-- Number of Markdown Files in the Book
-- Number of Static HTML Files in the Book
-
-If the -v switch is provided, then a more verbose output is output, which includes a list of each MD and HTML file found, the file sizes, and file-specific word count.
-
-### build
-
-Performs a local build of the book, and outputs as a ZIP file.
-
-### serve
-
-Starts a local web server on port 3000, serving the book content.
+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/hdoc-init.js

@@ -40,7 +40,7 @@
         }
     ];
 
-    const createBook = function(server_path, source_path, docProps) {
+    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);
@@ -48,85 +48,72 @@
         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);
+        // 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);
-                }
+        if (fs.existsSync(templatePath)) {
+            // If template path exists, do sync copy into book path
+            try {
+                fs.copySync(templatePath, source_path);
+            } 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);
-                }
+            // 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(source_path, docProps.id);
+            try {
+                fs.renameSync(path.join(source_path, '_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
+            // 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 hdocbook-project.json
+            const hdocBookProjectFilePath = path.join(source_path, '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;
-                hdocbookFile.navigation.items[0].items = [
-                    {
-                        "text": "Welcome",
-                        "link": path.join(docProps.id, 'index')
-                    }
-                ];
-                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 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;
+            hdocbookFile.navigation.items[0].items = [{
+                "text": "Welcome",
+                "link": path.join(docProps.id, 'index')
+            }];
+            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 package.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);
-                });
+            // Update package.json
+            const packageFilePath = path.join(source_path, '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);
+            console.error('Template path does not exist:', templatePath);
             process.exit(1);
         }
     };

package/hdoc-serve.js

@@ -112,7 +112,7 @@
 
       function expand_variables(text) {
          // For debug mode our base path is our root??
-         text = text.replaceAll('{{BASE_PATH}}', '/' + docId);
+         text = text.replaceAll('{{DOC_ID}}', docId);
          text = text.replaceAll('{{BUILD_NUMBER}}', '0');
 
          let build_date = new Date().toISOString();
@@ -329,26 +329,6 @@
       // Catch all
       app.get('/*', function (req, res) {
 
-         let segs = req.url.split('/');
-
-         if (segs.length > 3 && segs[2] == 'content') {
-            // In this case we are looking for static content within the book
-
-            // Create the file path
-            let url = req.url.replace('/content/', '/');
-            let file_path = path.join(source_path, url);
-
-            // If the file exists, send it.
-            if (fs.existsSync(file_path) == true) {
-               send_file(req, res, file_path);
-               return;
-            }
-
-            // All else fails, we have not file to return, so return a 404 error here
-            send_content_resource_404(req, res);
-            return;
-         }
-
          let ui_file_path = path.join(ui_path, req.url);
 
          console.log('URL Root:', req.url);
@@ -376,6 +356,13 @@
 
          console.log('Server listening at http://127.0.0.1:%s', port);
          console.log('Document source path is: ' + source_path);
+
+         let _vars = ['{{DOC_ID}}', '{{BASE_PATH}}', '{{BUILD_NUMBER}}', '{{BUILD_DATE}}'];
+         console.log("Server Vars:");
+         for(let x = 0; x < _vars.length; x++) {
+            let name = _vars[x];
+            console.log("   ", name, " = ",  expand_variables(name));
+         }
       });
 
    };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hdoc-tools",
-  "version": "0.7.7",
+  "version": "0.7.9",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {