hdoc-tools 0.19.7 → 0.20.0

package/hdoc-db.js

@@ -1,125 +1,97 @@
-(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 = {
-            fm_props: {},
-            sections: []
-        };
-
-        //const divs = hdoc.getIDDivs(html_txt);
-
-        // Get frontmatter properties
-        const fm_headers = hdoc.getHTMLFrontmatterHeader(html_txt);
-        response.fm_props = fm_headers.fm_properties;
-
-        /*if (divs.length > 0) {
-            divs.forEach(div => {
-                // Convert HTML into plain text
-                let text = response.text = html2text.convert(div.html, {
-                    ignoreHref: true,
-                    ignoreImage: true,
-                    uppercaseHeadings: false,
-                    wordwrap: null
-                });
-                // Convert HTML into preview text
-                let preview = html2text.convert(div.html, {
-                    baseElement: 'p',
-                    ignoreHref: true,
-                    ignoreImage: true,
-                    uppercaseHeadings: false,
-                    wordwrap: null
-                });
-                preview = hdoc.truncate_string(preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
-                response.sections.push({
-                    id: div.id.replace('hb-doc-anchor-', ''),
-                    text: text,
-                    preview: preview
-                })
-            });
-        } else { */
-            // Convert HTML into plain text
-            let text = response.text = html2text.convert(html_txt, {
-                ignoreHref: true,
-                ignoreImage: true,
-                uppercaseHeadings: false,
-                wordwrap: null
-            });
-            // Convert HTML into preview text
-            let preview = html2text.convert(html_txt, {
-                baseElement: 'p',
-                ignoreHref: true,
-                ignoreImage: true,
-                uppercaseHeadings: false,
-                wordwrap: null
-            });
-            preview = hdoc.truncate_string(preview, 200, true).replace(/(?:\r\n|\r|\n)/g, ' ');
-            response.sections.push({
-                text: text,
-                preview: preview
-            })
-        //}
-        return response;
-    };
-
-
-})();
+(() => {
+	const html2text = require("html-to-text");
+	const path = require("node:path");
+	const hdoc = require(path.join(__dirname, "hdoc-module.js"));
+
+	exports.create_table = (db, table_name, columns, virtual, fts5) => {
+		const 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 = (db, table, columns, values) => {
+		const response = {
+			success: false,
+			row_id: 0,
+			error: null,
+		};
+		const 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 = (html_txt) => {
+		const response = {
+			fm_props: {},
+			sections: [],
+		};
+
+		// 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
+		let preview = html2text.convert(html_txt, {
+			baseElement: "p",
+			ignoreHref: true,
+			ignoreImage: true,
+			uppercaseHeadings: false,
+			wordwrap: null,
+		});
+		preview = hdoc
+			.truncate_string(preview, 200, true)
+			.replace(/(?:\r\n|\r|\n)/g, " ");
+		response.sections.push({
+			text: response.text,
+			preview: preview,
+		});
+		//}
+		return response;
+	};
+})();

package/hdoc-help.js

@@ -1,51 +1,48 @@
-(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.
-    The book statistics do not include counts for any externally hosted content injected into the book content using the [[INCLUDE]] tags.
-
- - validate
-    Validates the book content
-
- - bump
-    Updates the semantic version number of the current book. If no options are specified, then the default of patch is applied:
-    - major - updates the major version of the book. i.e. - 1.4.5 would become 2.0.0
-    - 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
-`;
-      console.log(helpText);
-   };
-})();
+(() => {
+	exports.run = () => {
+		// 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.
+    The book statistics do not include counts for any externally hosted content injected into the book content using the [[INCLUDE]] tags.
+
+ - validate
+    Validates the book content
+
+ - bump
+    Updates the semantic version number of the current book. If no options are specified, then the default of patch is applied:
+    - major - updates the major version of the book. i.e. - 1.4.5 would become 2.0.0
+    - 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
+`;
+		console.log(helpText);
+	};
+})();