Add --roughjs_config option for MemoryViz CLI (#48)

CHANGELOG.md

@@ -19,6 +19,7 @@ and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 -   Created a CLI for MemoryViz.
 -   Added `--height` and `--width` options to MemoryViz CLI.
+-   Added `--roughjs_config` option to MemoryViz CLI.
 
 ### 🐛 Bug fixes
 

docs/docs/06-cli.md

@@ -16,8 +16,36 @@ $ npx memory-viz <path-to-file>
 
 replacing `<path-to-file>` with the path to a file containing MemoryViz-compatible JSON. If the file content is not compatible with MemoryViz, an error will be thrown.
 
-Optional arguments `--height` and `--width` can be used to specify the height and width of the generated SVG.
-
 ## Output
 
 The output is an SVG image generated by MemoryViz and the image is saved in the current working directory. The name of the SVG will be the same as that of the inputted file (i.e., if the inputted file is `david-is-cool.json`, the output will be `david-is-cool.svg`).
+
+## Options
+
+Below are optional arguments used to specify the way in which the SVG image is generated.
+
+### `--width`
+
+Specifies the width of the generated SVG.
+
+```console
+$ npx memory-viz <path-to-file> --width=700
+```
+
+### `--height`
+
+Specifies the height of the generated SVG.
+
+```console
+$ npx memory-viz <path-to-file> --height=700
+```
+
+### `--roughjs_config`
+
+Specifies the style of the generated SVG. Please refer to the [Rough.js documentation](https://github.com/rough-stuff/rough/wiki#options) for available options.
+
+The argument is a comma-separated list of key-value pairs in the form `<key1=value1,key2=value2,...>`.
+
+```console
+$ npx memory-viz <path-to-file> --roughjs-config fill=red,fillStyle=solid
+```

memory-viz/bin/cli.js

@@ -5,6 +5,12 @@ const path = require("path");
 const { draw } = require("memory-viz");
 const { program } = require("commander");
 
+function parseRoughjsConfig(input) {
+    const pairs = input.split(",");
+    const keyValuePairs = pairs.map((pair) => pair.split("="));
+    return Object.fromEntries(keyValuePairs);
+}
+
 program
     .description(
         "Command line interface for generating memory model diagrams with MemoryViz"
@@ -14,14 +20,20 @@ program
         "path to a file containing MemoryViz-compatible JSON"
     )
     .option("--width <value>", "width of generated SVG", "1300")
-    .option("--height <value>", "height of generated SVG");
+    .option("--height <value>", "height of generated SVG")
+    .option(
+        "--roughjs-config <key1=value1,key2=value2,...>",
+        "options to configure how the SVG is drawn" +
+            " - refer to rough.js documentation for available options",
+        parseRoughjsConfig
+    );
 
 program.parse();
 
 const filePath = program.args[0];
 const absolutePath = path.resolve(process.cwd(), filePath);
 
-// Checks if absolutePath exists and that it is a JSON file
+// Checks if absolutePath exists
 let fileContent;
 if (!fs.existsSync(absolutePath)) {
     console.error(`Error: File ${absolutePath} does not exist.`);
@@ -40,17 +52,13 @@ try {
 
 let m;
 try {
-    // TODO: Replace seed with command-line arguments
     m = draw(data, true, {
         width: program.opts().width,
         height: program.opts().height,
-        roughjs_config: { options: { seed: 12345 } },
+        roughjs_config: { options: program.opts().roughjsConfig },
     });
 } catch (err) {
-    console.error(
-        `This is valid JSON but not valid Memory Models JSON.` +
-            `Please refer to the repo for more details.`
-    );
+    console.error(`Error: ${err.message}`);
     process.exit(1);
 }