@u1f992/pdfdiff 0.3.0 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@u1f992/pdfdiff",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Visualize and quantify differences between two PDF files.",
   "main": "dist/index.js",
   "bin": {
@@ -8,7 +8,7 @@
   },
   "scripts": {
     "test": "node --test",
-    "test:cli": "node src/cli.js test/a.pdf test/b.pdf out --mask test/mask.pdf --dpi 300 && echo \"expected: Page 1, Addition: 7500, Deletion: 7500, Modification: 7500\"",
+    "test:cli": "node dist/cli.js test/a.pdf test/b.pdf out --mask test/mask.pdf --dpi 300 && echo \"expected: Page 1, Addition: 7500, Deletion: 7500, Modification: 7500\"",
     "build:version": "node scripts/version.ts",
     "build:wasm": "docker run --rm --volume .:/workdir --workdir /workdir --user root --entrypoint bash emscripten/emsdk:5.0.7 scripts/build-wasm.sh",
     "format:wasm": "docker run --rm --volume .:/workdir --workdir /workdir --user root --entrypoint bash emscripten/emsdk:5.0.7 scripts/build-wasm.sh format",

package/prettier.config.js

@@ -1,3 +1,3 @@
 const prettierConfig = {};
 
-export default prettierConfig;
+export default prettierConfig;

package/src/cli.ts

@@ -70,6 +70,17 @@ class PngWriterPool {
   }
 }
 
