hdoc-tools 0.9.47 → 0.9.49

package/hdoc-create.js

@@ -1,91 +1,91 @@
-(function () {
-    'use strict';
-
-    const fs = require('fs-extra'),
-          path = require('path'),
-          hdoc = require(path.join(__dirname, 'hdoc-module.js'));
-    
-    let doc_id,
-        processed_links = {},
-        file_count = 0,
-        folder_count = 0;
-
-    exports.run = async function (source_path) {
-
-        console.log('Hornbill HDocBook Create', '\n');
-        console.log('Path:', source_path, '\n');
-
-        // Load the hdocbook-project.json file to get the docId
-        // use the docId to get the book config
-        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_config_path}\n`);
-            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-        doc_id = hdocbook_project.docId;
-
-        const book_path = path.join(source_path, doc_id),
-            hdocbook_path = path.join(book_path, 'hdocbook.json');
-        
-        let hdocbook = {};
-        try {
-            hdocbook = require(hdocbook_path);
-        } catch (e) {
-            console.log(`File not found: ${hdocbook_path}\n`);
-            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-
-        // Get paths from breadcrumb builder
-        let nav_paths = hdoc.build_breadcrumbs(hdocbook.navigation.items);
-        for (const key in nav_paths) {
-            if (nav_paths.hasOwnProperty(key)) {
-                for (let i = 0; i < nav_paths[key].length; i++) {
-                    if (!processed_links[nav_paths[key][i].link]) {
-                        nav_paths[key][i].path = path.join(source_path, nav_paths[key][i].link);
-                        await add_doc(nav_paths[key][i]);
-                    }
-                }
-            }
-        }
-        console.log('\n-----------------------');
-        console.log(' Docs Creation Summary');
-        console.log('-----------------------\n');
-        console.log(`  Files Created: ${file_count}`);
-        console.log(`Folders Created: ${folder_count}\n`);
-    };
-
-    const add_doc = async function(doc_info) {
-
-        // Does folder exist? Create if not
-        const folder = path.dirname(doc_info.path);
-        if (!fs.existsSync(folder)) {
-            try {
-                fs.mkdirSync(folder, true);
-                console.log('Folder created:', folder);
-                folder_count++;
-            } catch {
-                console.log('\nError creating folder', folder, ':', e);
-                return;
-            }
-        }
-
-        // Does file exist? Create if not
-        if (!fs.existsSync(doc_info.path + '.md') && !fs.existsSync(doc_info.path + '.htm') && !fs.existsSync(doc_info.path + '.html')) {
-            try {
-                const file_path = doc_info.path + '.md';
-                fs.writeFileSync(file_path, `# ${doc_info.text}\n`);
-                console.log('  File created:', file_path);
-                processed_links[doc_info.link] = true;
-                file_count++;
-            } catch (e) {
-                console.log('\nError creating file', doc_info.path, ':', e);
-            }
-        }
-    }
-
+(function () {
+    'use strict';
+
+    const fs = require('fs-extra'),
+          path = require('path'),
+          hdoc = require(path.join(__dirname, 'hdoc-module.js'));
+    
+    let doc_id,
+        processed_links = {},
+        file_count = 0,
+        folder_count = 0;
+
+    exports.run = async function (source_path) {
+
+        console.log('Hornbill HDocBook Create', '\n');
+        console.log('Path:', source_path, '\n');
+
+        // Load the hdocbook-project.json file to get the docId
+        // use the docId to get the book config
+        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_config_path}\n`);
+            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+        doc_id = hdocbook_project.docId;
+
+        const book_path = path.join(source_path, doc_id),
+            hdocbook_path = path.join(book_path, 'hdocbook.json');
+        
+        let hdocbook = {};
+        try {
+            hdocbook = require(hdocbook_path);
+        } catch (e) {
+            console.log(`File not found: ${hdocbook_path}\n`);
+            console.log('hdoc create needs to be run in the root of a HDoc Book.\n');
+            process.exit(1);
+        }
+
+        // Get paths from breadcrumb builder
+        let nav_paths = hdoc.build_breadcrumbs(hdocbook.navigation.items);
+        for (const key in nav_paths) {
+            if (nav_paths.hasOwnProperty(key)) {
+                for (let i = 0; i < nav_paths[key].length; i++) {
+                    if (!processed_links[nav_paths[key][i].link]) {
+                        nav_paths[key][i].path = path.join(source_path, nav_paths[key][i].link);
+                        await add_doc(nav_paths[key][i]);
+                    }
+                }
+            }
+        }
+        console.log('\n-----------------------');
+        console.log(' Docs Creation Summary');
+        console.log('-----------------------\n');
+        console.log(`  Files Created: ${file_count}`);
+        console.log(`Folders Created: ${folder_count}\n`);
+    };
+
+    const add_doc = async function(doc_info) {
+
+        // Does folder exist? Create if not
+        const folder = path.dirname(doc_info.path);
+        if (!fs.existsSync(folder)) {
+            try {
+                fs.mkdirSync(folder, true);
+                console.log('Folder created:', folder);
+                folder_count++;
+            } catch {
+                console.log('\nError creating folder', folder, ':', e);
+                return;
+            }
+        }
+
+        // Does file exist? Create if not
+        if (!fs.existsSync(doc_info.path + '.md') && !fs.existsSync(doc_info.path + '.htm') && !fs.existsSync(doc_info.path + '.html')) {
+            try {
+                const file_path = doc_info.path + '.md';
+                fs.writeFileSync(file_path, `# ${doc_info.text}\n`);
+                console.log('  File created:', file_path);
+                processed_links[doc_info.link] = true;
+                file_count++;
+            } catch (e) {
+                console.log('\nError creating file', doc_info.path, ':', e);
+            }
+        }
+    }
+
 })();

