search

yoshimkd / swift-auto-diagram

A Ruby script that scans all swift code from the specified folders and files and automatically generates an entity diagram (similar to a class diagram) which can be viewed in a browser.
MIT License
496 stars 57 forks source link

Flag to only take into account your projects classes, not Apple or third party libraries. #22

Open carlosandresSanchez opened 5 years ago

carlosandresSanchez commented 5 years ago

The script generates a complex diagram with thousands of classes because I'm using several libraries like RxSwift. Is there a way to only display the classes of your own project?

yoshimkd commented 5 years ago

Hello @carlosandresSanchez,

Thank you very much for your interest in the project. Yes, there is a way to specify which exact files or folders you want to create a diagram for. I quote this from the Readme file:

You can specify any number of command line arguments which should be existing directory or file paths. The directories will be searched in depth for swift files recursively.

Let us know whether this solves your issue with too many displayed entities.

lewis-smith commented 5 years ago

If I run ruby generateEntityDiagram.rb ~/code/myproject/ it still includes native classes, for example String. Is this intended? It would be great to exclude them.

Thanks for such a cool project!