@office-kit/pptx-dev 0.13.0 → 0.14.0

package/README.md

@@ -131,7 +131,17 @@ npm run check
 npm run build
 ```
 
-`check` runs TypeScript; `build` writes `deck.pptx`. Compilation alone does not
+`check` runs TypeScript, then `office-pptx check`, which builds the deck and
+measures every text box with the preview's layout engine. It fails on text that
+runs out of its shape, and warns about text that only spills into the box's inner
+margins, text smaller than 10pt (`--min-font-size` changes the floor), a word split
+across lines, and a wrapped paragraph that ends on a line of one or two characters.
+When a width had to be estimated (a font the preview does not bundle, such as any
+Japanese font), it fails only on text more than a line's height out of its shape
+(counting what spills above and below a centred box together) and warns about
+smaller overflows. Table and chart text is not
+measured. `build`
+writes `deck.pptx`. Compilation alone does not
 perform TypeScript checking, so run both before delivery. Exported charts, text,
 images and tables remain editable. The renderer previews the serialized PPTX,
 but is not a guarantee of identical rendering in desktop presentation apps.
@@ -323,6 +333,7 @@ the amount of PPTX evaluation.
 - `office-pptx init <new-directory>` creates a TSX project without overwriting an existing directory.
 - `office-pptx dev <deck.tsx> [--port 4173]` watches the entry file's directory recursively.
 - `office-pptx build <deck.tsx> [--out deck.pptx]` writes a PPTX.
+- `office-pptx check <deck.tsx> [--min-font-size 10]` reports text overflow, text below the minimum size, split words and one- or two-character last lines; it exits with 1 when text runs out of its shape.
 - `office-pptx inspect <template.pptx>` prints slides, shape targets and layout references as JSON.
 
 Keep imported components, source PPTX files and images inside the watched

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { a as editorStore, i as initProject, n as exportDeck, o as sourceFingerprint, r as inspectTemplate, s as createDeckBuilder } from "./src-DASlwPDd.mjs";
+import { a as editorStore, i as initProject, n as exportDeck, o as sourceFingerprint, r as inspectTemplate, s as createDeckBuilder, t as buildDeck } from "./src-C1VTVnr6.mjs";
 import { n as renderDeck } from "./build-cpmt-r9Q.mjs";
 import { createRequire } from "node:module";
 import { chmod, lstat, mkdir, readFile, readdir, realpath, rename, rm, stat, unlink, writeFile } from "node:fs/promises";
@@ -7,12 +7,14 @@ import { basename, dirname, isAbsolute, join, relative, resolve, sep } from "nod
 import { watch } from "node:fs";
 import { createHash, randomBytes, randomUUID } from "node:crypto";
 import { getGroupChildren, getShapeBounds, getShapeId, getShapeKind, getShapeRotation, getShapeXmlString, getSlideShapes, getSlideXmlString, getSlides, loadPresentation } from "@office-kit/pptx";
+import { auditTextLayout } from "@office-kit/pptx-preview";
 import { mergeDecks } from "@office-kit/pptx-editor/merge";
 import { planPropEdit, planTextEdit, verifyTextEdit } from "@office-kit/pptx-dsl/source-edit";
 import { chromium } from "playwright";
 import { createServer } from "node:http";
 import MarkdownIt from "markdown-it";
 import { spawn } from "node:child_process";
+import { buildFontkitMeasurer } from "@office-kit/pptx-preview/node";
 //#region src/history.ts
 const SNAPSHOT_LIMIT = 64 * 1024 * 1024;
 const HISTORY_LIMIT = 128 * 1024 * 1024;
@@ -3276,18 +3278,51 @@ async function serveDeck(entry, port = 4173) {
 		}
 	};
 }
+const OVERFLOW_TOLERANCE_PX = 1;
+/** Builds the deck and measures its text: overflow, split words, stranded last lines, small type. */
+async function checkDeck(entry, minFontSizePt = 10) {
+	const { bytes } = await buildDeck(entry);
+	return auditTextLayout(await loadPresentation(bytes), {
+		measureText: buildFontkitMeasurer(),
+		reportBadWraps: true,
+		minFontSizePt
+	}).map((issue) => ({
+		severity: isError(issue) ? "error" : "warning",
+		message: `Slide ${issue.slideIndex + 1}, ${issue.shapeName ? `"${issue.shapeName}"` : "unnamed shape"}: ${describe(issue, minFontSizePt)}${issue.approximate ? " (estimated width)" : ""}`
+	}));
+}
+function isError(issue) {
+	if (issue.kind !== "overflow-x" && issue.kind !== "overflow-y") return false;
+	return issue.shapeOverflowPx > (issue.approximate ? issue.lineHeightPx : OVERFLOW_TOLERANCE_PX);
+}
+function describe(issue, minFontSizePt) {
+	switch (issue.kind) {
+		case "overflow-x": return issue.shapeOverflowPx > 0 ? `text runs ${issue.shapeOverflowPx}px past the sides of its shape` : `text spills ${issue.overflowPx}px into the side margins of its box`;
+		case "overflow-y": return issue.shapeOverflowPx > 0 ? `text runs ${issue.shapeOverflowPx}px past the top or bottom of its shape` : `text spills ${issue.overflowPx}px into the top or bottom margin of its box`;
+		case "soft-wrap": return `paragraph ${issue.paragraphIndex + 1} wraps onto ${issue.extraLines} more line(s)`;
+		case "word-break": return `paragraph ${issue.paragraphIndex + 1} breaks the word "${issue.text}" across lines`;
+		case "short-last-line": return `paragraph ${issue.paragraphIndex + 1} ends on a line of only "${issue.text}"`;
+		case "small-font": return `text at ${issue.sizePt}pt is below ${minFontSizePt}pt`;
+	}
+}
 //#endregion
 //#region src/cli.ts
 const usage = `Usage: office-pptx init <new-directory>
        office-pptx dev <deck.tsx> [--port 4173]
        office-pptx build <deck.tsx> [--out deck.pptx]
