Open mikelord007 opened 2 months ago
The recent updates introduce a new automation script for generating UML diagrams from Solidity contracts, enhancing project documentation. A corresponding dependency on sol2uml
is added to facilitate this process. This integration streamlines the development workflow by allowing developers to visualize contract structures efficiently, all while maintaining the existing functionality of the project.
File(s) | Change Summary |
---|---|
package.json |
Added "generate:diagrams" script and new dependency "sol2uml": "^2.5.20" |
scripts/generate_uml_diagrams.sh |
Introduced script to automate UML diagram generation and Solidity contract flattening |
🐇 In the meadow of code, the rabbits play,
With diagrams hopping, brightening the day.
A script for the contracts, so clever and neat,
Visualizing the flows, a wonderful treat!
Withsol2uml
in tow, we dance and we cheer,
For clearer designs, our vision is clear! 🌼
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Hey @lumtis
I don't think there is a tool in foundry that can do the same. For the current solution ( sol2uml ) we don't need hardhat, just nodejs + soul2uml will do. ( in the current process, we're using hardhat to flatten the contracts so sol2uml doesn't fail while generating the diagrams, but flattening can be done with foundry too )
Summary by CodeRabbit
New Features
Dependencies
sol2uml
) to support UML diagram generation, enriching the functionality related to Solidity contracts.