state-machine-cat 11.0.6 → 11.1.1

package/README.md

@@ -82,9 +82,6 @@ Options:
   -E --engine <type>          dot|circo|fdp|neato|osage|twopi (default: "dot")
   -d --direction <dir>        top-down|bottom-top|left-right|right-left (default: "top-down")
   -o --output-to <file>       File to write to. use - for stdout.
-  --dot-graph-attrs <string>  graph attributes to pass to the dot render engine
-  --dot-node-attrs <string>   node attributes to pass to the dot render engine
-  --dot-edge-attrs <string>   edge attributes to pass to the dot render engine
   --desugar                   transform pseudo states into transitions (!experimental!)
   -l --license                Display license and exit
   -h, --help                  display help for command
@@ -105,18 +102,27 @@ bin/smcat -T dot docs/sample.smcat -o - | dot -T svg -odoc/sample.svg
 Leaving the options at the default settings usually deliver the best
 results already, so if they bewilder you: don't worry.
 
-The `--dot-graph-attrs` (and the node and edge variants thereof) exist in case you want
-to override default attributes in the generated picture; e.g. to get a transparent background
-and draw edges as line segments instead of splines, use this:
+When you pass the `--desugar` (&tritime; experimental) switch, state-machine-cat will,
+before rendering, transform some pseudo states into transitions - see
+[de-sugaring state machines](docs/desugar.md) for details.
+
+In addition to what's documented in the `--help` you can use the following 'advanced'
+options:
+
+```
+  --dot-graph-attrs <string>  graph attributes to pass to the dot render engine
+  --dot-node-attrs <string>   node attributes to pass to the dot render engine
+  --dot-edge-attrs <string>   edge attributes to pass to the dot render engine
+```
+
+With these you can override default attributes in the generated picture; e.g. to
+get a transparent background and draw edges as line segments instead of
+splines, use this:
 
 ```sh
 bin/smcat --dot-graph-attrs "bgcolor=transparent splines=line" docs/sample.smcat
 ```
 
-When you pass the `--desugar` (&tritime; experimental) switch, state-machine-cat will,
-before rendering, transform some pseudo states into transitions - see
-[de-sugaring state machines](docs/desugar.md) for details.
-
 ### Syntax highlighting
 
 - For editors supporting tree sitter (like atom): there's [tree-sitter-smcat](https://github.com/sverweij/tree-sitter-smcat)

package/bin/smcat.mjs

@@ -1,103 +1,5 @@
 #!/usr/bin/env node
 // @ts-check
-import { readFileSync } from "node:fs";
-import { program } from "commander";
-import satisfies from "semver/functions/satisfies.js";
-import actions from "../dist/esm/cli/actions.mjs";
-import normalize from "../dist/esm/cli/normalize.mjs";
-import validations from "../dist/esm/cli/validations.mjs";
+import executeCommandLine from "../dist/cli/execute-command-line.mjs";
 
-const $package = JSON.parse(
-  // eslint-disable-next-line security/detect-non-literal-fs-filename
-  readFileSync(new URL("../package.json", import.meta.url), "utf8")
-);
-
-/* c8 ignore start */
-if (!satisfies(process.versions.node, $package.engines.node)) {
-  process.stderr.write(
-    `\nERROR: your node version (${process.versions.node}) is not recent enough.\n`
-  );
-  process.stderr.write(
-    `       state-machine-cat is supported on node ${$package.engines.node}\n\n`
-  );
-
-  /* eslint node/no-process-exit: 0 */
-  process.exit(-1);
-}
-/* c8 ignore stop */
-
-/**
- * @param {any} pError
- * @return {void}
- */
-function presentError(pError) {
-  process.stderr.write(actions.formatError(pError));
-
-  /* eslint no-process-exit:0 */
-  process.exit(1);
-}
-
-try {
-  program
-    .version($package.version)
-    .description(
-      "Write beautiful state charts - https://github.com/sverweij/state-machine-cat"
-    )
-    .option(
-      "-T --output-type <type>",
-      validations.validOutputTypeRE,
-      validations.validOutputType,
-      validations.defaultOutputType
-    )
-    .option(
-      "-I --input-type <type>",
-      validations.validInputTypeRE,
-      validations.validInputType,
-      validations.defaultInputType
-    )
-    .option(
-      "-E --engine <type>",
-      validations.validEngineRE,
-      validations.validEngine,
-      validations.defaultEngine
-    )
-    .option(
-      "-d --direction <dir>",
-      validations.validDirectionRE,
-      validations.validDirection,
-      validations.defaultDirection
-    )
-    .option("-o --output-to <file>", "File to write to. use - for stdout.")
-    .option(
-      "--dot-graph-attrs <string>",
-      "graph attributes to pass to the dot render engine",
-      validations.validDotAttrs
-    )
-    .option(
-      "--dot-node-attrs <string>",
-      "node attributes to pass to the dot render engine",
-      validations.validDotAttrs
-    )
-    .option(
-      "--dot-edge-attrs <string>",
-      "edge attributes to pass to the dot render engine",
-      validations.validDotAttrs
-    )
-    .option(
-      "--desugar",
-      "transform pseudo states into transitions (!experimental!)"
-    )
-    .option("-l --license", "Display license and exit", () => {
-      process.stdout.write(actions.LICENSE);
-      process.exit(0);
-    })
-    .arguments("[infile]")
-    .parse(process.argv);
-  actions
-    .transform(
-      validations.validateArguments(normalize(program.args[0], program.opts()))
-    )
-    .catch(presentError);
-} catch (pError) {
-  presentError(pError);
-}
+await executeCommandLine();

