hdoc-tools 0.55.1 → 0.56.0

package/.puppeteerrc.cjs

@@ -7,6 +7,15 @@
 // Discovered by Puppeteer (cosmiconfig) walking up from node_modules/.../puppeteer
 // to this package root during install. skipDownload only affects provisioning,
 // not where the browser is launched from at runtime.
+const path = require("node:path");
+
 module.exports = {
 	skipDownload: true,
+	// Pin a fixed, user-independent cache dir inside the package root. Under a
+	// global install, postinstall runs as root (sudo) while `hdoc` later runs as
+	// a normal user; os.homedir() resolves to different homes for each, so the
+	// old ~/.cache/puppeteer default left the browser in root's home and the
+	// runtime launch (a normal user) never found it. Anchoring to __dirname makes
+	// install-time provisioning and runtime launch agree on one absolute path.
+	cacheDir: path.join(__dirname, ".cache", "puppeteer"),
 };

package/hdoc-install-browser.js

@@ -21,7 +21,6 @@
 (async () => {
 	const fs = require("node:fs");
 	const path = require("node:path");
-	const os = require("node:os");
 	const {
 		install,
 		computeExecutablePath,
@@ -42,12 +41,14 @@
 	const log = (msg) => console.log(`[hdoc-tools] ${msg}`);
 
 	// Resolve the cache directory the same way Puppeteer does at runtime:
-	// PUPPETEER_CACHE_DIR wins, otherwise the documented default. Keeping this
-	// aligned with runtime means we install to exactly where the browser is
-	// later launched from.
+	// PUPPETEER_CACHE_DIR wins, otherwise the fixed cacheDir declared in
+	// .puppeteerrc.cjs. Reading the shared config (rather than recomputing from
+	// os.homedir()) guarantees we install to exactly the path the browser is
+	// later launched from — critical for `sudo npm i -g`, where postinstall runs
+	// as root but `hdoc` runs as a normal user with a different home directory.
 	const cacheDir =
 		process.env.PUPPETEER_CACHE_DIR ||
-		path.join(os.homedir(), ".cache", "puppeteer");
+		require(path.join(__dirname, ".puppeteerrc.cjs")).cacheDir;
 
 	let platform;
 	try {

package/hdoc.js

@@ -128,7 +128,19 @@
 	let source_path = process.cwd();
 	let ui_path = path.join(__dirname, "ui");
 	let editor_path = path.join(__dirname, "editor", "dist");
-	let git_token = "";
+	// Default the GitHub token from the environment so nobody has to hand-pass a
+	// secret on the command line (and it never lands in shell history). GITHUB_TOKEN
+	// is the GitHub Actions / CI standard; GH_TOKEN is the gh-CLI convention. An
+	// explicit --git-token flag (parsed below) overrides either.
+	let git_token = process.env.GITHUB_TOKEN || process.env.GH_TOKEN || "";
+	// Track where the token came from purely so we can log it (masked) later — helps
+	// contributors confirm auth is active rather than silently falling back to the
+	// unauthenticated 60/hr limit because of a typo'd env var or wrong scope.
+	let git_token_source = process.env.GITHUB_TOKEN
+		? "GITHUB_TOKEN env"
+		: process.env.GH_TOKEN
+			? "GH_TOKEN env"
+			: "";
 	let command = ""; // Our command to run
 	let build_version = "";
 	let verbose = false;
@@ -170,6 +182,7 @@
 			x++;
 			if (x < process.argv.length) {
 				git_token = process.argv[x];
+				git_token_source = "--git-token flag";
 			}
 		} else if (process.argv[x].toLowerCase() === "--set-version") {
 			x++;
@@ -197,6 +210,24 @@
 	console.log("    Server Path:", __dirname);
 	console.log("  Document Path:", source_path, "\r\n");
 
+	// Confirm GitHub auth status for commands that pull contributor data, so a
+	// contributor can see at a glance whether the rate-limit-lifting token is
+	// actually in effect. Show only a short masked preview — never the full token.
+	if (command.toLowerCase() === "build" || command.toLowerCase() === "validate") {
+		if (git_token) {
+			const masked =
+				git_token.length > 8
+					? `${git_token.slice(0, 4)}…${git_token.slice(-2)}`
+					: "…";
+			console.log(`   GitHub Token: using ${git_token_source} [${masked}]`, "\r\n");
+		} else {
+			console.log(
+				"   GitHub Token: none — using unauthenticated GitHub API (60 requests/hour). Set GITHUB_TOKEN to raise the limit.",
+				"\r\n",
+			);
+		}
+	}
+
 
 	// Add validated-links.txt to .gitignore if it doesn't exist
 	const gitignorePath = path.join(source_path, ".gitignore");

package/package.json

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

package/schemas/hdocbook.schema.json

@@ -35,18 +35,17 @@
       "description": "The ID of the product family this book belongs to.",
       "enum": [
         "esp",
+        "com.hornbill.docmanager",
         "com.hornbill.boardmanager",
         "com.hornbill.customermanager",
-        "com.hornbill.collaboration",
-        "com.hornbill.docmanager",
         "com.hornbill.grc",
         "com.hornbill.itom",
         "com.hornbill.livechat",
-        "com.hornbill.pricingcalculator",
         "com.hornbill.projectmanager",
         "com.hornbill.servicemanager",
         "com.hornbill.suppliermanager",
         "com.hornbill.timesheetmanager",
+        "com.hornbill.collaboration",
         "appdev",
         "hdocs"
       ]