docgen-tool 6.4.1 → 6.4.2

package/dist/cli/cli.js

@@ -1,10 +1,8 @@
 #!/usr/bin/env node
-import { createRequire } from "node:module";
 import { program } from "commander";
 import path, { join, resolve } from "node:path";
 import { build, createServer } from "vite";
 import react from "@vitejs/plugin-react";
-import { nodePolyfills } from "vite-plugin-node-polyfills";
 import dotenv from "dotenv";
 import pico from "picocolors";
 import path$1 from "path";
@@ -14,7 +12,14 @@ import schemaValidator from "z-schema";
 import fs$1, { accessSync, constants } from "node:fs";
 import StyleDictionary from "style-dictionary";
 const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
-	const version$1 = setVersion || rawParameters.version, releaseDate = setReleaseDate || rawParameters.date, currentDate = /* @__PURE__ */ new Date(), date = currentDate.toLocaleDateString("en-GB"), time = currentDate.toLocaleTimeString("en-US", { hour12: false }), year = currentDate.getFullYear().toString(), attribution = `Created by DocGen ${version$1} on ${date} at ${time}.`, webFooter = `Version ${version$1} released on ${releaseDate}`;
+	const version$1 = setVersion || rawParameters.version;
+	const releaseDate = setReleaseDate || rawParameters.date;
+	const currentDate = /* @__PURE__ */ new Date();
+	const date = currentDate.toLocaleDateString("en-GB");
+	const time = currentDate.toLocaleTimeString("en-US", { hour12: false });
+	const year = currentDate.getFullYear().toString();
+	const attribution = `Created by DocGen ${version$1} on ${date} at ${time}.`;
+	const webFooter = `Version ${version$1} released on ${releaseDate}`;
 	return {
 		...rawParameters,
 		attribution,
@@ -23,22 +28,27 @@ const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
 		version: version$1,
 		releaseDate
 	};
-}, readFile = async (filePath) => {
+};
+const readFile = async (filePath) => {
 	const normalized = path$1.normalize(filePath);
 	try {
-		const content = await promises.readFile(normalized, { encoding: "utf8" });
-		return content?.replace(/^\uFEFF/, "");
+		return (await promises.readFile(normalized, { encoding: "utf8" }))?.replace(/^\uFEFF/, "");
 	} catch (error) {
-		if (console.log(pico.red(`Error reading file: ${normalized}`)), error instanceof Error) console.log(pico.dim(error.message));
+		console.log(pico.red(`Error reading file: ${normalized}`));
+		if (error instanceof Error) console.log(pico.dim(error.message));
 	}
-}, copyDirectory = async (source, destination, verbose) => {
-	const normalizedSource = path$1.normalize(source), normalizedDestination = path$1.normalize(destination);
+};
+const copyDirectory = async (source, destination, verbose) => {
+	const normalizedSource = path$1.normalize(source);
+	const normalizedDestination = path$1.normalize(destination);
 	try {
 		await fs.copySync(normalizedSource, normalizedDestination);
 	} catch (error) {
-		if (console.log(pico.red("Error copying directory: " + normalizedSource + " to " + normalizedDestination)), verbose === true) console.log(pico.red(error));
+		console.log(pico.red("Error copying directory: " + normalizedSource + " to " + normalizedDestination));
+		if (verbose === true) console.log(pico.red(error));
 	}
-}, schemas = {
+};
+var schemas = {
 	parameters: {
 		title: "DocGen Parameters Schema",
 		type: "object",
@@ -166,13 +176,18 @@ const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
 			}
 		}] }
 	}
