state-machine-cat 11.0.5 → 11.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -10
- package/bin/smcat.mjs +21 -12
- package/dist/esm/version.mjs +1 -1
- package/package.json +12 -12
package/README.md
CHANGED
|
@@ -82,9 +82,6 @@ Options:
|
|
|
82
82
|
-E --engine <type> dot|circo|fdp|neato|osage|twopi (default: "dot")
|
|
83
83
|
-d --direction <dir> top-down|bottom-top|left-right|right-left (default: "top-down")
|
|
84
84
|
-o --output-to <file> File to write to. use - for stdout.
|
|
85
|
-
--dot-graph-attrs <string> graph attributes to pass to the dot render engine
|
|
86
|
-
--dot-node-attrs <string> node attributes to pass to the dot render engine
|
|
87
|
-
--dot-edge-attrs <string> edge attributes to pass to the dot render engine
|
|
88
85
|
--desugar transform pseudo states into transitions (!experimental!)
|
|
89
86
|
-l --license Display license and exit
|
|
90
87
|
-h, --help display help for command
|
|
@@ -105,18 +102,27 @@ bin/smcat -T dot docs/sample.smcat -o - | dot -T svg -odoc/sample.svg
|
|
|
105
102
|
Leaving the options at the default settings usually deliver the best
|
|
106
103
|
results already, so if they bewilder you: don't worry.
|
|
107
104
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
105
|
+
When you pass the `--desugar` (⨻ experimental) switch, state-machine-cat will,
|
|
106
|
+
before rendering, transform some pseudo states into transitions - see
|
|
107
|
+
[de-sugaring state machines](docs/desugar.md) for details.
|
|
108
|
+
|
|
109
|
+
In addition to what's documented in the `--help` you can use the following 'advanced'
|
|
110
|
+
options:
|
|
111
|
+
|
|
112
|
+
```
|
|
113
|
+
--dot-graph-attrs <string> graph attributes to pass to the dot render engine
|
|
114
|
+
--dot-node-attrs <string> node attributes to pass to the dot render engine
|
|
115
|
+
--dot-edge-attrs <string> edge attributes to pass to the dot render engine
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
With these you can override default attributes in the generated picture; e.g. to
|
|
119
|
+
get a transparent background and draw edges as line segments instead of
|
|
120
|
+
splines, use this:
|
|
111
121
|
|
|
112
122
|
```sh
|
|
113
123
|
bin/smcat --dot-graph-attrs "bgcolor=transparent splines=line" docs/sample.smcat
|
|
114
124
|
```
|
|
115
125
|
|
|
116
|
-
When you pass the `--desugar` (⨻ experimental) switch, state-machine-cat will,
|
|
117
|
-
before rendering, transform some pseudo states into transitions - see
|
|
118
|
-
[de-sugaring state machines](docs/desugar.md) for details.
|
|
119
|
-
|
|
120
126
|
### Syntax highlighting
|
|
121
127
|
|
|
122
128
|
- For editors supporting tree sitter (like atom): there's [tree-sitter-smcat](https://github.com/sverweij/tree-sitter-smcat)
|
package/bin/smcat.mjs
CHANGED
|
@@ -68,20 +68,29 @@ try {
|
|
|
68
68
|
validations.defaultDirection
|
|
69
69
|
)
|
|
70
70
|
.option("-o --output-to <file>", "File to write to. use - for stdout.")
|
|
71
|
-
.
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
71
|
+
.addOption(
|
|
72
|
+
// @ts-expect-error Option doesn't exist on Command - probably because it doesn't exist on the typedef
|
|
73
|
+
new program.Option(
|
|
74
|
+
"--dot-graph-attrs <string>",
|
|
75
|
+
"graph attributes to pass to the dot render engine",
|
|
76
|
+
validations.validDotAttrs
|
|
77
|
+
).hideHelp(true)
|
|
75
78
|
)
|
|
76
|
-
.
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
79
|
+
.addOption(
|
|
80
|
+
// @ts-expect-error Option doesn't exist on Command - probably because it doesn't exist on the typedef
|
|
81
|
+
new program.Option(
|
|
82
|
+
"--dot-node-attrs <string>",
|
|
83
|
+
"node attributes to pass to the dot render engine",
|
|
84
|
+
validations.validDotAttrs
|
|
85
|
+
).hideHelp(true)
|
|
80
86
|
)
|
|
81
|
-
.
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
87
|
+
.addOption(
|
|
88
|
+
// @ts-expect-error Option doesn't exist on Command - probably because it doesn't exist on the typedef
|
|
89
|
+
new program.Option(
|
|
90
|
+
"--dot-edge-attrs <string>",
|
|
91
|
+
"edge attributes to pass to the dot render engine",
|
|
92
|
+
validations.validDotAttrs
|
|
93
|
+
).hideHelp(true)
|
|
85
94
|
)
|
|
86
95
|
.option(
|
|
87
96
|
"--desugar",
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const version = "11.0
|
|
1
|
+
export const version = "11.1.0";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "state-machine-cat",
|
|
3
|
-
"version": "11.0
|
|
3
|
+
"version": "11.1.0",
|
|
4
4
|
"description": "write beautiful state charts",
|
|
5
5
|
"main": "./dist/esm/index.mjs",
|
|
6
6
|
"module": "./dist/esm/index.mjs",
|
|
@@ -93,13 +93,13 @@
|
|
|
93
93
|
"@hpcc-js/wasm": "2.13.0",
|
|
94
94
|
"ajv": "8.12.0",
|
|
95
95
|
"chalk": "5.2.0",
|
|
96
|
-
"commander": "
|
|
97
|
-
"fast-xml-parser": "4.2.
|
|
96
|
+
"commander": "11.0.0",
|
|
97
|
+
"fast-xml-parser": "4.2.4",
|
|
98
98
|
"handlebars": "4.7.7",
|
|
99
99
|
"he": "1.2.0",
|
|
100
100
|
"indent-string": "5.0.0",
|
|
101
101
|
"lodash": "4.17.21",
|
|
102
|
-
"semver": "^7.5.
|
|
102
|
+
"semver": "^7.5.2",
|
|
103
103
|
"traverse": "0.6.7",
|
|
104
104
|
"wrap-ansi": "8.1.0"
|
|
105
105
|
},
|
|
@@ -109,16 +109,16 @@
|
|
|
109
109
|
"@types/he": "1.2.0",
|
|
110
110
|
"@types/lodash": "4.14.195",
|
|
111
111
|
"@types/mocha": "10.0.1",
|
|
112
|
-
"@typescript-eslint/eslint-plugin": "5.
|
|
113
|
-
"@typescript-eslint/parser": "5.
|
|
114
|
-
"c8": "
|
|
112
|
+
"@typescript-eslint/eslint-plugin": "5.60.0",
|
|
113
|
+
"@typescript-eslint/parser": "5.60.0",
|
|
114
|
+
"c8": "8.0.0",
|
|
115
115
|
"chai": "4.3.7",
|
|
116
116
|
"chai-as-promised": "7.1.1",
|
|
117
117
|
"chai-json-schema": "1.5.1",
|
|
118
118
|
"chai-xml": "0.4.1",
|
|
119
|
-
"dependency-cruiser": "13.0.
|
|
120
|
-
"esbuild": "0.
|
|
121
|
-
"eslint": "8.
|
|
119
|
+
"dependency-cruiser": "13.0.4",
|
|
120
|
+
"esbuild": "0.18.6",
|
|
121
|
+
"eslint": "8.43.0",
|
|
122
122
|
"eslint-config-moving-meadow": "4.0.2",
|
|
123
123
|
"eslint-config-prettier": "8.8.0",
|
|
124
124
|
"eslint-plugin-budapestian": "5.0.1",
|
|
@@ -139,8 +139,8 @@
|
|
|
139
139
|
"query-string": "8.1.0",
|
|
140
140
|
"ts-node": "10.9.1",
|
|
141
141
|
"typescript": "5.1.3",
|
|
142
|
-
"upem": "
|
|
143
|
-
"watskeburt": "0.11.
|
|
142
|
+
"upem": "8.0.0",
|
|
143
|
+
"watskeburt": "0.11.5",
|
|
144
144
|
"xml-name-validator": "4.0.0"
|
|
145
145
|
},
|
|
146
146
|
"overrides": {
|