hdoc-tools 0.19.8 → 0.20.0

package/hdoc-ver.js

@@ -1,43 +1,43 @@
-(function () {
-    'use strict';
-
-    const fs = require('fs'),
-        path = require('path');
-
-    exports.run = function (source_path) {
-        console.log(`Retrieving book version...\n`);
-
-        // Get document ID
-        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.error('File not found: hdocbook-project.json:');
-            console.log(e, '\n');
-            console.error('hdoc ver needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-        const doc_id = hdocbook_project.docId;
-
-        const book_path = path.join(source_path, doc_id),
-            hdocbook_path = path.join(book_path, 'hdocbook.json');
-
-        let hdocbook_config;
-        try {
-            hdocbook_config = require(hdocbook_path);
-        } catch (e) {
-            console.error('File not found: hdocbook.json');
-            console.log(e, '\n');
-            console.error('hdoc ver needs to be run in the root of a HDoc Book.\n');
-            process.exit(1);
-        }
-        if (hdocbook_config.version && hdocbook_config.version !== '') {
-            console.log(`Book version: ${hdocbook_config.version}\n`);
-        } else {
-            console.error(`Error - this book has no version defined.\n`);
-            process.exit(1);
-        }
-    };
-
-})();
+(() => {
+	const fs = require("node:fs");
+	const path = require("node:path");
+
+	exports.run = (source_path) => {
+		console.log("Retrieving book version...\n");
+
+		// Get document ID
+		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.error("File not found: hdocbook-project.json:");
+			console.log(e, "\n");
+			console.error("hdoc ver needs to be run in the root of a HDoc Book.\n");
+			process.exit(1);
+		}
+		const doc_id = hdocbook_project.docId;
+
+		const book_path = path.join(source_path, doc_id);
+		const hdocbook_path = path.join(book_path, "hdocbook.json");
+
+		let hdocbook_config;
+		try {
+			hdocbook_config = require(hdocbook_path);
+		} catch (e) {
+			console.error("File not found: hdocbook.json");
+			console.log(e, "\n");
+			console.error("hdoc ver needs to be run in the root of a HDoc Book.\n");
+			process.exit(1);
+		}
+		if (hdocbook_config.version && hdocbook_config.version !== "") {
+			console.log(`Book version: ${hdocbook_config.version}\n`);
+		} else {
+			console.error("Error - this book has no version defined.\n");
+			process.exit(1);
+		}
+	};
+})();

package/hdoc.js

@@ -1,125 +1,143 @@
 #!/usr/bin/env node
