visigraph 0.0.2 → 0.0.3

package/dist/commands/validate.d.ts

@@ -0,0 +1,3 @@
+import type { Command } from "commander";
+export declare function registerValidate(program: Command): void;
+export declare function validate(file: string): Promise<number>;

package/dist/commands/validate.js

@@ -0,0 +1,34 @@
+import { loadModel, resolve } from "@visigraph/core";
+import { EXIT } from "../exit.js";
+export function registerValidate(program) {
+    program
+        .command("validate")
+        .argument("<model>", "path to a model file (YAML)")
+        .description("check a model and every model it links or requires; every identifier must resolve")
+        .addHelpText("after", `
+Exit codes:
+  0  the model is valid
+  1  the model has problems; each is printed as file:path: message
+  2  the file could not be read`)
+        .action(async (file) => {
+        process.exitCode = await validate(file);
+    });
+}
+export async function validate(file) {
+    const parsed = await loadModel(file);
+    let diagnostics = parsed.diagnostics;
+    if (parsed.model) {
+        diagnostics = diagnostics.concat(resolve(parsed.model, { file }).diagnostics);
+    }
+    for (const d of diagnostics) {
+        const where = d.path ? `${d.file ?? file}:${d.path}` : (d.file ?? file);
+        console.error(`${d.severity}: ${where}: ${d.message}`);
+    }
+    if (diagnostics.length > 0) {
+        console.error(`${diagnostics.length} error${diagnostics.length === 1 ? "" : "s"}`);
+        return parsed.model ? EXIT.invalid : EXIT.usage;
+    }
+    console.log(`${file}: ok`);
+    return EXIT.ok;
+}
+//# sourceMappingURL=validate.js.map

package/dist/commands/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/commands/validate.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,OAAO,EAAmB,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAElC,MAAM,UAAU,gBAAgB,CAAC,OAAgB;IAC/C,OAAO;SACJ,OAAO,CAAC,UAAU,CAAC;SACnB,QAAQ,CAAC,SAAS,EAAE,6BAA6B,CAAC;SAClD,WAAW,CAAC,mFAAmF,CAAC;SAChG,WAAW,CACV,OAAO,EACP;;;;gCAI0B,CAC3B;SACA,MAAM,CAAC,KAAK,EAAE,IAAY,EAAE,EAAE;QAC7B,OAAO,CAAC,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACP,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,WAAW,GAAiB,MAAM,CAAC,WAAW,CAAC;IACnD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;IAChF,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;QACxE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAK,KAAK,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,MAAM,SAAS,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QACnF,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;IAClD,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,MAAM,CAAC,CAAC;IAC3B,OAAO,IAAI,CAAC,EAAE,CAAC;AACjB,CAAC"}

package/dist/exit.d.ts

@@ -0,0 +1,8 @@
+/** Exit codes shared by every command. */
+export declare const EXIT: {
+    readonly ok: 0;
+    /** The model has problems (dangling references, bad shape). */
+    readonly invalid: 1;
+    /** Bad usage, unreadable file, or an unexpected failure. */
+    readonly usage: 2;
+};

package/dist/exit.js

@@ -0,0 +1,9 @@
+/** Exit codes shared by every command. */
+export const EXIT = {
+    ok: 0,
+    /** The model has problems (dangling references, bad shape). */
+    invalid: 1,
+    /** Bad usage, unreadable file, or an unexpected failure. */
+    usage: 2,
+};
+//# sourceMappingURL=exit.js.map

package/dist/exit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exit.js","sourceRoot":"","sources":["../src/exit.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,EAAE,EAAE,CAAC;IACL,+DAA+D;IAC/D,OAAO,EAAE,CAAC;IACV,4DAA4D;IAC5D,KAAK,EAAE,CAAC;CACA,CAAC"}

package/dist/main.js

@@ -1,35 +1,35 @@
 #!/usr/bin/env node