+// Errors always exit 2, following diff(1)'s 0/1/2 convention, so that with
+// --exit-code a caller can tell "differences found" (1) from a failed run.
+process.on("uncaughtException", (err) => {
+  console.error(err);
+  process.exit(2);
+});
+process.on("unhandledRejection", (err) => {
+  console.error(err);
+  process.exit(2);
+});
+
 const _wallSpan = perf.span("cli.wallTotal_ms");
 
 const {
@@ -83,6 +94,7 @@ const {
     "deletion-color": deletionColorHex,
     "modification-color": modificationColorHex,
     workers: workers_,
+    "exit-code": exitCode_,
     version,
     help,
   },
@@ -97,6 +109,7 @@ const {
     "deletion-color": { type: "string" },
     "modification-color": { type: "string" },
     workers: { type: "string" },
+    "exit-code": { type: "boolean" },
     version: { type: "boolean", short: "v" },
     help: { type: "boolean", short: "h" },
   },
@@ -117,9 +130,15 @@ OPTIONS:
     --deletion-color <#HEX>        default: ${formatHex(defaultOptions.pallet.deletion)}
     --modification-color <#HEX>    default: ${formatHex(defaultOptions.pallet.modification)}
     --workers <N>                  default: ${defaultOptions.workers}
+    --exit-code                    exit 1 if differences are found
     -v, --version
     -h, --help
 
+EXIT STATUS:
+    0    success (with --exit-code: no differences found)
+    1    differences found (only with --exit-code)
+    2    error
+
 NOTES:
     Pages are rendered with Ghostscript (gs-wasm). Each page render spins up a
     transient Ghostscript instance (~26 MB WASM binary plus a rasterization
@@ -192,12 +211,15 @@ if (Number.isNaN(workers) || workers < 1) {
   throw new Error("Invalid workers value");
 }
 
+const exitCodeOnDiff = exitCode_ ?? false;
+
 fs.mkdirSync(outDir, { recursive: true });
 const writerPool = new PngWriterPool(
   workers,
   new URL("./cli-png-worker.js", import.meta.url),
 );
 const pendingWrites: Promise<void>[] = [];
+let hasDiff = false;
 
 const _loopSpan = perf.span("cli.loopWall_ms");
 for await (const [
@@ -221,6 +243,9 @@ for await (const [
   console.log(
     `Page ${i}, Addition: ${addition.length}, Deletion: ${deletion.length}, Modification: ${modification.length}`,
   );
+  if (addition.length > 0 || deletion.length > 0 || modification.length > 0) {
+    hasDiff = true;
+  }
   const dir = path.join(outDir, i.toString(10));
   fs.mkdirSync(dir, { recursive: true });
   const sSubmit = perf.span("cli.poolSubmit_ms");
@@ -256,6 +281,10 @@ await writerPool.terminate();
 _loopSpan.stop();
 _wallSpan.stop();
 
+if (exitCodeOnDiff && hasDiff) {
+  process.exitCode = 1;
+}
+
 if (perf.enabled) {
   const counters = perf.dump();
   process.stderr.write("\n=== PERF ===\n");

package/src/decode.ts

@@ -8,8 +8,6 @@ import type { JimpInstance } from "./jimp.ts";
  * `jimp.fromBuffer` accepts an ArrayBuffer directly, which keeps this usable in
  * the browser without relying on Node's `Buffer`.
  */
-export async function decodePng(
-  png: ArrayBuffer,
-): Promise<JimpInstance> {
+export async function decodePng(png: ArrayBuffer): Promise<JimpInstance> {
   return (await jimp.Jimp.fromBuffer(png)) as JimpInstance;
 }

package/src/index.ts

@@ -249,7 +249,11 @@ export async function* visualizeDifferences(
   const makeSlots = (count: number): Slot[] =>
     Array.from({ length: maxPages }, (_, i) => {
       if (i >= count) {
-        return { p: Promise.resolve(null), resolve: () => {}, reject: () => {} };
+        return {
+          p: Promise.resolve(null),
+          resolve: () => {},
+          reject: () => {},
+        };
       }
       let resolve!: (v: Uint8Array<ArrayBuffer> | null) => void;
       let reject!: (e: unknown) => void;
@@ -279,7 +283,10 @@ export async function* visualizeDifferences(
   const totalRenderPages = aPages + bPages + (hasMask ? maskPages : 0);
   const chunkSize = Math.max(
     1,
-    Math.min(maxPages, Math.max(MIN_CHUNK, Math.ceil(totalRenderPages / (2 * R)))),
+    Math.min(
+      maxPages,
+      Math.max(MIN_CHUNK, Math.ceil(totalRenderPages / (2 * R))),
+    ),
   );
   type Task = { bytes: Uint8Array; start: number; end: number; slots: Slot[] };
   const tasks: Task[] = [];

package/src/pdf.ts

@@ -95,7 +95,9 @@ export async function renderPageRangePng(
   });
   sRender.stop();
   if (exitCode !== 0) {
-    throw new Error(`gs render failed (pages ${first}-${last}, exit ${exitCode})`);
+    throw new Error(
+      `gs render failed (pages ${first}-${last}, exit ${exitCode})`,
+    );
   }
   const result = new Map<number, Uint8Array<ArrayBuffer>>();
   for (let k = 1; k <= pageCount; k++) {

package/tsconfig.json

@@ -1,50 +1,53 @@
-{
-  // Visit https://aka.ms/tsconfig to read more about this file
-  "compilerOptions": {
-    // File Layout
-    "rootDir": "./src",
-    "outDir": "./dist",
-
-    // Environment Settings
-    // See also https://aka.ms/tsconfig/module
-    "module": "esnext",
-    "target": "esnext",
-    // "types": [],
-    // For nodejs:
-    "lib": ["esnext", "WebWorker", "DOM"],
-    "types": ["node"],
-    // and npm install -D @types/node
-
-    // Other Outputs
-    "sourceMap": true,
-    "declaration": true,
-    "declarationMap": true,
-
-    // Stricter Typechecking Options
-    "noUncheckedIndexedAccess": true,
-    "exactOptionalPropertyTypes": true,
-
-    // Style Options
-    // "noImplicitReturns": true,
-    // "noImplicitOverride": true,
-    // "noUnusedLocals": true,
-    // "noUnusedParameters": true,
-    // "noFallthroughCasesInSwitch": true,
-    // "noPropertyAccessFromIndexSignature": true,
-
-    // Recommended Options
-    "strict": true,
-    "jsx": "react-jsx",
-    "verbatimModuleSyntax": true,
-    "isolatedModules": true,
-    "noUncheckedSideEffectImports": true,
-    "moduleDetection": "force",
-    "skipLibCheck": true,
-
-    // With Rollup
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "rewriteRelativeImportExtensions": true,
-    "noEmit": true
-  }
-}
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    "rootDir": "./src",
+    "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "esnext",
+    "target": "esnext",
+    // "types": [],
+    // For nodejs:
+    "lib": ["esnext", "WebWorker", "DOM"],
+    "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+
+    // With Rollup
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "rewriteRelativeImportExtensions": true,
+    "noEmit": true
+  },
+  // Keep `tsc --noEmit` runnable as a type check: scripts/version.ts is run
+  // directly by node (type stripping) and lives outside rootDir.
+  "include": ["src"]
+}

package/wasm/core.c

@@ -2,10 +2,13 @@
 
 #include <math.h>
 #include <stdlib.h>
-#include <string.h>
 
 #define COORD_INITIAL_CAPACITY 256
 
+/* Zero constant for CoreResult; assigning it replaces struct-zeroing memset,
+   which clang-tidy's insecureAPI check rejects. */
+static const CoreResult CORE_RESULT_ZERO = {0};
+
 typedef struct {
   int32_t *data;
   int32_t count;
@@ -76,7 +79,7 @@ void core_result_free(CoreResult *r) {
   free(r->addition_xy);
   free(r->deletion_xy);
   free(r->modification_xy);
-  memset(r, 0, sizeof(*r));
+  *r = CORE_RESULT_ZERO;
 }
 
 int32_t process_page(const uint8_t *a_pixels, const uint8_t *b_pixels,
@@ -89,7 +92,7 @@ int32_t process_page(const uint8_t *a_pixels, const uint8_t *b_pixels,
     return CORE_ERROR_INVALID;
   }
 
-  memset(out, 0, sizeof(*out));
+  *out = CORE_RESULT_ZERO;
 
   size_t pixel_count = (size_t)width * (size_t)height;
   size_t byte_count = pixel_count * 4;