Skip to content

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.

License

Notifications You must be signed in to change notification settings

slimlime/swift-auto-diagram

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

Usage:

In terminal run:

$ ruby generateEntityDiagram.rb

If you don't specify any command line arguments then the script will search for all swift files in the script's main directory. 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.

Tutorial:

https://martinmitrevski.com/2016/10/12/swift-class-diagrams-and-more/

Notice:

The state of the project is still in a beta version which means it still may not run or may be not accurate for all projects. We hope to see more contributors help make this a wonderful developer tool even better.

Initial creators:

https://github.com/yoshimkd

https://github.com/ZdravkoN

Contributors:

https://github.com/ivanfoong

About

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.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 83.0%
  • Ruby 11.3%
  • CSS 4.1%
  • HTML 1.6%