@rse/gradia 0.9.0

package/dst/gradia-cli.d.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+/*!
+**  Gradia -- Object Graph Diagram Rendering
+**  Copyright (c) 2026 Dr. Ralf S. Engelschall <rse@engelschall.com>
+**  Distributed under MIT license <https://spdx.org/licenses/MIT.html>
+*/
+export {};

package/dst/gradia-cli.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+/*!
+**  Gradia -- Object Graph Diagram Rendering
+**  Copyright (c) 2026 Dr. Ralf S. Engelschall <rse@engelschall.com>
+**  Distributed under MIT license <https://spdx.org/licenses/MIT.html>
+*/
+/*  built-in dependencies  */
+import fs from "node:fs";
+import process from "node:process";
+import { fileURLToPath } from "node:url";
+/*  external dependencies  */
+import { Command, Option } from "commander";
+/*  internal dependencies  */
+import { configDefaults } from "./gradia-api-config.js";
+import { Gradia, diagramTypes, diagramTypeDefault, diagramFormats, diagramFormatDefault } from "./gradia-api.js";
+/*  internal package meta-information  */
+const pkg = JSON.parse(fs.readFileSync(fileURLToPath(new URL("../package.json", import.meta.url)), "utf8"));
+/*  establish the command-line interface  */
+const program = new Command();
+program.name("gradia")
+    .description(pkg.description)
+    .version(pkg.version)
+    .requiredOption("-o, --output <file>", "output SVG file")
+    .addOption(new Option("-t, --type <type>", "diagram type")
+    .choices(diagramTypes).default(diagramTypeDefault))
+    .addOption(new Option("-f, --format <format>", "output format")
+    .choices(diagramFormats).default(diagramFormatDefault))
+    .option("-c, --config <name>=<value>", "rendering configuration option (repeatable)", (nv, prev) => prev.concat(nv), [])
+    .argument("<input>", "input graph description file")
+    .action(async (input, options) => {
+    /*  parse and validate the rendering configuration options  */
+    const config = {};
+    const store = config;
+    for (const nv of options.config) {
+        const m = /^([a-z][a-z0-9-]*)=(.*)$/.exec(nv);
+        if (m === null)
+            throw new Error(`invalid configuration option "${nv}" (expected "<name>=<value>")`);
+        const key = m[1];
+        if (!Object.hasOwn(configDefaults, key))
+            throw new Error(`unknown configuration option "${m[1]}"`);
+        store[key] = typeof configDefaults[key] === "boolean" ? m[2] === "true" : m[2];
+    }
+    /*  read the input, render the diagram, and write the output  */
+    const text = fs.readFileSync(input, "utf8");
+    const out = await Gradia.render(text, { type: options.type, format: options.format, config });
+    fs.writeFileSync(options.output, out, "utf8");
+});
+/*  run the command-line interface  */
+program.parseAsync().catch((err) => {
+    process.stderr.write(`gradia: ERROR: ${err instanceof Error ? err.message : String(err)}\n`);
+    process.exitCode = 1;
+});

package/package.json

@@ -0,0 +1,52 @@
+{
+    "name":                          "@rse/gradia",
+    "description":                   "Object Graph Diagram Rendering",
+    "keywords":                      [ "object", "graph", "diagram", "rendering", "svg", "layout", "api", "cli" ],
+    "publishConfig":                 { "access": "public" },
+    "version":                       "0.9.0",
+    "license":                       "MIT",
+    "author": {
+        "name":                      "Dr. Ralf S. Engelschall",
+        "email":                     "rse@engelschall.com",
+        "url":                       "http://engelschall.com"
+    },
+    "homepage":                      "https://github.com/rse/gradia",
+    "repository": {
+        "type":                      "git",
+        "url":                       "git+https://github.com/rse/gradia.git"
+    },
+    "main":                          "dst/gradia-api.js",
+    "types":                         "dst/gradia-api.d.ts",
+    "bin": {
+        "gradia":                    "dst/gradia-cli.js"
+    },
+    "files":                         [ "dst" ],
+    "type":                          "module",
+    "dependencies": {
+        "commander":                 "15.0.0",
+        "@antv/layout":              "2.0.0"
+    },
+    "devDependencies": {
+        "eslint":                    "9.39.5",
+        "@eslint/js":                "9.39.5",
+        "typescript-eslint":         "8.67.0",
+        "eslint-plugin-promise":     "7.3.0",
+        "eslint-plugin-import":      "2.32.0",
+        "neostandard":               "0.13.0",
+        "globals":                   "17.11.0",
+        "typescript":                "6.0.3",
+        "@types/node":               "26.2.0",
+        "@rse/stx":                  "1.1.6",
+        "shx":                       "0.4.0",
+        "nodemon":                   "3.1.14"
+    },
+    "engines": {
+        "node":                      ">=22.0.0"
+    },
+    "allowScripts": {
+        "fsevents":                  true
+    },
+    "scripts": {
+        "start":                     "stx -v4 -l warning -c etc/stx.conf"
+    }
+}