-import { parseArgs } from "node:util";
-import { loadModel, resolve } from "@visigraph/core";
-const USAGE = `usage: visigraph validate <model.yaml>
-
-Loads the model and every model it links or requires, then resolves every
-identifier. Exits 1 on any dangling reference.`;
-async function main(argv) {
-    const { positionals } = parseArgs({ args: argv, allowPositionals: true, strict: true });
-    const [command, file] = positionals;
-    if (command !== "validate" || !file) {
-        console.error(USAGE);
-        return 2;
+import { Command, CommanderError } from "commander";
+import { registerValidate } from "./commands/validate.js";
+import { EXIT } from "./exit.js";
+import { DESCRIPTION, VERSION } from "./version.js";
+const program = new Command();
+program
+    .name("visigraph")
+    .description(DESCRIPTION)
+    .version(VERSION, "-v, --version", "print the version and exit")
+    .helpOption("-h, --help", "print help and exit")
+    .helpCommand("help [command]", "print help for a command")
+    .showHelpAfterError("(run with --help for usage)")
+    .exitOverride();
+registerValidate(program);
+try {
+    if (process.argv.length <= 2) {
+        program.outputHelp();
+        process.exitCode = EXIT.usage;
     }
-    const parsed = await loadModel(file);
-    let diagnostics = parsed.diagnostics;
-    if (parsed.model) {
-        diagnostics = diagnostics.concat(resolve(parsed.model, { file }).diagnostics);
+    else {
+        await program.parseAsync(process.argv);
     }
-    for (const d of diagnostics) {
-        const where = d.path ? `${d.file ?? file}:${d.path}` : (d.file ?? file);
-        console.error(`${d.severity}: ${where}: ${d.message}`);
+}
+catch (e) {
+    if (e instanceof CommanderError) {
+        // --help and --version exit 0; every other commander error is a usage error.
+        process.exitCode = e.exitCode === 0 ? EXIT.ok : EXIT.usage;
     }
-    if (diagnostics.length > 0) {
-        console.error(`${diagnostics.length} error${diagnostics.length === 1 ? "" : "s"}`);
-        return 1;
+    else {
+        console.error(`error: ${e instanceof Error ? e.message : String(e)}`);
+        process.exitCode = EXIT.usage;
     }
-    console.log(`${file}: ok`);
-    return 0;
 }
-main(process.argv.slice(2)).then((code) => process.exit(code), (e) => {
-    console.error(`error: ${e instanceof Error ? e.message : String(e)}`);
-    process.exit(2);
-});
 //# sourceMappingURL=main.js.map

package/dist/main.js.map

@@ -1 +1 @@
-{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAmB,MAAM,iBAAiB,CAAC;AAEtE,MAAM,KAAK,GAAG;;;+CAGiC,CAAC;AAEhD,KAAK,UAAU,IAAI,CAAC,IAAc;IAChC,MAAM,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACxF,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,WAAW,CAAC;IAEpC,IAAI,OAAO,KAAK,UAAU,IAAI,CAAC,IAAI,EAAE,CAAC;QACpC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,WAAW,GAAiB,MAAM,CAAC,WAAW,CAAC;IACnD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;IAChF,CAAC;IAED,KAAK,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC;QAC5B,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;QACxE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAK,KAAK,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,MAAM,SAAS,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QACnF,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,MAAM,CAAC,CAAC;IAC3B,OAAO,CAAC,CAAC;AACX,CAAC;AAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAC9B,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAC5B,CAAC,CAAU,EAAE,EAAE;IACb,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACtE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CACF,CAAC"}
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,WAAW,CAAC;KACjB,WAAW,CAAC,WAAW,CAAC;KACxB,OAAO,CAAC,OAAO,EAAE,eAAe,EAAE,4BAA4B,CAAC;KAC/D,UAAU,CAAC,YAAY,EAAE,qBAAqB,CAAC;KAC/C,WAAW,CAAC,gBAAgB,EAAE,0BAA0B,CAAC;KACzD,kBAAkB,CAAC,6BAA6B,CAAC;KACjD,YAAY,EAAE,CAAC;AAElB,gBAAgB,CAAC,OAAO,CAAC,CAAC;AAE1B,IAAI,CAAC;IACH,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QAC7B,OAAO,CAAC,UAAU,EAAE,CAAC;QACrB,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC;IAChC,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;AACH,CAAC;AAAC,OAAO,CAAU,EAAE,CAAC;IACpB,IAAI,CAAC,YAAY,cAAc,EAAE,CAAC;QAChC,6EAA6E;QAC7E,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;IAC7D,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACtE,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC;IAChC,CAAC;AACH,CAAC"}

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION: string;
+export declare const DESCRIPTION: string;

package/dist/version.js

@@ -0,0 +1,6 @@
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+const pkg = require("../package.json");
+export const VERSION = pkg.version;
+export const DESCRIPTION = pkg.description;
+//# sourceMappingURL=version.js.map

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,MAAM,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAA6C,CAAC;AAEnF,MAAM,CAAC,MAAM,OAAO,GAAW,GAAG,CAAC,OAAO,CAAC;AAC3C,MAAM,CAAC,MAAM,WAAW,GAAW,GAAG,CAAC,WAAW,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "visigraph",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "VisiGraph CLI \u2014 validate architecture models and play journeys through them",
   "license": "MIT",
   "type": "module",
@@ -19,7 +19,8 @@
   },
   "homepage": "https://github.com/textologylabs/visigraph",
   "dependencies": {
-    "@visigraph/core": "0.0.2"
+    "@visigraph/core": "0.0.3",
+    "commander": "^13.1.0"
   },
   "bugs": {
     "url": "https://github.com/textologylabs/visigraph/issues"