@liiift-studio/vf-clamp-cli 0.1.0 → 0.2.1

package/README.md

@@ -2,6 +2,12 @@
 
 A command-line interface for [`@liiift-studio/vf-clamp`](https://www.npmjs.com/package/@liiift-studio/vf-clamp) — restrict variable font axis ranges from the terminal without writing any JavaScript.
 
+![vf-clamp CLI: inspecting a variable font's axes and named instances, then clamping Regular–Bold to a Text WOFF2](https://raw.githubusercontent.com/Liiift-Studio/vf-clamp-cli/main/assets/demo.gif?v=1)
+
+## Try it live
+
+Want to see what axis-clamping does before installing anything? **[vfclamp.com](https://vfclamp.com)** is an interactive web demo of the same axis-constraint engine that powers this CLI — upload a variable font, pick named instances or set axis ranges in the browser, and download the restricted result. The CLI runs the identical engine locally and headless for scripting and batch workflows.
+
 ## Install
 
 Requires **Node.js 18 or newer**.

package/dist/commands/clamp.js

@@ -130,15 +130,81 @@ async function runClamp(fontPath, opts) {
     }));
     const written = await writeOutputs(writeInputs, outputDir, { force: opts.force !== false });
     if (opts.json) {
-        process.stdout.write(JSON.stringify({ written }) + '\n');
+        // v0.2.x: include per-output structural diagnostics when --json is set
+        // so machine consumers (build pipelines, batch scripts) can read the
+        // same instance / axis / pinned / size summary the Glyphs and
+        // RoboFont plugins show in their size-estimate strip.
+        const diagnostics = writeInputs.map((result, i) => {
+            const req = outputRequests[i];
+            return {
+                path: written[i],
+                ...summariseRequest(req, result.buffer),
+            };
+        });
+        process.stdout.write(JSON.stringify({ written, diagnostics }) + '\n');
     }
     else {
-        for (const filePath of written) {
+        for (let i = 0; i < written.length; i++) {
+            const filePath = written[i];
             // Bare paths on stdout so consumers can `... | xargs` them.
             process.stdout.write(`${filePath}\n`);
+            if (opts.verbose) {
+                // Diagnostic line mirrors the Glyphs+RoboFont dialog's size
+                // estimate: `~38 KB · 5 instances · 3 ax · 1 pinned`. Goes to
+                // stderr so it doesn't pollute the xargs-friendly stdout.
+                const req = outputRequests[i];
+                const result = writeInputs[i];
+                if (req && result) {
+                    process.stderr.write(`  ${formatSummary(summariseRequest(req, result.buffer))}\n`);
+                }
+            }
         }
     }
 }
+/**
+ * Compute the structural-summary fields shown in --verbose / --json output.
+ * Mirrors the Glyphs and RoboFont dialogs' `_count_structural` helper:
+ * number of licensed instances, total axes the user touched, number of
+ * those axes pinned to a single value, and the resulting file size.
+ *
+ * Master count is intentionally omitted — the engine doesn't expose
+ * post-instancer master geometry through its public API, and computing
+ * it from the OUTPUT buffer would require re-parsing TTFont in JS.
+ */
+function summariseRequest(req, buffer) {
+    const instances = req?.instances?.length ?? 0;
+    const axesObj = req?.axes ?? {};
+    const axes = Object.keys(axesObj).length;
+    let pinned = 0;
+    for (const value of Object.values(axesObj)) {
+        // Numbers in the axes map mean "pin to this value"; objects with
+        // equal min/max are also effectively pinned.
+        if (typeof value === 'number') {
+            pinned++;
+        }
+        else if (value && typeof value === 'object'
+            && 'min' in value && 'max' in value
+            && value.min
+                === value.max) {
+            pinned++;
+        }
+    }
+    return { sizeBytes: buffer.byteLength, instances, axes, pinned };
+}
+/** Human-readable form of summariseRequest's output. */
+function formatSummary(s) {
+    const parts = [];
+    const sizeKB = Math.round(s.sizeBytes / 1024);
+    parts.push(`~${sizeKB.toLocaleString()} KB`);
+    if (s.instances > 0) {
+        parts.push(`${s.instances} instance${s.instances !== 1 ? 's' : ''}`);
+    }
+    if (s.axes > 0) {
+        const pinnedSuffix = s.pinned > 0 ? ` · ${s.pinned} pinned` : '';
+        parts.push(`${s.axes} ax${pinnedSuffix}`);
+    }
+    return parts.join('  ·  ');
+}
 /** Commander value collector — appends each repeated flag value into an array. */
 function collect(value, previous) {
     return [...previous, value];

package/package.json

@@ -1,44 +1,55 @@
 {
-  "name": "@liiift-studio/vf-clamp-cli",
-  "version": "0.1.0",
-  "description": "CLI for @liiift-studio/vf-clamp — restrict variable font axis ranges from the command line",
-  "type": "module",
-  "bin": {
-    "vf-clamp": "./dist/index.js"
-  },
-  "exports": {
-    "./package.json": "./package.json"
-  },
-  "files": ["dist", "LICENSE", "README.md"],
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json && chmod +x dist/index.js",
-    "dev": "tsc -p tsconfig.build.json --watch",
-    "start": "node dist/index.js",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "prepublishOnly": "npm test && npm run build"
-  },
-  "dependencies": {
-    "@liiift-studio/vf-clamp": "^2.0.1",
-    "commander": "^12.0.0"
-  },
-  "devDependencies": {
-    "@types/node": "^20.0.0",
-    "@vitest/coverage-v8": "^3.2.0",
-    "typescript": "^5.0.0",
-    "vitest": "^3.2.0"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Liiift-Studio/vf-clamp-cli.git"
-  },
-  "keywords": ["variable-font", "font", "cli", "vf-clamp", "typography", "fonttools"],
-  "author": "Quinn Keaveney <quinn@liiift.studio>",
-  "license": "MIT"
+	"name": "@liiift-studio/vf-clamp-cli",
+	"version": "0.2.1",
+	"description": "CLI for @liiift-studio/vf-clamp — restrict variable font axis ranges from the command line",
+	"type": "module",
+	"bin": {
+		"vf-clamp": "./dist/index.js"
+	},
+	"exports": {
+		"./package.json": "./package.json"
+	},
+	"files": [
+		"dist",
+		"LICENSE",
+		"README.md"
+	],
+	"scripts": {
+		"build": "tsc -p tsconfig.build.json && chmod +x dist/index.js",
+		"dev": "tsc -p tsconfig.build.json --watch",
+		"start": "node dist/index.js",
+		"test": "vitest run",
+		"test:coverage": "vitest run --coverage",
+		"prepublishOnly": "npm test && npm run build"
+	},
+	"dependencies": {
+		"@liiift-studio/vf-clamp": "^2.0.1",
+		"commander": "^12.0.0"
+	},
+	"devDependencies": {
+		"@types/node": "^20.0.0",
+		"@vitest/coverage-v8": "^3.2.0",
+		"typescript": "^5.0.0",
+		"vitest": "^3.2.0"
+	},
+	"engines": {
+		"node": ">=18.0.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/Liiift-Studio/vf-clamp-cli.git"
+	},
+	"keywords": [
+		"variable-font",
+		"font",
+		"cli",
+		"vf-clamp",
+		"typography",
+		"fonttools"
+	],
+	"author": "Quinn Keaveney <quinn@liiift.studio>",
+	"license": "MIT"
 }