-}, validateJSON = ({ key, data, verbose }) => {
-	let schema = schemas[key], validator = new schemaValidator({}), valid = validator.validate(data, schema);
+};
+const validateJSON = ({ key, data, verbose }) => {
+	let schema = schemas[key];
+	let validator = new schemaValidator({});
+	let valid = validator.validate(data, schema);
 	if (!valid) {
-		if (console.log(pico.red(`Error parsing required file: ${key}.json (failed schema validation)`)), verbose === true) console.log(pico.red(validator.getLastError().message));
+		console.log(pico.red(`Error parsing required file: ${key}.json (failed schema validation)`));
+		if (verbose === true) console.log(pico.red(validator.getLastError().message));
 	}
 	return valid;
-}, loadInputs = async ({ inputPath, verbose }) => {
+};
+const loadInputs = async ({ inputPath, verbose }) => {
 	const inputConfig = {
 		parameters: null,
 		contents: []
@@ -191,24 +206,27 @@ const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
 				verbose
 			})) inputConfig[key] = file;
 		} catch (error) {
-			if (console.log(pico.red("Error parsing required file: " + key + ".json (invalid JSON)")), verbose === true) console.log(pico.red(error));
+			console.log(pico.red("Error parsing required file: " + key + ".json (invalid JSON)"));
+			if (verbose === true) console.log(pico.red(error));
 		}
-		const extra = {
+		inputConfig.contents.push({
 			heading: "Extra",
 			column: 5,
 			pages: [{
 				title: "Release notes",
 				source: "release-notes.md"
 			}]
-		};
-		return inputConfig.contents.push(extra), {
+		});
+		return {
 			rawParameters: inputConfig.parameters,
 			contents: inputConfig.contents
 		};
 	} catch (error) {
-		if (console.log(pico.red("Error loading required JSON metadata files")), verbose === true) console.log(pico.red(error));
+		console.log(pico.red("Error loading required JSON metadata files"));
+		if (verbose === true) console.log(pico.red(error));
 	}
