Skip to content

v0.2.0 - 2024-06-28

Compare
Choose a tag to compare
@david-yz-liu david-yz-liu released this 28 Jun 23:08

🚨 Breaking changes

  • Changed the name attribute to type when drawing objects.
  • Removed the isClass and stack_frame attributes and embedded them as the types .class and .frame.
  • Renamed the input for blank objects from BLANK to .blank.
  • Created new type .blank-frame to denote blank stack frames.
  • Replaced seed configuration option with general configuration option roughjs_config.

✨ Enhancements

  • Created a CLI for MemoryViz.
  • Added --height and --width options to MemoryViz CLI.
  • Added --roughjs_config option to MemoryViz CLI.

🐛 Bug fixes

  • Fixed a bug where box fill colours would cover box text, and changed the implementation of hide style option.
  • Removed double quotes when rendering objects of type None.
  • Removed double quotes when rendering objects that are not of type str.

📚 Documentation and demo website changes

  • Added documentation page for the MemoryViz CLI.

🔧 Internal changes

  • Added a changelog and pull request template.
  • Modified roughjs import to be compatible with Jest's moduleNameMapper config option.
  • Added instructions on the memory-viz/README.md for running the test suite.
  • Fix CI build action for demo website.
  • Added data type and manual layout tests for the draw function.
  • Updated file paths for example files under docs to import the correct file.
  • Added style and automatic layout tests for the draw function.
  • Updated documentation, tests, and examples to reflect the isClass attribute being optional and set to false by default.
  • Removed unused imports in demo_C.js.
  • Added type interfaces and type annotations to style.ts.
  • Added DrawnEntity type annotations to source code files.
  • Adopted Commander.js library for the MemoryViz CLI.
  • Added autofix.ci to the CI workflow.