nicevg 0.17.1 → 0.18.0

package/README.md

@@ -18,8 +18,20 @@ npm install nicevg
 bun add nicevg
 ```
 
+The package also has the `nicevg` command: install it with `npm install -g nicevg`, or run it once with `npx nicevg` or `bunx nicevg`.
+
 ## Example
 
+### CLI
+
+```sh
+nicevg < diagram.svg > fixed.svg
+```
+
+It reads the SVG from stdin and writes the fixed one to stdout. The issues it could not fix go to stderr, and the exit status is `0` with none left, `1` with some, and `2` for invalid SVG.
+
+### Library
+
 ```ts
 import { render, svg, text } from "nicevg";
 

package/dist/cli.d.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+/**
+ * The nicevg command: an SVG diagram on stdin, fixed and arranged by the
+ * native library, out on stdout. Issues left go to stderr, one per line;
+ * the exit status is 0 with none left, 1 with some, and 2 for bad input.
+ */
+export {};

package/dist/cli.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+/**
+ * The nicevg command: an SVG diagram on stdin, fixed and arranged by the
+ * native library, out on stdout. Issues left go to stderr, one per line;
+ * the exit status is 0 with none left, 1 with some, and 2 for bad input.
+ */
+import { readFileSync } from "node:fs";
+import { NicevgError, render } from "./index.js";
+const ABOUT = "Repair mechanical layout errors in an SVG diagram read from stdin, move nodes a little so connectors bend, cross and crowd less, and write the result to stdout";
+const USAGE = "Usage: nicevg";
+function main(args) {
+    for (const arg of args) {
+        if (arg === "-h" || arg === "--help") {
+            process.stdout.write(`${ABOUT}\n\n${USAGE}\n\nOptions:\n  -h, --help     Print help\n  -V, --version  Print version\n`);
+            return 0;
+        }
+        if (arg === "-V" || arg === "--version") {
+            const { version } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
+            process.stdout.write(`nicevg ${version}\n`);
+            return 0;
+        }
+    }
+    if (args.length > 0) {
+        process.stderr.write(`error: unexpected argument '${args[0]}' found\n\n${USAGE}\n\nFor more information, try '--help'.\n`);
+        return 2;
+    }
+    let svg;
+    try {
+        svg = render({ svg: readFileSync(0, "utf8") });
+    }
+    catch (error) {
+        if (error instanceof NicevgError || (error instanceof Error && "code" in error)) {
+            process.stderr.write(`Invalid SVG: ${error.message}\n`);
+            return 2;
+        }
+        throw error;
+    }
+    process.stdout.write(`${svg}\n`);
+    for (const issue of svg.report.issues) {
+        process.stderr.write(`${issue.code}: ${issue.message}\n`);
+    }
+    return svg.report.valid ? 0 : 1;
+}
+// Set rather than exit, so stdout and stderr finish writing first.
+process.exitCode = main(process.argv.slice(2));
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,KAAK,GACT,iKAAiK,CAAC;AACpK,MAAM,KAAK,GAAG,eAAe,CAAC;AAE9B,SAAS,IAAI,CAAC,IAAc;IAC1B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,OAAO,KAAK,6EAA6E,CAAC,CAAC;YACxH,OAAO,CAAC,CAAC;QACX,CAAC;QACD,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;YACxC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAClG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,OAAO,IAAI,CAAC,CAAC;YAC5C,OAAO,CAAC,CAAC;QACX,CAAC;IACH,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,IAAI,CAAC,CAAC,CAAC,cAAc,KAAK,2CAA2C,CAAC,CAAC;QAC3H,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,GAAG,CAAC;IACR,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,IAAI,CAAC,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,CAAC,EAAE,CAAC;YAChF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;YACxD,OAAO,CAAC,CAAC;QACX,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;IACjC,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACtC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAED,mEAAmE;AACnE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "nicevg",
-  "version": "0.17.1",
+  "version": "0.18.0",
   "description": "Deterministic checks and repairs for diagrams, given as shapes or SVG, on Bun and Node through native FFI.",
   "keywords": [
     "diagram",
     "svg",
     "layout",
     "routing",
-    "ffi"
+    "ffi",
+    "cli"
   ],
   "license": "MIT",
   "homepage": "https://github.com/takagiy/nicevg#readme",
@@ -19,6 +20,9 @@
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "bin": {
+    "nicevg": "./dist/cli.js"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -43,7 +47,7 @@
     "build:native": "bun run scripts/build-native.ts",
     "build:js": "tsc -p tsconfig.build.json",
     "test": "bun run test:bun && bun run test:node",
-    "test:bun": "bun test ./test/bun",
+    "test:bun": "bun test --timeout 30000 ./test/bun",
     "test:node": "node --test \"test/node/**/*.test.*\"",
     "typecheck": "tsc --noEmit"
   },

package/src/cli.ts

@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+/**
+ * The nicevg command: an SVG diagram on stdin, fixed and arranged by the
+ * native library, out on stdout. Issues left go to stderr, one per line;
+ * the exit status is 0 with none left, 1 with some, and 2 for bad input.
+ */
+
+import { readFileSync } from "node:fs";
+
+import { NicevgError, render } from "./index.ts";
+
+const ABOUT =
+  "Repair mechanical layout errors in an SVG diagram read from stdin, move nodes a little so connectors bend, cross and crowd less, and write the result to stdout";
+const USAGE = "Usage: nicevg";
+
+function main(args: string[]): number {
+  for (const arg of args) {
+    if (arg === "-h" || arg === "--help") {
+      process.stdout.write(`${ABOUT}\n\n${USAGE}\n\nOptions:\n  -h, --help     Print help\n  -V, --version  Print version\n`);
+      return 0;
+    }
+    if (arg === "-V" || arg === "--version") {
+      const { version } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
+      process.stdout.write(`nicevg ${version}\n`);
+      return 0;
+    }
+  }
+  if (args.length > 0) {
+    process.stderr.write(`error: unexpected argument '${args[0]}' found\n\n${USAGE}\n\nFor more information, try '--help'.\n`);
+    return 2;
+  }
+
+  let svg;
+  try {
+    svg = render({ svg: readFileSync(0, "utf8") });
+  } catch (error) {
+    if (error instanceof NicevgError || (error instanceof Error && "code" in error)) {
+      process.stderr.write(`Invalid SVG: ${error.message}\n`);
+      return 2;
+    }
+    throw error;
+  }
+  process.stdout.write(`${svg}\n`);
+  for (const issue of svg.report.issues) {
+    process.stderr.write(`${issue.code}: ${issue.message}\n`);
+  }
+  return svg.report.valid ? 0 : 1;
+}
+
+// Set rather than exit, so stdout and stderr finish writing first.
+process.exitCode = main(process.argv.slice(2));