Closed sarahsonder closed 4 months ago
@sarahsonder good questions.
.svg
. (Future work could involve allowing the user to specify an output file.) memory-viz/README.md
with a sample invocation, and (2) yes create a new documentation page for the CLI. It can be pretty bare-bones for now, but hopefully it will grow over time as we add new options. π You can use some professional pages as templates to follow, e.g. https://jestjs.io/docs/cli. npx memory-viz <whatever>
and check the file contents (ideally, against a snapshot!).The purpose of this pull request is to create a command line interface for MemoryViz. This is to make it easier to run MemoryViz.
To run the CLI, run npm i
to install the CLI and then run npx memory-viz <file-to-path>
, replacing <path-to-file>
with the path to a file containing MemoryViz-compatible JSON
Type | Applies? |
---|---|
π¨ Breaking change (fix or feature that would cause existing functionality to change) | |
β¨ New feature (non-breaking change that adds functionality) | X |
π Bug fix (non-breaking change that fixes an issue) | |
π¨ User interface change (change to user interface; provide screenshots) | |
β»οΈ Refactoring (internal change to codebase, without changing functionality) | |
π¦ Test update (change that only adds or modifies tests) | |
π Documentation update (change that only updates documentation) | |
π¦ Dependency update (change that updates a dependency) | |
π§ Internal (change that only affects developers or continuous integration) |
Before opening your pull request:
After opening your pull request:
I am unsure as the why the Github tests are failing. The issue seems to be that the files/branch cannot be found. I left a more detailed message on Slack. Thank you!
@sarahsonder don't put the pull request template in a comment. Instead edit the pull request description so that it contains the full information.
Totals | |
---|---|
Change from base Build 9558270699: | 0.0% |
Covered Lines: | 388 |
Relevant Lines: | 429 |
Totals | |
---|---|
Change from base Build 9558270699: | 0.0% |
Covered Lines: | 388 |
Relevant Lines: | 429 |
Proposed Changes
The purpose of this pull request is to create a command line interface for MemoryViz. This is to make it easier to run MemoryViz.
To run the CLI, run
npm i
to install the CLI and then runmemory-viz <file-to-path>
, replacing<path-to-file>
with the path to a file containing MemoryViz-compatible JSONType of Change
Checklist
Before opening your pull request:
After opening your pull request:
Questions and Comments