search

Machinalabs / remix-plugin-proposals

A repository that contains a list of Remix plugin proposals
0 stars 0 forks source link

RPP 04 - Sol2UML #4

Closed EdsonAlcala closed 3 years ago

EdsonAlcala commented 4 years ago

Solidity to UML Remix Plugin

Background

UML diagrams are visual representations of a system, it helps to better understand its functionality and component's relationship.

There is previous work to generate UML diagrams from Solidity and it was integrated into Etherscan (see image below)

Screenshot 2020-05-11 at 21 07 56

Image source: https://etherscan.io/viewsvg?t=1&a=0x89d24a6b4ccb1b6faa2625fe562bdd9a23260359

Proposal

Design

remix-solidity-2-uml

Note: The UML diagram style could change due to sol2UML dependencies compatibility in the browser.

Resources / References

[Sol2UML] (https://github.com/naddison36/sol2uml) [Solidity-parser-antlr] (https://github.com/ConsenSys/solidity-parser-antlr)

LianaHus commented 4 years ago

IMHO there should be a way to export this to be able to share. @EdsonAlcala Do you have any suggestions for that?

EdsonAlcala commented 4 years ago

that would be very cool, maybe some way to export to pdf? or image? Or maybe a shareable link? For instance this one http://www.nomnoml.com/ it is like a viewer, you can paste code and view the diagram