hdoc-tools 0.7.20 → 0.7.21

package/hdoc-build.js

@@ -37,8 +37,14 @@
             }
 
             // Render markdown into HTML
+            let frontmatter_content = '';
             var html_txt = md.render(md_txt.toString());
 
+
+            if (frontmatter_content.length) {
+                html_txt = "<!--[[FRONTMATTER\r\n" + frontmatter_content + "]]-->\r\n" + html_txt;
+            }
+ 
             // Save HTML into HTML file
             const target_file = file_path.replace(path.extname(file_path), '.html');
             fs.writeFile(target_file, html_txt, function writeJSON(err) {

package/hdoc-db.js

@@ -0,0 +1,158 @@
+const { nextTick } = require('process');
+
+(function() {
+    'use strict';
+
+    const   dree = require('dree'),
+            fs = require('fs-extra'),
+            html2text = require('html-to-text'),
+            sqlite3 = require('sqlite3'),
+            path = require('path');
+
+    const  table_name = 'hbdocs';
+
+    let     db_name = 'hbdocs.db',
+            hdocbook_meta = null,
+            md_files = [];
+
+    // File callbacks for scan
+    const file_callback = function (element) {
+        if (path.extname(element.path) === '.md' && !element.path.includes('_work')) {
+            md_files.push(element);
+        } else if (element.name === 'hdocbook.json') {
+            // hdocbook meta data, read and store
+            hdocbook_meta = require(element.path);
+        }
+    };
+
+    const create_table = function(db) {
+        db.exec(`
+        create table ${table_name} (
+        relative_url text primary key not null,
+        book_id text not null,
+        title text not null,
+        content text not null,
+        tags text null,
+        audience text not null
+        );
+        `, (err)  => {
+            if (err !== null) {
+                console.error(`Error creating table [${table_name}]: ${err}`);
+                return false;
+            } else {
+                console.log(`  Table created successfully: ${table_name}`);
+                return true;
+            }
+        });
+        return true;
+    };
+
+    const build_db = function(db, md, book_def, md_files) {
+        for (let i = 0; i < md_files.length; i++) {
+            db.exec(`
+            insert into ${table_name} 
+                (book_id, title, relative_url, content, tags, audience)
+            values
+                (
+                    '${book_def.docId}',
+                    '${book_def.title}',
+                    '${md_files[i].relativePath}',
+                    'Some file content',
+                    '${book_def.tags.join(';')}',
+                    '${book_def.audience.join(';')}'
+                );
+            `, (err)  => {
+                if (err !== null) {
+                    console.error(`Error inserting record [${md_files[i].relativePath}]: ${err}`);
+                    return false;
+                } else {
+                    console.log(`  Record inserted successfully: ${md_files[i].relativePath}`);
+                    return true;
+                }
+            });
+        }
+    };
+
+    const transform_markdown  = function (file_path, md) {
+        if (fs.existsSync(file_path)) {
+            // Load markdown file
+            let md_txt = hdoc.expand_variables(fs.readFileSync(file_path, 'utf8'));
+
+            // Pull in external includes
+            const includes_processed = hdoc.process_includes(file_path, md_txt);
+            md_txt = includes_processed.body;
+            includes_found += includes_processed.found;
+            includes_success += includes_processed.success;
+            includes_failed += includes_processed.failed;
+            if (includes_processed.errors.length > 0) {
+                for (let i = 0; i < includes_processed.errors.length; i++) {
+                    console.error(includes_processed.errors[i]);
+                }
+            }
+
+            // Render markdown into HTML
+            var html_txt = md.render(md_txt.toString());
+
+            // Save HTML into HTML file
+            const target_file = file_path.replace(path.extname(file_path), '.html');
+            fs.writeFile(target_file, html_txt, function writeJSON(err) {
+                if (err) return console.log('Error writing:', target_file, '\r\n', err);
+            });
+            conversion_success++;
+            return true;
+        }
+        conversion_failed++;
+        console.error('MD file does not exist:', file_path);
+        return false;
+    };
+
+    const dree_options = {
+        descendants: true,
+        depth: 10,
+        extensions: ['md','json'],
+        hash: false,
+        normalize: true,
+        size: false,
+        sizeInBytes: false,
+        stat: false,
+        symbolicLinks: false
+    };
+
+    exports.run = function(source_path, md) {
+        /*
+            STEVE - The purpose of this command is to allow content developers to do local builds of
+                    the SQlite database and index file, for validation before commit and build 
+        */
+        dree.scan(source_path, dree_options, file_callback);
+
+        if (hdocbook_meta === null) {
+            console.error('hdocbook.json was not found, or has no content');
+            process.exit(1);
+        }
+        if (md_files.length === 0) {
+            console.error('No markdown files detected in', source_path);
+            process.exit(1);
+        }
+
+        db_name = path.join(source_path, db_name);
+        if (fs.existsSync(db_name)) {
+            try {
+                fs.removeSync(db_name);
+            } catch (e) {
+                console.error(`Failed to delete existing db file: ${db_name}`);
+            }
+        }
+
+        let db = new sqlite3.Database(db_name, (err) => {
+            if (err) {
+                console.error('Error creating database:', err);
+                process.exit(1);
+            }
+            console.log(`DB file created successfully: ${db_name}`);
+            if (create_table(db)) {
+                if (!hdocbook_meta.tags) hdocbook_meta.tags = [];
+                build_db(db, md, hdocbook_meta, md_files );
+            }
+        });
+    };
+})();

package/hdoc.js

@@ -54,8 +54,9 @@ const { createCipheriv } = require('crypto');
    let source_path = process.cwd();
    let ui_path = path.join(__dirname, 'ui');
 
-   let command = ''; // Our command to run
-   let verbose = false;
+   let   command = '', // Our command to run
+         verbose = false,
+         build_index = false;
 
    // Get options from command args
    for (let x = 0; x < process.argv.length; x++) {
@@ -83,6 +84,7 @@ const { createCipheriv } = require('crypto');
       if (process.argv[x] === '-v') {
          verbose = true;
       }
+
    }
 
    console.log('Hornbill HDocBook Tools v' + getHdocPackageVersion(packageFile), '\r\n');
@@ -102,8 +104,11 @@ const { createCipheriv } = require('crypto');
       const init = require(path.join(__dirname, 'hdoc-init.js'));
       init.run(__dirname, source_path, md);
    } else if (command == 'help') {
-      const init = require(path.join(__dirname, 'hdoc-help.js'));
-      init.run();
+      const help = require(path.join(__dirname, 'hdoc-help.js'));
+      help.run();
+   } else if (command == 'buildindex') {
+      const build_db = require(path.join(__dirname, 'hdoc-db.js'));
+      build_db.run(source_path, md);
    } 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.7.20",
+  "version": "0.7.21",
   "description": "Hornbill HDocBook Development Support Tool",
   "main": "hdoc.js",
   "bin": {
@@ -8,6 +8,7 @@
   },
   "files": [
     "hdoc.js",
+    "hdoc-db.js",
     "hdoc-build.js",
     "hdoc-help.js",
     "hdoc-init.js",
@@ -41,6 +42,7 @@
     "markdown-it-front-matter": "^0.2.3",
     "multer": "^1.4.5-lts.1",
     "prompt": "^1.3.0",
+    "sqlite3": "^5.1.4",
     "stream": "0.0.2",
     "sync-request": "^6.1.0",
     "words-count": "^2.0.2",

package/ui/js/doc.hornbill.js

@@ -94,7 +94,6 @@ function listenForHrefClicks()
     //-- trap all link click events - we want to handle links so can cancel and load content ourselves
     $("A").off("click").on("click", function(ev)
     {
-
         let ele =  this;
         if(ele.href)
         {
@@ -304,7 +303,7 @@ function loadContentUrl(linkRef,fromPageRefresh,fromPopState)
             view.$nextTick(function()
             {
                 //-- find any navigation links that match url and highlight
-                listenForHrefClicks();                
+//                listenForHrefClicks();
                 highlightNavigationLinkFromUrl(linkRef);   
 
                 //-- scroll to element that match hash (if have one)
@@ -315,6 +314,8 @@ function loadContentUrl(linkRef,fromPageRefresh,fromPopState)
             });
             view.$forceUpdate();
         }
+
+        listenForHrefClicks();
     });
 }
 

package/LICENSE

@@ -1,21 +0,0 @@
-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.