npm - docgen-tool - Versions diffs - 6.3.1 → 6.4.1 - Mend

docgen-tool 6.3.1 → 6.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/dist/app/pdf/pdf-generator/pdf-page/pdf-html-block/custom-renderers/custom-renderers.tsx CHANGED Viewed

@@ -13,7 +13,7 @@ declare const __BASE_PATH__: string;
   (and renderers.tsx for more details)
 */
-export const customRenderers = ({ options }) => ({
+export const customRenderers = () => ({
   div: (payload) => {
     const { children, style, element } = payload;
     const classNames = element.classList.toString();
@@ -27,14 +27,24 @@ export const customRenderers = ({ options }) => ({
     return <View style={style}>{children}</View>;
   },
   pre: (payload) => {
-    const { children, element, style } = payload;
-    //strip and handle code blocks
-    const $ = cheerio.load(element.content.join());
+    const { element, style } = payload;
+    const html = element.innerHTML ?? '';
+    const $ = cheerio.load(html);
     const code = $('code');
-    if (code.length) {
-      return <Text style={style}>{code.text().trim()}</Text>;
-    }
-    return <Text style={style}>{children}</Text>;
+    const text = code.length ? code.text() : $.text();
+    // Preserve indentation and multiple spaces with Non-Breaking Spaces
+    // to ensure react-pdf doesn't collapse them
+    const formattedText = text
+      // Trim spaces at the start
+      .replace(/^ +/gm, (match) => '\u00A0'.repeat(match.length))
+      // preserve internal indentation
+      .replace(/ {2,}/g, (match) => '\u00A0'.repeat(match.length))
+      // consistent tab width
+      .replace(/\t/g, '\u00A0\u00A0')
+      .trimEnd();
+    return <Text style={style}>{formattedText}</Text>;
   },
   img: (payload) => {
     const { element, style } = payload;

package/dist/app/pdf/pdf-generator/pdf-page/pdf-html-block/pdf-html-block.tsx CHANGED Viewed

@@ -3,12 +3,12 @@ import Html from 'react-pdf-html-simple';
 import { fontSize } from '../../pdf-styles/pdf-styles.ts';
 import { customRenderers } from './custom-renderers/custom-renderers.tsx';
-export const PdfHtmlBlock = ({ page, options, stylesheet }) => {
+export const PdfHtmlBlock = ({ page, stylesheet }) => {
   return (
     <Html
       style={{ fontSize }}
       stylesheet={stylesheet}
-      renderers={customRenderers({ options })}
+      renderers={customRenderers()}
     >
       {page}
     </Html>

package/dist/app/pdf/pdf-generator/pdf-page/pdf-page.tsx CHANGED Viewed

@@ -7,18 +7,14 @@ import {
   getHtmlStyleSheet,
 } from '../pdf-styles/pdf-styles.ts';
-export const PdfPage = ({ page, parameters, options, styleVariables }) => {
-  const reactPdfStyles = StyleSheet.create(getPdfStyleSheet(styleVariables));
+export const PdfPage = ({ page, parameters, styleVariables }) => {
+  const reactPdfStyles = StyleSheet.create(getPdfStyleSheet());
   const htmlStylesheet = getHtmlStyleSheet(styleVariables);
   return (
     <Page size="A4" style={reactPdfStyles.page}>
       <View>
-        <PdfHtmlBlock
-          page={page}
-          options={options}
-          stylesheet={htmlStylesheet}
-        />
+        <PdfHtmlBlock page={page} stylesheet={htmlStylesheet} />
       </View>
       <PdfFooter parameters={parameters} />
     </Page>

package/dist/app/pdf/pdf-generator/pdf-styles/pdf-styles.ts CHANGED Viewed

@@ -4,7 +4,7 @@ import { getPdfTableStyles } from './pdf-table-styles.ts';
 export const fontSize = 10;
-export const getPdfStyleSheet = (styles: any) => ({
+export const getPdfStyleSheet = () => ({
   page: {
     paddingTop: 35,
     paddingBottom: 65,
@@ -25,15 +25,6 @@ export const getHtmlStyleSheet = (styles: any) => {
   const pdfAdmonitionsStyles = getPdfAdmonitionsStyles(styles);
   const pdfTableStyles = getPdfTableStyles(styles);
-  const styleInfo = {
-    color: styles.ColorTextInfo,
-    backgroundColor: styles.ColorBackgroundInfo,
-    borderLeft: `5px solid ${styles.ColorBorderInfo}`,
-    padding: styles.SizeMessagePadding,
-    marginLeft: 0,
-    marginRight: 0,
-  };
   return {
     'h1, h2, h3, h4, h5, h6': {
       fontWeight: 'bold',
@@ -133,7 +124,6 @@ export const getHtmlStyleSheet = (styles: any) => {
     li_content: {
       textAlign: 'left',
       flexGrow: 1,
-      flexBasis: 1,
     },
     thead: {
       display: 'flex',

package/dist/app/pdf/pdf-generator/react-pdf.tsx CHANGED Viewed

@@ -53,7 +53,6 @@ Font.register({
 export const Pdf = ({ loadedPages, styleVariables }) => {
   const parameters = __DOCGEN_PARAMETERS__;
-  const options = {};
   const allSources = Object.values(__DOCGEN_PAGES__).flatMap((columns) =>
     columns.flatMap((section) => section.pages.map((p: any) => p.source)),
   );
@@ -67,7 +66,6 @@ export const Pdf = ({ loadedPages, styleVariables }) => {
             key={i}
             page={html}
             parameters={parameters}
-            options={options}
             styleVariables={styleVariables}
           />
         );

package/dist/app/pdf/pdf-generator/use-generate.pdf.tsx CHANGED Viewed

@@ -1,6 +1,6 @@
 import { useState, useEffect } from 'react';
 import * as styles from 'virtual:style-variables.js';
-import WorkerURL from './generate-pdf.worker.tsx?worker';
+import * as WorkerModule from './generate-pdf.worker.tsx?worker';
 export type TGeneratedPdf = {
   pdfBlob: Blob | null;
@@ -21,7 +21,7 @@ export const useGeneratePdf = () => {
       return;
     }
-    const worker = new WorkerURL();
+    const worker = new WorkerModule.default();
     worker.onmessage = (e) => {
       if (e.data.type === 'complete') {

package/dist/app/styles/style-tokens/colors.json CHANGED Viewed

@@ -90,17 +90,31 @@
     },
     "button": {
       "border": {
-        "@": { "value": "2px solid {color.primary.@}" },
-        "inverted": { "value": "2px solid {color.primary.@}" }
+        "@": {
+          "value": "2px solid {color.primary.@}"
+        },
+        "inverted": {
+          "value": "2px solid {color.primary.@}"
+        }
       },
       "background": {
-        "@": { "value": "{color.primary.@}" },
-        "hover": { "value": "#0042b4" },
-        "inverted": { "value": "#fff" }
+        "@": {
+          "value": "{color.primary.@}"
+        },
+        "hover": {
+          "value": "{color.primary.dark}"
+        },
+        "inverted": {
+          "value": "#fff"
+        }
       },
       "text": {
-        "@": { "value": "#fff" },
-        "inverted": { "value": "{color.primary.@}" }
+        "@": {
+          "value": "#fff"
+        },
+        "inverted": {
+          "value": "{color.primary.@}"
+        }
       },
       "shadow": {
         "value": "none"

package/dist/cli/cli.js CHANGED Viewed

@@ -26,9 +26,10 @@ const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
 }, readFile = async (filePath) => {
 	const normalized = path$1.normalize(filePath);
 	try {
-		return (await promises.readFile(normalized, { encoding: "utf8" }))?.replace(/^\uFEFF/, "");
+		const content = await promises.readFile(normalized, { encoding: "utf8" });
+		return content?.replace(/^\uFEFF/, "");
 	} catch (error) {
-		console.log(pico.red("Error reading file: " + normalized));
+		if (console.log(pico.red(`Error reading file: ${normalized}`)), 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);
@@ -243,7 +244,7 @@ const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
 		return accessSync(dir, constants.R_OK), dir;
 	} catch {}
 	throw new Error(`template directory not found under ${root}`);
-}, styleVariablesPlugin = (appDir) => {
+}, 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")}`;
 	return {
 		name: "style-variables-plugin",
@@ -256,6 +257,8 @@ const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
 			if (id === resolvedCssPath || id === resolvedJsPath) {
 				const configPath = path.join(appDir, "styles/config.json"), configContent = fs$1.readFileSync(configPath, "utf-8"), 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");
@@ -268,7 +271,8 @@ const deriveParameters = ({ rawParameters, setVersion, setReleaseDate }) => {
 			}
 		},
 		handleHotUpdate({ file, server }) {
-			if (!file.includes("/style-tokens/")) return;
+			const isStyleToken = file.includes("/style-tokens/"), isTheme = file === path.join(inputDir, "theme.json");
+			if (!isStyleToken && !isTheme) return;
 			const ids = [resolvedCssPath, resolvedJsPath];
 			return ids.forEach((id) => {
 				const mod = server.moduleGraph.getModuleById(id);
@@ -318,7 +322,7 @@ const require = createRequire(import.meta.url), basePath = process.env.BASE_PATH
 		} },
 		plugins: [
 			nodePolyfills({ include: ["buffer"] }),
-			styleVariablesPlugin(appPath),
+			styleVariablesPlugin(appPath, inputDir),
 			react({ exclude: /\/src\/app\/pdf\// }),
 			htmlTransformPlugin(parameters.title ?? "DocGen"),
 			...mode !== "build" ? [watchInputDirPlugin(inputDir)] : []
@@ -334,7 +338,8 @@ const require = createRequire(import.meta.url), basePath = process.env.BASE_PATH
 		...baseConfig,
 		build: {
 			outDir: outputDir,
-			emptyOutDir: true
+			emptyOutDir: true,
+			minify: false
 		}
 	});
 	else {
@@ -344,7 +349,7 @@ const require = createRequire(import.meta.url), basePath = process.env.BASE_PATH
 }, 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.3.1";
+}, 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) => {
 	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) => {

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "docgen-tool",
   "type": "module",
-  "version": "6.3.1",
+  "version": "6.4.1",
   "description": "A tool for creating HTML and PDF documentation",
   "bin": "./dist/cli/cli.js",
   "files": [
@@ -17,59 +17,62 @@
     "preview:docs": "npx serve -s ./docs",
     "build:docs:gh": "tsx src/cli/cli.ts build -i src/docs -o ./docs && yarn copy:gh:files",
     "copy:gh:files": "node deploy/before-deploy-website.js",
-    "preview:style:variables": "rimraf src/app/styles/style-variables && npx style-dictionary build --config src/app/styles/config.json && yarn prettier:fix",
-    "test": "npm run prettier:check",
+    "preview:style:variables": "rimraf src/app/styles/style-variables && npx style-dictionary build --config src/app/styles/config.json && yarn formatting:fix",
+    "test": "npm run formatting:check",
     "test:run": "tsx src/cli/cli.ts build -i src/__test__/test-run -o src/__test__/test-run-output",
     "test:scaffold": "tsx src/cli/cli.ts scaffold -o src/__test__/test-run-output",
     "test:prod:run": "./dist/cli/cli.js build -i src/__test__/test-run -o ../source/__test__/test-run-output",
-    "prettier:check": "prettier --check 'src/**/*.{ts,js,tsx,jsx,json,css}'",
-    "prettier:fix": "prettier --write 'src/**/*.{ts,js,tsx,jsx,json,css}'",
+    "formatting:check": "prettier --check 'src/**/*.{ts,js,tsx,jsx,json,css}'",
+    "formatting:fix": "prettier --write 'src/**/*.{ts,js,tsx,jsx,json,css}'",
+    "lint:check": "oxlint .",
+    "lint:fix": "oxlint --fix .",
     "test:publish": "sh ./src/__test__/test-publish/test-publish.sh",
     "prepare": "husky"
   },
   "lint-staged": {
-    "src/**/*.{ts,js,tsx,jsx,json,css}": "prettier --write"
+    "src/**/*.{ts,js,tsx,jsx,json,css}": [
+      "oxlint --fix",
+      "prettier --write"
+    ]
   },
   "dependencies": {
-    "@react-pdf/renderer": "^4.3.0",
-    "@tanstack/react-router": "^1.130.12",
-    "@vitejs/plugin-react": "^5.0.0",
+    "@react-pdf/renderer": "^4.3.2",
+    "@tanstack/react-router": "^1.147.0",
+    "@vitejs/plugin-react": "5.0.2",
     "cheerio": "^1.1.2",
     "classnames": "^2.5.1",
-    "commander": "^14.0.0",
+    "commander": "^14.0.2",
     "dotenv": "^17.2.3",
-    "fs-extra": "^11.3.0",
+    "fs-extra": "^11.3.3",
     "husky": "^9.1.7",
-    "lint-staged": "^16.1.2",
-    "marked": "^16.2.0",
+    "lint-staged": "^16.2.7",
+    "marked": "^17.0.1",
     "picocolors": "^1.1.1",
-    "react": "^19.1.0",
-    "react-dom": "^19.1.0",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3",
     "react-icons": "^5.5.0",
     "react-markdown": "^10.1.0",
-    "react-pdf": "^10.2.0",
+    "react-pdf": "^10.3.0",
     "react-pdf-html-simple": "^2.1.4",
     "react-resize-detector": "^12.3.0",
     "rehype-raw": "^7.0.0",
     "remark-gfm": "^4.0.1",
-    "rolldown-vite": "^7.3.0",
-    "style-dictionary": "^5.1.1",
+    "rolldown-vite": "^7.3.1",
+    "style-dictionary": "^5.1.3",
     "vite": "npm:rolldown-vite@latest",
     "vite-plugin-node-polyfills": "0.22.0",
     "z-schema": "^6.0.2"
   },
   "devDependencies": {
-    "@eslint/js": "^9.31.0",
-    "@types/node": "^24.1.0",
-    "@types/react": "^19.1.13",
-    "eslint": "^9.31.0",
-    "eslint-config-prettier": "^10.1.8",
+    "@prettier/plugin-oxc": "^0.1.3",
+    "@types/node": "^25.0.5",
+    "@types/react": "^19.2.8",
     "ncp": "^2.0.0",
-    "prettier": "^3.6.2",
-    "rimraf": "^6.0.1",
-    "tsx": "^4.20.3",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.38.0"
+    "oxlint": "^1.38.0",
+    "prettier": "^3.7.4",
+    "rimraf": "^6.1.2",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
   },
   "repository": {
     "type": "git",

package/dist/app/views/assets/.DS_Store DELETED Viewed

Binary file

package/dist/app/views/assets/styles/.DS_Store DELETED Viewed

Binary file

package/dist/app/views/assets/styles/fonts/.DS_Store DELETED Viewed

Binary file