+       office-pptx check <deck.tsx> [--min-font-size 10]
        office-pptx inspect <template.pptx>`;
+const OPTIONS = new Map([
+	["build", "--out"],
+	["dev", "--port"],
+	["check", "--min-font-size"]
+]);
 const [command, entry, ...args] = process.argv.slice(2);
 try {
 	if (command === "--help" || command === "-h") console.log(usage);
 	else {
 		if (!entry) throw new Error(usage);
-		const option = command === "build" ? "--out" : command === "dev" ? "--port" : void 0;
+		const option = OPTIONS.get(command);
 		if (args.length && (args.length !== 2 || !option || args[0] !== option || !args[1])) throw new Error(`Unexpected arguments: ${args.join(" ")}\n${usage}`);
 		if (command === "init") {
 			const directory = await initProject(entry);
@@ -3297,6 +3332,14 @@ try {
 			const output = resolve(args[1] ?? "deck.pptx");
 			const result = await exportDeck(entry, output);
 			console.log(`Wrote ${output} (${result.slides.length} slides)`);
+		} else if (command === "check") {
+			const minFontSizePt = args[1] === void 0 ? void 0 : Number(args[1]);
+			if (minFontSizePt !== void 0 && !(minFontSizePt > 0)) throw new Error("Minimum font size must be a positive number of points.");
+			const findings = await checkDeck(entry, minFontSizePt);
+			for (const finding of findings) console.log(`${finding.severity}: ${finding.message}`);
+			const errors = findings.filter((finding) => finding.severity === "error").length;
+			console.log(`${errors} error(s), ${findings.length - errors} warning(s) in the slide text layout.`);
+			if (errors > 0) process.exitCode = 1;
 		} else if (command === "dev") {
 			const port = args[1] === void 0 ? 4173 : Number(args[1]);
 			if (!Number.isInteger(port) || port < 0 || port > 65535) throw new Error("Port must be an integer between 0 and 65535.");