-(async function () {
-   'use strict';
-
-   const preRun = require('./validateNodeVer.js'),
-      fs = require('fs'),
-      path = require('path'),
-      { trueCasePathSync } = require('true-case-path');
-
-   const packageFile = path.join(__dirname, 'package.json');
-
-   const { info, error } = console;
-   console.info = (arg) => {
-      info.call(console, `\x1b[33m${arg}\x1b[0m`);
-    };
-   console.error = (arg) => {
-      error.call(console, `\x1b[31m${arg}\x1b[0m`);
-    };
-
-
-   const getHdocPackageVersion = function (packagePath) {
-      if (fs.existsSync(packagePath)) {
-         try {
-            return JSON.parse(fs.readFileSync(packagePath, 'utf8')).version;
-         } catch (e) {
-            console.error('Could not parse package file: ', packagePath, ' - ', JSON.stringify(e));
-            process.exit(1);
-         }
-      } else {
-         console.error('Package file not found: ', packagePath);
-      }
-   };
-
-   // Default source path to working directory
-   let source_path = process.cwd();
-   let ui_path = path.join(__dirname, 'ui');
-   let git_token = '',
-      command = '', // Our command to run
-      build_version = '',
-      verbose = false,
-      gen_exclude = false,
-      bump_type = 'patch'; // To generate spellcheck exclusions for all files
-
-   // Get options from command args
-   for (let x = 0; x < process.argv.length; x++) {
-      // First two arguments are command, and script
-      if (x == 0 || x == 1)
-         continue;
-      // Third argument is command
-      if (x == 2) {
-         command = process.argv[x];
-
-         if (command === 'bump') {
-            x++;
-            if (x < process.argv.length) {
-               bump_type = process.argv[x];
-            }
-         }
-         continue;
-      }
-
-      if (process.argv[x] === '-v') {
-         verbose = true;
-      } else if (process.argv[x] == '-path') {
-         x++;
-         if (x < process.argv.length) {
-            source_path = process.argv[x];
-         }
-      } else if (process.argv[x] == '-ui-path') {
-         x++;
-         if (x < process.argv.length) {
-            ui_path = process.argv[x];
-         }
-      } else if (process.argv[x] == '--git-token') {
-         x++;
-         if (x < process.argv.length) {
-            git_token = process.argv[x];
-         }
-      } else if (process.argv[x] == '--set-version') {
-         x++;
-         if (x < process.argv.length) {
-            build_version = process.argv[x];
-         }
-      } else if (process.argv[x] == '-e') {
-         gen_exclude = true;
-      }
-   }
-   source_path = trueCasePathSync(source_path);
-
-   console.log('Hornbill HDocBook Tools v' + getHdocPackageVersion(packageFile), '\r\n');
-   console.log('    Server Path:', __dirname);
-   console.log('  Document Path:', source_path, '\r\n');
-
-   if (command == 'serve') {
-      const server = require(path.join(__dirname, 'hdoc-serve.js'));
-      server.run(ui_path, source_path);
-   } else if (command == 'build') {
-      const builder = require(path.join(__dirname, 'hdoc-build.js'));
-      await builder.run(source_path, verbose, git_token, false, gen_exclude, build_version);
-   } else if (command == 'createDocs') {
-      const creator = require(path.join(__dirname, 'hdoc-create.js'));
-      await creator.run(source_path);
-   } else if (command == 'validate') {
-      const builder = require(path.join(__dirname, 'hdoc-build.js'));
-      await builder.run(source_path, verbose, git_token, true, gen_exclude, build_version);
-   } else if (command == 'stats') {
-      const stats = require(path.join(__dirname, 'hdoc-stats.js'));
-      stats.run(ui_path, source_path, verbose);
-   } else if (command == 'init') {
-      const init = require(path.join(__dirname, 'hdoc-init.js'));
-      init.run(__dirname, source_path);
-   } else if (command == 'help') {
-      const help = require(path.join(__dirname, 'hdoc-help.js'));
-      help.run();
-   } else if (command == 'bump') {
-      const bump = require(path.join(__dirname, 'hdoc-bump.js'));
-      bump.run(source_path, bump_type);
-   } else if (command == 'ver') {
-      const ver = require(path.join(__dirname, 'hdoc-ver.js'));
-      ver.run(source_path);
-   } else {
-      console.error('Unknown command:', command, '\r\n');
-      console.log('Run hdoc help for information regarding this tool.\r\n');
-   }
-})();
+(async () => {
+	const preRun = require("./validateNodeVer.js");
+	const fs = require("node:fs");
+	const path = require("node:path");
+	const { trueCasePathSync } = require("true-case-path");
+
+	const packageFile = path.join(__dirname, "package.json");
+
+	const { info, error } = console;
+	console.info = (arg) => {
+		info.call(console, `\x1b[33m${arg}\x1b[0m`);
+	};
+	console.error = (arg) => {
+		error.call(console, `\x1b[31m${arg}\x1b[0m`);
+	};
+
+	const getHdocPackageVersion = (packagePath) => {
+		if (fs.existsSync(packagePath)) {
+			try {
+				return JSON.parse(fs.readFileSync(packagePath, "utf8")).version;
+			} catch (e) {
+				console.error(
+					"Could not parse package file: ",
+					packagePath,
+					" - ",
+					JSON.stringify(e),
+				);
+				process.exit(1);
+			}
+		} else {
+			console.error("Package file not found: ", packagePath);
+		}
+	};
+
+	// Default source path to working directory
+	let source_path = process.cwd();
+	let ui_path = path.join(__dirname, "ui");
+	let git_token = "";
+	let command = ""; // Our command to run
+	let build_version = "";
+	let verbose = false;
+	let gen_exclude = false;
+	let bump_type = "patch"; // To generate spellcheck exclusions for all files
+
+	// Get options from command args
+	for (let x = 0; x < process.argv.length; x++) {
+		// First two arguments are command, and script
+		if (x === 0 || x === 1) continue;
+		// Third argument is command
+		if (x === 2) {
+			command = process.argv[x];
+
+			if (command === "bump") {
+				x++;
+				if (x < process.argv.length) {
+					bump_type = process.argv[x];
+				}
+			}
+			continue;
+		}
+
+		if (process.argv[x] === "-v") {
+			verbose = true;
+		} else if (process.argv[x].toLowerCase() === "-path") {
+			x++;
+			if (x < process.argv.length) {
+				source_path = process.argv[x];
+			}
+		} else if (process.argv[x].toLowerCase() === "-ui-path") {
+			x++;
+			if (x < process.argv.length) {
+				ui_path = process.argv[x];
+			}
+		} else if (process.argv[x].toLowerCase() === "--git-token") {
+			x++;
+			if (x < process.argv.length) {
+				git_token = process.argv[x];
+			}
+		} else if (process.argv[x].toLowerCase() === "--set-version") {
+			x++;
+			if (x < process.argv.length) {
+				build_version = process.argv[x];
+			}
+		} else if (process.argv[x].toLowerCase() === "-e") {
+			gen_exclude = true;
+		}
+	}
+	source_path = trueCasePathSync(source_path);
+
+	console.log(
+		`Hornbill HDocBook Tools v${getHdocPackageVersion(packageFile)}`,
+		"\r\n",
+	);
+	console.log("    Server Path:", __dirname);
+	console.log("  Document Path:", source_path, "\r\n");
+
+	if (command.toLowerCase() === "serve") {
+		const server = require(path.join(__dirname, "hdoc-serve.js"));
+		server.run(ui_path, source_path);
+	} else if (command.toLowerCase() === "build") {
+		const builder = require(path.join(__dirname, "hdoc-build.js"));
+		await builder.run(
+			source_path,
+			verbose,
+			git_token,
+			false,
+			gen_exclude,
+			build_version,
+		);
+	} else if (command.toLowerCase() === "createdocs") {
+		const creator = require(path.join(__dirname, "hdoc-create.js"));
+		await creator.run(source_path);
+	} else if (command.toLowerCase() === "validate") {
+		const builder = require(path.join(__dirname, "hdoc-build.js"));
+		await builder.run(
+			source_path,
+			verbose,
+			git_token,
+			true,
+			gen_exclude,
+			build_version,
+		);
+	} else if (command.toLowerCase() === "stats") {
+		const stats = require(path.join(__dirname, "hdoc-stats.js"));
+		stats.run(ui_path, source_path, verbose);
+	} else if (command.toLowerCase() === "init") {
+		const init = require(path.join(__dirname, "hdoc-init.js"));
+		init.run(__dirname, source_path);
+	} else if (command.toLowerCase() === "help") {
+		const help = require(path.join(__dirname, "hdoc-help.js"));
+		help.run();
+	} else if (command.toLowerCase() === "bump") {
+		const bump = require(path.join(__dirname, "hdoc-bump.js"));
+		bump.run(source_path, bump_type);
+	} else if (command.toLowerCase() === "ver") {
+		const ver = require(path.join(__dirname, "hdoc-ver.js"));
+		ver.run(source_path);
+	} else {
+		console.error("Unknown command:", command, "\r\n");
+		console.log("Run hdoc help for information regarding this tool.\r\n");
+	}
+})();