package/dist/{esm/cli → cli}/actions.mjs

@@ -40,29 +40,29 @@ function getStream(pStream) {
         });
     });
 }
-export default {
-    LICENSE,
-    transform(pOptions) {
-        return getStream(getInStream(pOptions.inputFrom)).then((pInput) => {
-            const lOutput = smcat.render(pInput, {
-                inputType: pOptions.inputType,
-                outputType: pOptions.outputType,
-                engine: pOptions.engine,
-                direction: pOptions.direction,
-                dotGraphAttrs: pOptions.dotGraphAttrs,
-                dotNodeAttrs: pOptions.dotNodeAttrs,
-                dotEdgeAttrs: pOptions.dotEdgeAttrs,
-                desugar: pOptions.desugar,
-            });
-            return getOutStream(pOptions.outputTo).write(typeof lOutput === "string"
-                ? lOutput
-                : JSON.stringify(lOutput, null, "    "), "binary");
+export function displayLicense(pOutStream) {
+    pOutStream.write(LICENSE, "utf8");
+}
+export function transform(pOptions) {
+    return getStream(getInStream(pOptions.inputFrom)).then((pInput) => {
+        const lOutput = smcat.render(pInput, {
+            inputType: pOptions.inputType,
+            outputType: pOptions.outputType,
+            engine: pOptions.engine,
+            direction: pOptions.direction,
+            dotGraphAttrs: pOptions.dotGraphAttrs,
+            dotNodeAttrs: pOptions.dotNodeAttrs,
+            dotEdgeAttrs: pOptions.dotEdgeAttrs,
+            desugar: pOptions.desugar,
         });
-    },
-    formatError(pError) {
-        if (Boolean(pError.location)) {
-            return `\n  syntax error on line ${pError.location.start.line}, column ${pError.location.start.column}:\n  ${pError.message}\n\n`;
-        }
-        return pError.message;
-    },
-};
+        return getOutStream(pOptions.outputTo).write(typeof lOutput === "string"
+            ? lOutput
+            : JSON.stringify(lOutput, null, "    "), "binary");
+    });
+}
+export function formatError(pError) {
+    if (Boolean(pError.location)) {
+        return `\n  syntax error on line ${pError.location.start.line}, column ${pError.location.start.column}:\n  ${pError.message}\n\n`;
+    }
+    return pError.message;
+}

package/dist/cli/execute-command-line.mjs

@@ -0,0 +1,61 @@
+import { readFileSync } from "node:fs";
+import { Command, Option } from "commander";
+import satisfies from "semver/functions/satisfies.js";
+import { formatError, displayLicense, transform } from "./actions.mjs";
+import normalize from "./normalize.mjs";
+import validations from "./validations.mjs";
+const $package = JSON.parse(readFileSync(new URL("../../package.json", import.meta.url), "utf8"));
+function presentError(pError, pErrorStream) {
+    pErrorStream.write(formatError(pError));
+    process.exitCode = 1;
+}
+function parseArguments(pArguments) {
+    return new Command()
+        .description("Write beautiful state charts - https://github.com/sverweij/state-machine-cat")
+        .option("-T, --output-type <type>", validations.validOutputTypeRE, validations.validOutputType, validations.defaultOutputType)
+        .option("-I, --input-type <type>", validations.validInputTypeRE, validations.validInputType, validations.defaultInputType)
+        .option("-E, --engine <type>", validations.validEngineRE, validations.validEngine, validations.defaultEngine)
+        .option("-d, --direction <dir>", validations.validDirectionRE, validations.validDirection, validations.defaultDirection)
+        .option("-o --output-to <file>", "File to write to. use - for stdout.")
+        .addOption(new Option("--dot-graph-attrs <string>", "graph attributes to pass to the dot render engine")
+        .argParser(validations.validDotAttrs)
+        .hideHelp(true))
+        .addOption(new Option("--dot-node-attrs <string>", "node attributes to pass to the dot render engine")
+        .argParser(validations.validDotAttrs)
+        .hideHelp(true))
+        .addOption(new Option("--dot-edge-attrs <string>", "edge attributes to pass to the dot render engine")
+        .argParser(validations.validDotAttrs)
+        .hideHelp(true))
+        .option("--desugar", "transform pseudo states into transitions (!experimental!)")
+        .version($package.version)
+        .option("-l, --license", "Display license and exit")
+        .arguments("[infile]")
+        .parse(pArguments);
+}
+function assertNodeVersion(pCurrentNodeVersion, pSupportedEngines) {
+    if (!satisfies(pCurrentNodeVersion, pSupportedEngines)) {
+        throw new Error(`\nERROR: your node version (${pCurrentNodeVersion}) is not recent enough.\n` +
+            `       state-machine-cat is supported on node ${pSupportedEngines}\n\n`);
+    }
+}
+export default async function executeCommandLine(pArguments = process.argv, pOptions) {
+    const lOptions = {
+        currentNodeVersion: process.versions.node,
+        supportedEngines: $package.engines.node,
+        outStream: process.stdout,
+        errorStream: process.stderr,
+        ...pOptions,
+    };
+    try {
+        assertNodeVersion(lOptions.currentNodeVersion, lOptions.supportedEngines);
+        const lProgram = parseArguments(pArguments);
+        if (lProgram.opts()?.license) {
+            displayLicense(lOptions.outStream);
+            return;
+        }
+        await transform(validations.validateArguments(normalize(lProgram.args[0], lProgram.opts())));
+    }
+    catch (pError) {
+        presentError(pError, lOptions.errorStream);
+    }
+}

package/dist/version.mjs

@@ -0,0 +1 @@
+export const version = "11.1.1";

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "state-machine-cat",
-  "version": "11.0.6",
+  "version": "11.1.1",
   "description": "write beautiful state charts",
-  "main": "./dist/esm/index.mjs",
-  "module": "./dist/esm/index.mjs",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
   "exports": {
     ".": [
       {
-        "import": "./dist/esm/index.mjs"
+        "import": "./dist/index.mjs"
       }
     ]
   },
   "sideEffects": [
-    "dist/esm/render/smcat/smcat.template.js",
-    "dist/esm/render/dot/dot.states.template.js",
-    "dist/esm/render/dot/dot.template.js",
-    "dist/esm/render/scxml/scxml.states.template.js",
-    "dist/esm/render/scxml/scxml.template.js"
+    "dist/render/smcat/smcat.template.js",
+    "dist/render/dot/dot.states.template.js",
+    "dist/render/dot/dot.template.js",
+    "dist/render/scxml/scxml.states.template.js",
+    "dist/render/scxml/scxml.template.js"
   ],
   "scripts": {
-    "build": "make clean dist pages cli-build && rm -rf dist/esm && tsc",
+    "build": "make clean dist pages cli-build && rm -rf dist && tsc",
     "check": "run-s depcruise lint test:cover",
     "depcruise": "dependency-cruise bin src test types tools --config config/dependency-cruiser/base.mjs",
     "depcruise:graph": "run-s depcruise:graph:doc:archi depcruise:graph:doc:deps depcruise:graph:doc:flat-deps",
@@ -93,13 +93,13 @@
     "@hpcc-js/wasm": "2.13.0",
     "ajv": "8.12.0",
     "chalk": "5.2.0",
-    "commander": "10.0.1",
-    "fast-xml-parser": "4.2.4",
+    "commander": "11.0.0",
+    "fast-xml-parser": "4.2.5",
     "handlebars": "4.7.7",
     "he": "1.2.0",
     "indent-string": "5.0.0",
     "lodash": "4.17.21",
-    "semver": "^7.5.1",
+    "semver": "^7.5.3",
     "traverse": "0.6.7",
     "wrap-ansi": "8.1.0"
   },
@@ -109,16 +109,16 @@
     "@types/he": "1.2.0",
     "@types/lodash": "4.14.195",
     "@types/mocha": "10.0.1",
-    "@typescript-eslint/eslint-plugin": "5.59.9",
-    "@typescript-eslint/parser": "5.59.9",
-    "c8": "7.14.0",
+    "@typescript-eslint/eslint-plugin": "5.60.0",
+    "@typescript-eslint/parser": "5.60.0",
+    "c8": "8.0.0",
     "chai": "4.3.7",
     "chai-as-promised": "7.1.1",
     "chai-json-schema": "1.5.1",
     "chai-xml": "0.4.1",
-    "dependency-cruiser": "13.0.3",
-    "esbuild": "0.17.19",
-    "eslint": "8.42.0",
+    "dependency-cruiser": "13.0.4",
+    "esbuild": "0.18.8",
+    "eslint": "8.43.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -140,7 +140,7 @@
     "ts-node": "10.9.1",
     "typescript": "5.1.3",
     "upem": "8.0.0",
-    "watskeburt": "0.11.3",
+    "watskeburt": "0.11.5",
     "xml-name-validator": "4.0.0"
   },
   "overrides": {

package/dist/esm/version.mjs

@@ -1 +0,0 @@
-export const version = "11.0.6";