-}, sortPages = ({ contents }) => {
+};
+const sortPages = ({ contents }) => {
 	return contents.reduce((acc, section) => {
 		const { column } = section;
 		return {
@@ -222,30 +240,42 @@ const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
 		4: [],
 		5: []
 	});
-}, findPackageRoot = (start = import.meta.dirname) => {
+};
+const findPackageRoot = (start = import.meta.dirname) => {
 	let dir = start;
 	while (true) {
 		try {
-			return accessSync(join(dir, "package.json"), constants.R_OK), dir;
+			accessSync(join(dir, "package.json"), constants.R_OK);
+			return dir;
 		} catch {}
 		const parent = resolve(dir, "..");
 		if (parent === dir) throw new Error("package root not found");
 		dir = parent;
 	}
-}, findTemplateDir = (start = import.meta.dirname) => {
-	const root = findPackageRoot(start), candidates = [join(root, "src", "template"), join(root, "dist", "template")];
+};
+const findTemplateDir = (start = import.meta.dirname) => {
+	const root = findPackageRoot(start);
+	const candidates = [join(root, "src", "template"), join(root, "dist", "template")];
 	for (const dir of candidates) try {
-		return accessSync(dir, constants.R_OK), dir;
+		accessSync(dir, constants.R_OK);
+		return dir;
 	} catch {}
 	throw new Error(`template directory not found under ${root}`);
-}, findAppDir = (start = import.meta.dirname) => {
-	const root = findPackageRoot(start), candidates = [join(root, "src", "app"), join(root, "dist", "app")];
+};
+const findAppDir = (start = import.meta.dirname) => {
+	const root = findPackageRoot(start);
+	const candidates = [join(root, "src", "app"), join(root, "dist", "app")];
 	for (const dir of candidates) try {
-		return accessSync(dir, constants.R_OK), dir;
+		accessSync(dir, constants.R_OK);
+		return dir;
 	} catch {}
 	throw new Error(`template directory not found under ${root}`);
-}, styleVariablesPlugin = (appDir, inputDir) => {
-	const cssVirtualModuleId = "virtual:style-variables.css", jsVirtualModuleId = "virtual:style-variables.js", resolvedCssPath = `\0${path.join(appDir, "virtual-style-variables.css")}`, resolvedJsPath = `\0${path.join(appDir, "virtual-style-variables.js")}`;
+};
+const styleVariablesPlugin = (appDir, inputDir) => {
+	const cssVirtualModuleId = "virtual:style-variables.css";
+	const jsVirtualModuleId = "virtual:style-variables.js";
+	const resolvedCssPath = `\0${path.join(appDir, "virtual-style-variables.css")}`;
+	const resolvedJsPath = `\0${path.join(appDir, "virtual-style-variables.js")}`;
 	return {
 		name: "style-variables-plugin",
 		enforce: "pre",
@@ -255,75 +285,78 @@ const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
 		},
 		async load(id) {
 			if (id === resolvedCssPath || id === resolvedJsPath) {
-				const configPath = path.join(appDir, "styles/config.json"), configContent = fs$1.readFileSync(configPath, "utf-8"), config = JSON.parse(configContent);
+				const configPath = path.join(appDir, "styles/config.json");
+				const configContent = fs$1.readFileSync(configPath, "utf-8");
+				const config = JSON.parse(configContent);
 				config.source = [path.join(appDir, "styles/style-tokens/**/*.json")];
 				const themePath = path.join(inputDir, "theme.json");
 				if (fs$1.existsSync(themePath)) config.source.push(themePath);
 				const sd = new StyleDictionary(config);
-				if (id === resolvedCssPath) {
-					const files = await sd.formatPlatform("css");
-					return files[0]?.output;
-				}
-				if (id === resolvedJsPath) {
-					const files = await sd.formatPlatform("js");
-					return files[0]?.output;
-				}
+				if (id === resolvedCssPath) return (await sd.formatPlatform("css"))[0]?.output;
+				if (id === resolvedJsPath) return (await sd.formatPlatform("js"))[0]?.output;
 			}
 		},
 		handleHotUpdate({ file, server }) {
-			const isStyleToken = file.includes("/style-tokens/"), isTheme = file === path.join(inputDir, "theme.json");
+			const isStyleToken = file.includes("/style-tokens/");
+			const isTheme = file === path.join(inputDir, "theme.json");
 			if (!isStyleToken && !isTheme) return;
-			const ids = [resolvedCssPath, resolvedJsPath];
-			return ids.forEach((id) => {
+			[resolvedCssPath, resolvedJsPath].forEach((id) => {
 				const mod = server.moduleGraph.getModuleById(id);
 				if (mod) server.moduleGraph.invalidateModule(mod);
-			}), [];
+			});
+			return [];
 		}
 	};
-}, htmlTransformPlugin = (title) => {
+};
+const htmlTransformPlugin = (title) => {
 	return {
 		name: "html-transform",
 		transformIndexHtml(html) {
 			return html.replace(/%APP_TITLE%/g, title);
 		}
 	};
-}, watchInputDirPlugin = (inputDir) => {
+};
+const watchInputDirPlugin = (inputDir) => {
 	return {
 		name: "watch-input-dir",
 		configureServer(server) {
 			const watchPattern = path.join(inputDir, "**/*.{md,json,png}");
 			server.watcher.add(watchPattern);
 			const handleFileChange = (changedPath) => {
-				console.log(`Input file changed, reloading: ${path.relative(inputDir, changedPath)}`), server.ws.send({ type: "full-reload" });
+				console.log(`Input file changed, reloading: ${path.relative(inputDir, changedPath)}`);
+				server.ws.send({ type: "full-reload" });
 			};
-			server.watcher.on("add", handleFileChange), server.watcher.on("change", handleFileChange), server.watcher.on("unlink", handleFileChange);
+			server.watcher.on("add", handleFileChange);
+			server.watcher.on("change", handleFileChange);
+			server.watcher.on("unlink", handleFileChange);
 		}
 	};
 };
 dotenv.config({ path: path.resolve(process.cwd(), ".env") });
