print-check-cli 1.0.0 → 1.0.2

package/README.md

@@ -1,23 +1,64 @@
 # print-check-cli
 
+[![npm](https://img.shields.io/npm/v/print-check-cli)](https://www.npmjs.com/package/print-check-cli)
 [![CI](https://github.com/ryancalacsan/print-check-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/ryancalacsan/print-check-cli/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/ryancalacsan/print-check-cli/graph/badge.svg)](https://codecov.io/gh/ryancalacsan/print-check-cli)
 
 A Node.js + TypeScript CLI tool that validates print-ready PDF files. Runs eight checks and reports pass/warn/fail results in the terminal.
 
-## Checks
+**[View on npm](https://www.npmjs.com/package/print-check-cli)**
 
-| Check | What it validates |
-|---|---|
-| **Bleed & Trim** | TrimBox/BleedBox presence and minimum bleed dimensions |
-| **Fonts** | Font embedding status (embedded, subset, or missing) |
-| **Color Space** | CMYK compliance, RGB detection, spot color reporting |
-| **Resolution** | Raster image DPI against a configurable minimum |
-| **PDF/X Compliance** | PDF/X standard detection (OutputIntents, version, output condition) — info only |
-| **Total Ink Coverage** | Maximum ink density (C+M+Y+K %) against configurable limit |
-| **Transparency** | Detects unflattened transparency (groups, soft masks, blend modes) |
-| **Page Size** | Verifies consistent page dimensions and optional expected size match |
+![print-check-cli Preview](./preview.png)
 
-## Usage
+## Demo
+
+![print-check demo](demo/demo.gif)
+
+## Features
+
+- **8 prepress checks** — bleed/trim boxes, font embedding, color space (CMYK/RGB), image DPI, PDF/X compliance, total ink coverage, transparency, and page size consistency
+- **Built-in print profiles** — presets for standard, magazine, newspaper, and large-format workflows with one `--profile` flag
+- **Per-check severity overrides** — downgrade failures to warnings or skip checks entirely with `--severity fonts:warn,transparency:off`
+- **Multi-file support** — validate entire directories with shell globbing (`print-check *.pdf`)
+- **JSON output for CI** — structured JSON reports via `--format json` for pipeline integration
+- **RC file configuration** — set project defaults in `.printcheckrc`, `.printcheckrc.json`, or `printcheck.config.js` with auto-discovery
+- **Dual PDF engine** — combines mupdf (WASM-powered deep object traversal) with pdf-lib (page box reading) for thorough analysis
+- **Colorized terminal output** — clear pass/warn/fail results with verbose per-page detail mode
+
+| Check                  | What it validates                                                               |
+| ---------------------- | ------------------------------------------------------------------------------- |
+| **Bleed & Trim**       | TrimBox/BleedBox presence and minimum bleed dimensions                          |
+| **Fonts**              | Font embedding status (embedded, subset, or missing)                            |
+| **Color Space**        | CMYK compliance, RGB detection, spot color reporting                            |
+| **Resolution**         | Raster image DPI against a configurable minimum                                 |
+| **PDF/X Compliance**   | PDF/X standard detection (OutputIntents, version, output condition) — info only |
+| **Total Ink Coverage** | Maximum ink density (C+M+Y+K %) against configurable limit                      |
+| **Transparency**       | Detects unflattened transparency (groups, soft masks, blend modes)              |
+| **Page Size**          | Verifies consistent page dimensions and optional expected size match            |
+
+## Tech Stack
+
+| Package                                                 | Purpose                                                     |
+| ------------------------------------------------------- | ----------------------------------------------------------- |
+| [mupdf](https://www.npmjs.com/package/mupdf) (mupdf.js) | PDF engine — WASM-powered, deep PDF object traversal        |
+| [pdf-lib](https://www.npmjs.com/package/pdf-lib)        | Supplemental — reading page boxes (TrimBox, BleedBox, etc.) |
+| [commander](https://www.npmjs.com/package/commander)    | CLI framework                                               |
+| [picocolors](https://www.npmjs.com/package/picocolors)  | Terminal colors                                             |
+| [zod](https://www.npmjs.com/package/zod)                | CLI option validation                                       |
+| [tsup](https://www.npmjs.com/package/tsup)              | TypeScript build                                            |
+| [vitest](https://www.npmjs.com/package/vitest)          | Testing                                                     |
+
+## Getting Started
+
+```bash
+# Install globally
+npm install -g print-check-cli
+
+# Or run directly with npx
+npx print-check-cli flyer.pdf
+```
+
+### Usage
 
 ```
 print-check <file.pdf ...> [options]
@@ -75,17 +116,12 @@ print-check *.pdf --format json
 
 Built-in profiles provide preset thresholds for common print scenarios. Explicit CLI flags override profile defaults.
 
-| Profile | minDpi | colorSpace | bleedMm | maxTac | Use case |
-|---------|--------|------------|---------|--------|----------|
-| `standard` | 300 | cmyk | 3 | 300 | General commercial print (default) |
-| `magazine` | 300 | cmyk | 5 | 300 | Magazine / perfect-bound |
-| `newspaper` | 150 | any | 0 | 240 | Newsprint / low-fidelity |
-| `large-format` | 150 | cmyk | 5 | 300 | Banners, posters, signage |
-
-### Exit codes
-
-- `0` — all checks passed (or warned)
-- `1` — one or more checks failed
+| Profile        | minDpi | colorSpace | bleedMm | maxTac | Use case                           |
+| -------------- | ------ | ---------- | ------- | ------ | ---------------------------------- |
+| `standard`     | 300    | cmyk       | 3       | 300    | General commercial print (default) |
+| `magazine`     | 300    | cmyk       | 5       | 300    | Magazine / perfect-bound           |
+| `newspaper`    | 150    | any        | 0       | 240    | Newsprint / low-fidelity           |
+| `large-format` | 150    | cmyk       | 5       | 300    | Banners, posters, signage          |
 
 ### Severity Overrides
 
@@ -102,19 +138,25 @@ print-check flyer.pdf --severity transparency:off
 print-check flyer.pdf --severity fonts:warn,transparency:off
 ```
 
-| Level | Behavior |
-|-------|----------|
-| `fail` | Default — no change to check result |
+| Level  | Behavior                                       |
+| ------ | ---------------------------------------------- |
+| `fail` | Default — no change to check result            |
 | `warn` | Downgrade any `fail` result to `warn` (exit 0) |
-| `off` | Skip the check entirely |
+| `off`  | Skip the check entirely                        |
 
 Available check names: `bleed`, `fonts`, `colorspace`, `resolution`, `pdfx`, `tac`, `transparency`, `pagesize`.
 
-## Configuration
+### Exit Codes
+
+- `0` — all checks passed (or warned)
+- `1` — one or more checks failed
+
+### Configuration
 
 Create a config file to set default options for your project:
 
-### `.printcheckrc` / `.printcheckrc.json`
+#### `.printcheckrc` / `.printcheckrc.json`
+
 ```json
 {
   "minDpi": 300,
@@ -130,7 +172,8 @@ Create a config file to set default options for your project:
 }
 ```
 
-### `printcheck.config.js`
+#### `printcheck.config.js`
+
 ```js
 export default {
   minDpi: 150,
@@ -143,18 +186,6 @@ export default {
 Config files are auto-discovered from the current directory upward.
 CLI flags always override config file values.
 
-## Tech Stack
-
-| Package | Purpose |
-|---|---|
-| [mupdf](https://www.npmjs.com/package/mupdf) (mupdf.js) | PDF engine — WASM-powered, deep PDF object traversal |
-| [pdf-lib](https://www.npmjs.com/package/pdf-lib) | Supplemental — reading page boxes (TrimBox, BleedBox, etc.) |
-| [commander](https://www.npmjs.com/package/commander) | CLI framework |
-| [picocolors](https://www.npmjs.com/package/picocolors) | Terminal colors |
-| [zod](https://www.npmjs.com/package/zod) | CLI option validation |
-| [tsup](https://www.npmjs.com/package/tsup) | TypeScript build |
-| [vitest](https://www.npmjs.com/package/vitest) | Testing |
-
 ## Project Structure
 
 ```
@@ -182,13 +213,25 @@ src/
 ## Development
 
 ```bash
-npm install           # Install dependencies
+npm install           # Install dependencies (also sets up pre-commit hooks)
 npm run dev -- <file> # Run via tsx (no build needed)
 npm run build         # Build to dist/
 npm test              # Run vitest
+npm run test:coverage # Run with coverage report
+npm run lint          # ESLint
+npm run format:check  # Prettier check
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines.
+
+## Deployment
+
+Published to npm via GitHub Actions with [OIDC trusted publishing](https://docs.npmjs.com/generating-provenance-statements). Every release includes a verified provenance attestation.
+
+```bash
+npm install -g print-check-cli
 ```
 
 ## Known Limitations (MVP)
 
 - **mupdf PDFObject nulls** — mupdf.js returns PDFObject wrappers with `.isNull() === true` rather than JavaScript `null`. All mupdf access goes through `src/engine/pdf-utils.ts` safe wrappers to handle this.
-

package/dist/index.js

@@ -5,6 +5,7 @@ import { Command } from "commander";
 import { z as z2 } from "zod";
 import * as fs3 from "fs";
 import * as path2 from "path";
+import { createRequire } from "module";
 
 // src/checks/bleed-trim.ts
 var PT_TO_MM = 25.4 / 72;
@@ -49,11 +50,9 @@ var checkBleedTrim = async (engines, options) => {
     if (minBleed < requiredMm) {
       const sides = [];
       if (bleedLeft < requiredMm) sides.push(`left: ${bleedLeft.toFixed(1)}mm`);
-      if (bleedRight < requiredMm)
-        sides.push(`right: ${bleedRight.toFixed(1)}mm`);
+      if (bleedRight < requiredMm) sides.push(`right: ${bleedRight.toFixed(1)}mm`);
       if (bleedTop < requiredMm) sides.push(`top: ${bleedTop.toFixed(1)}mm`);
-      if (bleedBottom < requiredMm)
-        sides.push(`bottom: ${bleedBottom.toFixed(1)}mm`);
+      if (bleedBottom < requiredMm) sides.push(`bottom: ${bleedBottom.toFixed(1)}mm`);
       details.push({
         page: pageNum,
         message: `Insufficient bleed (need ${requiredMm}mm): ${sides.join(", ")}`,
@@ -109,7 +108,7 @@ function collectFonts(fontDict, pageNum, seen) {
   safeForEach(fontDict, (value, key) => {
     const font = safeResolve(value);
     if (!font) return;
-    const baseFontName = safeName(safeGet(font, "BaseFont")) ?? key;
+    const baseFontName = safeName(safeGet(font, "BaseFont")) ?? String(key);
     if (seen.has(baseFontName)) return;
     seen.add(baseFontName);
     const subtype = safeName(safeGet(font, "Subtype"));
@@ -703,10 +702,7 @@ import * as mupdf5 from "mupdf";
 import { PDFDocument as PDFDocument2 } from "pdf-lib";
 async function loadPdf(filePath) {
   const buffer = fs.readFileSync(filePath);
-  const mupdfDoc = mupdf5.PDFDocument.openDocument(
-    buffer,
-    "application/pdf"
-  );
+  const mupdfDoc = mupdf5.PDFDocument.openDocument(buffer, "application/pdf");
   const pdfLibDoc = await PDFDocument2.load(buffer, {
     ignoreEncryption: true
   });
@@ -768,12 +764,7 @@ function buildJsonReport(fileName, results) {
 }
 
 // src/profiles.ts
-var PROFILE_NAMES = [
-  "standard",
-  "magazine",
-  "newspaper",
-  "large-format"
-];
+var PROFILE_NAMES = ["standard", "magazine", "newspaper", "large-format"];
 var PROFILES = {
   standard: { minDpi: 300, colorSpace: "cmyk", bleedMm: 3, maxTac: 300, pageSize: void 0 },
   magazine: { minDpi: 300, colorSpace: "cmyk", bleedMm: 5, maxTac: 300, pageSize: void 0 },
@@ -798,11 +789,7 @@ var ConfigSchema = z.object({
   profile: z.enum(PROFILE_NAMES).optional(),
   severity: z.record(z.string(), z.enum(["fail", "warn", "off"])).optional()
 });
-var CONFIG_FILES = [
-  ".printcheckrc",
-  ".printcheckrc.json",
-  "printcheck.config.js"
-];
+var CONFIG_FILES = [".printcheckrc", ".printcheckrc.json", "printcheck.config.js"];
 function findConfigFile(startDir) {
   let dir = path.resolve(startDir);
   while (true) {
@@ -839,12 +826,18 @@ async function loadConfig() {
 }
 
 // src/index.ts
+var require2 = createRequire(import.meta.url);
+var { version } = require2("../package.json");
+var SEVERITY_LEVELS = ["fail", "warn", "off"];
+function isSeverityOverride(level) {
+  return SEVERITY_LEVELS.includes(level);
+}
 function parseSeverityString(val) {
   if (!val.trim()) return {};
   const result = {};
   for (const pair of val.split(",")) {
     const [check, level] = pair.split(":").map((s) => s.trim());
-    if (check && level) result[check] = level;
+    if (check && level && isSeverityOverride(level)) result[check] = level;
   }
   return result;
 }
@@ -877,14 +870,19 @@ var OptionsSchema = z2.object({
   bleed: z2.coerce.number().nonnegative().optional(),
   maxTac: z2.coerce.number().positive().optional(),
   pageSize: z2.string().optional(),
-  checks: z2.string().default("all").transform((val) => val === "all" ? Object.keys(ALL_CHECKS) : val.split(",").map((s) => s.trim())),
+  checks: z2.string().default("all").transform(
+    (val) => val === "all" ? Object.keys(ALL_CHECKS) : val.split(",").map((s) => s.trim())
+  ),
   verbose: z2.boolean().default(false),
   format: z2.enum(["text", "json"]).default("text"),
   profile: z2.enum(PROFILE_NAMES).optional(),
-  severity: z2.union([z2.string().transform(parseSeverityString), z2.record(z2.string(), z2.enum(["fail", "warn", "off"]))]).default({})
+  severity: z2.union([
+    z2.string().transform(parseSeverityString),
+    z2.record(z2.string(), z2.enum(["fail", "warn", "off"]))
+  ]).default({})
 });
 var program = new Command();
-program.name("print-check").description("Validate print-ready PDF files").version("1.0.0").argument("<files...>", "PDF file(s) to check").option("--min-dpi <number>", "Minimum acceptable DPI").option("--color-space <mode>", "Expected color space: cmyk | any").option("--bleed <mm>", "Required bleed in mm").option("--max-tac <percent>", "Maximum total ink coverage %").option("--page-size <WxH>", "Expected page size in mm (e.g. 210x297)").option("--checks <list>", "Comma-separated checks to run", "all").option("--verbose", "Show detailed per-page results", false).option("--format <type>", "Output format: text | json", "text").option("--profile <name>", "Print profile: standard | magazine | newspaper | large-format").option("--severity <overrides>", "Per-check severity: check:level,... (fail|warn|off)").action(async (files, rawOpts) => {
+program.name("print-check").description("Validate print-ready PDF files").version(version).argument("<files...>", "PDF file(s) to check").option("--min-dpi <number>", "Minimum acceptable DPI").option("--color-space <mode>", "Expected color space: cmyk | any").option("--bleed <mm>", "Required bleed in mm").option("--max-tac <percent>", "Maximum total ink coverage %").option("--page-size <WxH>", "Expected page size in mm (e.g. 210x297)").option("--checks <list>", "Comma-separated checks to run", "all").option("--verbose", "Show detailed per-page results", false).option("--format <type>", "Output format: text | json", "text").option("--profile <name>", "Print profile: standard | magazine | newspaper | large-format").option("--severity <overrides>", "Per-check severity: check:level,... (fail|warn|off)").action(async (files, rawOpts) => {
   const config = await loadConfig();
   const stripped = {};
   for (const [key, value] of Object.entries(rawOpts)) {

package/package.json

@@ -1,14 +1,20 @@
 {
   "name": "print-check-cli",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "bin": {
     "print-check": "./dist/index.js"
   },
   "scripts": {
     "build": "tsup",
+    "typecheck": "tsc --noEmit",
     "dev": "tsx src/index.ts",
-    "test": "vitest run"
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src/ tests/",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "prepare": "husky"
   },
   "keywords": [
     "pdf",
@@ -42,11 +48,28 @@
     "picocolors": "^1.1.1",
     "zod": "^4.3.6"
   },
+  "lint-staged": {
+    "*.{ts,js}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
   "devDependencies": {
-    "@types/node": "^25.1.0",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^26.0.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^10.5.0",
+    "eslint-config-prettier": "^10.1.8",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.8.1",
     "tsup": "^8.5.1",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0",
     "vitest": "^4.0.18"
   }
 }