package/hdoc-db.js

@@ -1,95 +1,95 @@
-(function () {
-    'use strict';
-
-    const html2text = require('html-to-text'),
-        path = require('path'),
-        hdoc = require(path.join(__dirname, 'hdoc-module.js'));
-
-    exports.create_table = function (db, table_name, columns, virtual, fts5) {
-        let create_sql = ['CREATE'];
-        if (virtual) create_sql.push('VIRTUAL');
-        create_sql.push('TABLE');
-        create_sql.push(table_name);
-        if (fts5) create_sql.push('USING fts5(');
-        else create_sql.push('(');
-        for (let i = 0; i < columns.length; i++) {
-            if (i !== 0) create_sql.push(`,${columns[i]}`);
-            else create_sql.push(columns[i]);
-        }
-        create_sql.push(');');
-        try {
-            db.exec(create_sql.join('\n'));
-            return null;
-        } catch (e) {
-            return e;
-        }
-    };
-
-    exports.insert_record = function (db, table, columns, values) {
-        let response = {
-            success: false,
-            row_id: 0,
-            error: null
-        };
-        let queryProps = [];
-        queryProps.push(`INSERT INTO ${table}`);
-        let cols = '(';
-        let vals = 'VALUES (';
-        for (let i = 0; i < columns.length; i++) {
-            if (i === 0) {
-                cols += `${columns[i].replace('UNINDEXED', '').replace('INTEGER', '').trim()}`;
-                vals += '?';
-            } else {
-                cols += `, ${columns[i].replace('UNINDEXED', '').replace('INTEGER', '').trim()}`;
-                vals += ', ?';
-            }
-        }
-        cols += ')';
-        vals += ')';
-        queryProps.push(cols);
-        queryProps.push(vals);
-
-        try {
-            const stmt = db.prepare(queryProps.join(' '));
-            const info = stmt.run(values);
-            response.row_id = info.lastInsertRowid;
-            response.success = true;
-        } catch (e) {
-            response.error = e;
-        }
-        return response;
-    };
-
-    exports.transform_html_for_index = function (html_txt) {
-        let response = {
-            text: '',
-            preview: '',
-            fm_props: {}
-        };
-
-        // Get frontmatter properties
-        const fm_headers = hdoc.getHTMLFrontmatterHeader(html_txt);
-        response.fm_props = fm_headers.fm_properties;
-
-        // Convert HTML into plain text
-        response.text = html2text.convert(html_txt, {
-            ignoreHref: true,
-            ignoreImage: true,
-            uppercaseHeadings: false,
-            wordwrap: null
-        });
-
-        // Convert HTML into preview text
-        response.preview = html2text.convert(html_txt, {
-            baseElement: 'p',
-            ignoreHref: true,
-            ignoreImage: true,
-            uppercaseHeadings: false,
-            wordwrap: null
-        });
-        response.preview = hdoc.truncate_string(response.preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
-        return response;
-    };
-
-
+(function () {
+    'use strict';
+
+    const html2text = require('html-to-text'),
+        path = require('path'),
+        hdoc = require(path.join(__dirname, 'hdoc-module.js'));
+
+    exports.create_table = function (db, table_name, columns, virtual, fts5) {
+        let create_sql = ['CREATE'];
+        if (virtual) create_sql.push('VIRTUAL');
+        create_sql.push('TABLE');
+        create_sql.push(table_name);
+        if (fts5) create_sql.push('USING fts5(');
+        else create_sql.push('(');
+        for (let i = 0; i < columns.length; i++) {
+            if (i !== 0) create_sql.push(`,${columns[i]}`);
+            else create_sql.push(columns[i]);
+        }
+        create_sql.push(');');
+        try {
+            db.exec(create_sql.join('\n'));
+            return null;
+        } catch (e) {
+            return e;
+        }
+    };
+
+    exports.insert_record = function (db, table, columns, values) {
+        let response = {
+            success: false,
+            row_id: 0,
+            error: null
+        };
+        let queryProps = [];
+        queryProps.push(`INSERT INTO ${table}`);
+        let cols = '(';
+        let vals = 'VALUES (';
+        for (let i = 0; i < columns.length; i++) {
+            if (i === 0) {
+                cols += `${columns[i].replace('UNINDEXED', '').replace('INTEGER', '').trim()}`;
+                vals += '?';
+            } else {
+                cols += `, ${columns[i].replace('UNINDEXED', '').replace('INTEGER', '').trim()}`;
+                vals += ', ?';
+            }
+        }
+        cols += ')';
+        vals += ')';
+        queryProps.push(cols);
+        queryProps.push(vals);
+
+        try {
+            const stmt = db.prepare(queryProps.join(' '));
+            const info = stmt.run(values);
+            response.row_id = info.lastInsertRowid;
+            response.success = true;
+        } catch (e) {
+            response.error = e;
+        }
+        return response;
+    };
+
+    exports.transform_html_for_index = function (html_txt) {
+        let response = {
+            text: '',
+            preview: '',
+            fm_props: {}
+        };
+
+        // Get frontmatter properties
+        const fm_headers = hdoc.getHTMLFrontmatterHeader(html_txt);
+        response.fm_props = fm_headers.fm_properties;
+
+        // Convert HTML into plain text
+        response.text = html2text.convert(html_txt, {
+            ignoreHref: true,
+            ignoreImage: true,
+            uppercaseHeadings: false,
+            wordwrap: null
+        });
+
+        // Convert HTML into preview text
+        response.preview = html2text.convert(html_txt, {
+            baseElement: 'p',
+            ignoreHref: true,
+            ignoreImage: true,
+            uppercaseHeadings: false,
+            wordwrap: null
+        });
+        response.preview = hdoc.truncate_string(response.preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
+        return response;
+    };
+
+
 })();

package/hdoc-help.js

@@ -1,41 +1,41 @@
-(function () {
-    'use strict';
-
-    exports.run = function() {
-        
-        // STEVE: The purpose of this function is to output information about hdoc arguments
-        const helpText = `
-Command Line Usage
-
-    hdoc <command> [switches]
-
-Commands
-
- - build
-    Performs a local build of the book, and outputs as a ZIP file. Use non-mandatory argument '--set-version 1.2.3' to set the version number of the built book
-
- - createDocs
-    Creates folder structure and markdown documents as defined in the HDocBook navigation item links 
-
- - help
-    Outputs available arguments and switches
-
- - init
-    Initializes a new HDocBook project from a template, using runtime input variables
-
- - serve
-    Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
-
- - stats
-    Returns statistics regarding the book you are working on. Supports a -v switch for verbose output
-
- - validate
-    Validates the book content
-
-Example
-
-    hdoc stats -v
-`;
-        console.log(helpText);
-    };
+(function () {
+    'use strict';
+
+    exports.run = function() {
+        
+        // STEVE: The purpose of this function is to output information about hdoc arguments
+        const helpText = `
+Command Line Usage
+
+    hdoc <command> [switches]
+
+Commands
+
+ - build
+    Performs a local build of the book, and outputs as a ZIP file. Use non-mandatory argument '--set-version 1.2.3' to set the version number of the built book
+
+ - createDocs
+    Creates folder structure and markdown documents as defined in the HDocBook navigation item links 
+
+ - help
+    Outputs available arguments and switches
+
+ - init
+    Initializes a new HDocBook project from a template, using runtime input variables
+
+ - serve
+    Starts a local web server on port 3000, serving the content. Supports a -port N to use a different port
+
+ - stats
+    Returns statistics regarding the book you are working on. Supports a -v switch for verbose output
+
+ - validate
+    Validates the book content
+
+Example
+
+    hdoc stats -v
+`;
+        console.log(helpText);
+    };
 })();

package/hdoc-init.js

@@ -9,34 +9,34 @@
     // Configure prompt module preferences
     prompt.message = false;
     const promptProps = [{
-            name: 'id',
-            description: 'Document ID',
-            validator: /^[a-z][a-z0-9-]+[a-z0-9]$/,
-            warning: 'Document ID must only contain lower case letters, decimal digits and dashes.',
-            required: true
-        },
-        {
-            name: 'title',
-            description: 'Title',
-            required: true
-        },
-        {
-            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
-        }
+        name: 'id',
+        description: 'Document ID',
+        validator: /^[a-z][a-z0-9-]+[a-z0-9]$/,
+        warning: 'Document ID must only contain lower case letters, decimal digits and dashes.',
+        required: true
+    },
+    {
+        name: 'title',
+        description: 'Title',
+        required: true
+    },
+    {
+        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
+    }
     ];
 
     const createBook = function (server_path, source_path, docProps) {
@@ -108,6 +108,11 @@
                 console.log('Updated:', packageFilePath);
             });
 
+            // Rename gitignore to .gitignore
+            const gitignorePath = path.join(source_path, 'gitignore');
+            const newGitignorePath = path.join(source_path, '.gitignore');
+            fs.renameSync(gitignorePath, newGitignorePath);
+
         } else {
             console.error('Template path does not exist:', templatePath);
             process.exit(1);
@@ -123,8 +128,8 @@
         // those files into place, with a few variable replacements.  
 
         console.log('Hornbill HDocBook Init', '\r\n');
-        
-        const curr_dirs =  source_path.split(path.sep);
+
+        const curr_dirs = source_path.split(path.sep);
         let doc_id = curr_dirs[curr_dirs.length - 1];
 
         prompt.start();