-const require = createRequire(import.meta.url), basePath = process.env.BASE_PATH || "/", generate = async (command, mode) => {
-	const inputDir = path.resolve(process.cwd(), command.input), outputDir = path.resolve(process.cwd(), command.output), inputs = await loadInputs({
+var basePath = process.env.BASE_PATH || "/";
+const generate = async (command, mode) => {
+	const inputDir = path.resolve(process.cwd(), command.input);
+	const outputDir = path.resolve(process.cwd(), command.output);
+	const inputs = await loadInputs({
 		inputPath: inputDir,
 		verbose: false
 	});
 	if (!inputs) throw new Error("Invalid DocGen input files, aborting...");
-	const { contents, rawParameters } = inputs, sortedPages = sortPages({ contents }), parameters = deriveParameters({
+	const { contents, rawParameters } = inputs;
+	const sortedPages = sortPages({ contents });
+	const parameters = deriveParameters({
 		rawParameters,
 		setVersion: command?.setVersion,
 		setReleaseDate: command?.setReleaseDate
-	}), appPath = findAppDir(import.meta.dirname), baseConfig = {
+	});
+	const appPath = findAppDir(import.meta.dirname);
+	const baseConfig = {
 		root: appPath,
 		publicDir: inputDir,
 		base: basePath,
-		resolve: { alias: {
-			"vite-plugin-node-polyfills/shims/process": require.resolve("vite-plugin-node-polyfills/shims/process"),
-			"vite-plugin-node-polyfills/shims/buffer": require.resolve("vite-plugin-node-polyfills/shims/buffer"),
-			"vite-plugin-node-polyfills/shims/global": require.resolve("vite-plugin-node-polyfills/shims/global")
-		} },
 		plugins: [
-			nodePolyfills({ include: ["buffer"] }),
 			styleVariablesPlugin(appPath, inputDir),
-			react({ exclude: /\/src\/app\/pdf\// }),
+			react({ exclude: [/\/src\/app\/pdf\//, /\/node_modules\//] }),
 			htmlTransformPlugin(parameters.title ?? "DocGen"),
 			...mode !== "build" ? [watchInputDirPlugin(inputDir)] : []
 		],
@@ -338,22 +371,32 @@ const require = createRequire(import.meta.url), basePath = process.env.BASE_PATH
 		...baseConfig,
 		build: {
 			outDir: outputDir,
-			emptyOutDir: true,
-			minify: false
+			emptyOutDir: true
 		}
 	});
 	else {
 		const server = await createServer(baseConfig);
-		await server.listen(), server.printUrls();
+		await server.listen();
+		server.printUrls();
 	}
-}, scaffold = async (command) => {
-	const inputDir = findTemplateDir(import.meta.dirname), outputDir = path.normalize(command.output + "/"), verbose = command.verbose === true;
-	console.log(pico.green("Creating scaffold template directory")), await copyDirectory(inputDir, outputDir, verbose);
-}, version = "6.4.1";
-if (program.version(version).usage("[command] [--option]"), program.command("scaffold").usage("[--option]").description("create a template input directory").option("-o, --output [path]", "path to the output directory (default: ./)", "./").option("-v, --verbose", "show verbose output including detailed errors").action((command) => {
+};
+const scaffold = async (command) => {
+	const inputDir = findTemplateDir(import.meta.dirname);
+	const outputDir = path.normalize(command.output + "/");
+	const verbose = command.verbose === true;
+	console.log(pico.green("Creating scaffold template directory"));
+	await copyDirectory(inputDir, outputDir, verbose);
+};
+program.version("6.4.2").usage("[command] [--option]");
+program.command("scaffold").usage("[--option]").description("create a template input directory").option("-o, --output [path]", "path to the output directory (default: ./)", "./").option("-v, --verbose", "show verbose output including detailed errors").action((command) => {
 	scaffold(command);
-}), program.command("dev").usage("[--option]").description("create a static website from an input directory").option("-i, --input [path]", "path to the input directory [default: ./]", "./").option("-o, --output [path]", "path to the output directory [default: ./output]", "./output").option("-p, --pdf", "create a PDF document").option("-s, --set-version [version]", "override parameters.version (useful for build tools) [default: false]", false).option("-R, --set-release-date [date]", "override parameters.date (useful for build tools) [default: false]", false).option("-v, --verbose", "show verbose output including detailed errors").action((command) => {
+});
+program.command("dev").usage("[--option]").description("create a static website from an input directory").option("-i, --input [path]", "path to the input directory [default: ./]", "./").option("-o, --output [path]", "path to the output directory [default: ./output]", "./output").option("-p, --pdf", "create a PDF document").option("-s, --set-version [version]", "override parameters.version (useful for build tools) [default: false]", false).option("-R, --set-release-date [date]", "override parameters.date (useful for build tools) [default: false]", false).option("-v, --verbose", "show verbose output including detailed errors").action((command) => {
 	generate(command, "dev");
-}), program.command("build").usage("[--option]").description("create a static website from an input directory").option("-i, --input [path]", "path to the input directory [default: ./]", "./").option("-o, --output [path]", "path to the output directory [default: ./output]", "./output").option("-p, --pdf", "create a PDF document").option("-s, --set-version [version]", "override parameters.version (useful for build tools) [default: false]", false).option("-R, --set-release-date [date]", "override parameters.date (useful for build tools) [default: false]", false).option("-v, --verbose", "show verbose output including detailed errors").action((command) => {
+});
+program.command("build").usage("[--option]").description("create a static website from an input directory").option("-i, --input [path]", "path to the input directory [default: ./]", "./").option("-o, --output [path]", "path to the output directory [default: ./output]", "./output").option("-p, --pdf", "create a PDF document").option("-s, --set-version [version]", "override parameters.version (useful for build tools) [default: false]", false).option("-R, --set-release-date [date]", "override parameters.date (useful for build tools) [default: false]", false).option("-v, --verbose", "show verbose output including detailed errors").action((command) => {
 	generate(command, "build");
-}), program.parse(process.argv), !process.argv.slice(2).length) program.help();
+});
+program.parse(process.argv);
+if (!process.argv.slice(2).length) program.help();
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docgen-tool",
   "type": "module",
-  "version": "6.4.1",
+  "version": "6.4.2",
   "description": "A tool for creating HTML and PDF documentation",
   "bin": "./dist/cli/cli.js",
   "files": [
@@ -37,8 +37,8 @@
   },
   "dependencies": {
     "@react-pdf/renderer": "^4.3.2",
-    "@tanstack/react-router": "^1.147.0",
-    "@vitejs/plugin-react": "5.0.2",
+    "@tanstack/react-router": "^1.150.0",
+    "@vitejs/plugin-react": "5.1.2",
     "cheerio": "^1.1.2",
     "classnames": "^2.5.1",
     "commander": "^14.0.2",
@@ -58,18 +58,17 @@
     "rehype-raw": "^7.0.0",
     "remark-gfm": "^4.0.1",
     "rolldown-vite": "^7.3.1",
-    "style-dictionary": "^5.1.3",
-    "vite": "npm:rolldown-vite@latest",
-    "vite-plugin-node-polyfills": "0.22.0",
+    "style-dictionary": "^5.1.4",
+    "vite": "8.0.0-beta.8",
     "z-schema": "^6.0.2"
   },
   "devDependencies": {
     "@prettier/plugin-oxc": "^0.1.3",
-    "@types/node": "^25.0.5",
+    "@types/node": "^25.0.9",
     "@types/react": "^19.2.8",
     "ncp": "^2.0.0",
-    "oxlint": "^1.38.0",
-    "prettier": "^3.7.4",
+    "oxlint": "^1.39.0",
+    "prettier": "^3.8.0",
     "rimraf": "^6.1.2",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3"