package/package.json

@@ -1,62 +1,62 @@
 {
-  "name": "hdoc-tools",
-  "version": "0.19.8",
-  "description": "Hornbill HDocBook Development Support Tool",
-  "main": "hdoc.js",
-  "bin": {
-    "hdoc": "./hdoc.js"
-  },
-  "files": [
-    "hdoc.js",
-    "hdoc-db.js",
-    "hdoc-build.js",
-    "hdoc-build-db.js",
-    "hdoc-build-pdf.js",
-    "hdoc-bump.js",
-    "hdoc-create.js",
-    "hdoc-help.js",
-    "hdoc-init.js",
-    "hdoc-module.js",
-    "hdoc-serve.js",
-    "hdoc-stats.js",
-    "hdoc-validate.js",
-    "hdoc-ver.js",
-    "validateNodeVer.js",
-    "ui",
-    "custom_modules",
-    "templates",
-    "templates/init/.npmignore",
-    "templates/init/gitignore"
-  ],
-  "scripts": {
-    "preinstall": "node validateNodeVer",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "Hornbill Technologies Ltd",
-  "license": "ISC",
-  "dependencies": {
-    "american-british-english-translator": "^0.2.1",
-    "archiver": "7.0.1",
-    "axios": "^1.7.2",
-    "axios-retry": "^4.4.1",
-    "better-sqlite3": "^11.1.2",
-    "cheerio": "^1.0.0-rc.12",
-    "dree": "^5.0.7",
-    "express": "^4.19.2",
-    "fs-extra": "^11.2.0",
-    "html-entities": "^2.5.2",
-    "html-to-text": "^9.0.5",
-    "js-yaml": "^4.1.0",
-    "jsdom": "^24.1.0",
-    "markdown-it": "14.1.0",
-    "markdown-it-container": "^4.0.0",
-    "markdown-it-front-matter": "^0.2.4",
-    "mime-types": "^2.1.35",
-    "prompt": "^1.3.0",
-    "puppeteer": "^22.12.1",
-    "stream": "0.0.3",
-    "true-case-path": "^2.2.1",
-    "words-count": "^2.0.2",
-    "xml-formatter": "^3.6.2"
-  }
+	"name": "hdoc-tools",
+	"version": "0.20.0",
+	"description": "Hornbill HDocBook Development Support Tool",
+	"main": "hdoc.js",
+	"bin": {
+		"hdoc": "./hdoc.js"
+	},
+	"files": [
+		"hdoc.js",
+		"hdoc-db.js",
+		"hdoc-build.js",
+		"hdoc-build-db.js",
+		"hdoc-build-pdf.js",
+		"hdoc-bump.js",
+		"hdoc-create.js",
+		"hdoc-help.js",
+		"hdoc-init.js",
+		"hdoc-module.js",
+		"hdoc-serve.js",
+		"hdoc-stats.js",
+		"hdoc-validate.js",
+		"hdoc-ver.js",
+		"validateNodeVer.js",
+		"ui",
+		"custom_modules",
+		"templates",
+		"templates/init/.npmignore",
+		"templates/init/gitignore"
+	],
+	"scripts": {
+		"preinstall": "node validateNodeVer",
+		"test": "echo \"Error: no test specified\" && exit 1"
+	},
+	"author": "Hornbill Technologies Ltd",
+	"license": "ISC",
+	"dependencies": {
+		"american-british-english-translator": "^0.2.1",
+		"archiver": "7.0.1",
+		"axios": "^1.7.2",
+		"axios-retry": "^4.4.1",
+		"better-sqlite3": "^11.1.2",
+		"cheerio": "^1.0.0-rc.12",
+		"dree": "^5.0.7",
+		"express": "^4.19.2",
+		"fs-extra": "^11.2.0",
+		"html-entities": "^2.5.2",
+		"html-to-text": "^9.0.5",
+		"js-yaml": "^4.1.0",
+		"jsdom": "^24.1.0",
+		"markdown-it": "14.1.0",
+		"markdown-it-container": "^4.0.0",
+		"markdown-it-front-matter": "^0.2.4",
+		"mime-types": "^2.1.35",
+		"prompt": "^1.3.0",
+		"puppeteer": "^22.12.1",
+		"stream": "0.0.3",
+		"true-case-path": "^2.2.1",
+		"words-count": "^2.0.2",
+		"xml-formatter": "^3.6.2"
+	}
 }

package/templates/init/_hdocbook/hdocbook.json

@@ -1,23 +1,23 @@
-{
-    "docId": "--docId--",
-    "title": "--title--",
-    "description": "--description--",
-    "publicSource": "--publicSource--",
-    "productFamily": "hdocs",
-    "version": "0.0.1",
-    "audience": [
-        "public"
-    ],
-    "languages": [
-        "en"
-    ],
-    "navigation": {
-        "items": [
-            {
-                "text": "Introduction",
-                "expand": true
-            }
-        ]
-    },
-    "tags": []
-}
+{
+	"docId": "--docId--",
+	"title": "--title--",
+	"description": "--description--",
+	"publicSource": "--publicSource--",
+	"productFamily": "hdocs",
+	"version": "0.0.1",
+	"audience": [
+		"public"
+	],
+	"languages": [
+		"en"
+	],
+	"navigation": {
+		"items": [
+			{
+				"text": "Introduction",
+				"expand": true
+			}
+		]
+	},
+	"tags": []
+}

package/templates/init/hdocbook-project.json

@@ -1,10 +1,10 @@
-{
-    "docId": "hdoc-guide",
-    "pdfGeneration": {
-        "enable": true,
-        "exclude_paths": []
-    },
-    "validation": {
-        "exclude_links": []
-    }
-}
+{
+	"docId": "hdoc-guide",
+	"pdfGeneration": {
+		"enable": true,
+		"exclude_paths": []
+	},
+	"validation": {
+		"exclude_links": []
+	}
+}

package/templates/init/package.json

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