Skip to content

A simple tool to create relationships graphs for Swift codebases

Notifications You must be signed in to change notification settings

Sumolari/swift-relationship-graph

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This project is a small utility to create a relationship graph for protocols, classes and structs in a Swift codebase.

Examples

Alamofire

Haneke

Objectmapper

Requirements

Installation

  1. Ensure your NodeJS version is 6.5.0 or later.
  2. Install Graphviz's dot command line utility.
    • On macOS you can install it with brew:
    brew install graphviz
    
  3. Install package dependencies: npm install.

Installation

Until this is published in NPM registry...

git clone [email protected]:Sumolari/swift-relationship-graph.git
cd swift-relationship-graph
npm install -g .

Usage

swift-relationship-graph <pathToJSON> [<operation>, <type...>, <pathToOutputFile>]

Where filename is the path to a SourceKitten's documentation JSON.

  • Available operations:
    • dotGraphCode
    • dotGraphPDF
    • graph (default, equivalent to dotGraphPDF)
  • Available types (multiple values allowed, comma separated):
    • protocols (default)
    • structs
    • classes

Getting SourceKitten documentation JSON

Ensure you have SourceKitten properly installed and check its usage guide.

Example:

sourcekitten doc -- -workspace Haneke.xcworkspace -scheme Haneke

Examples

Check examples folder to see some demos.

Run each .sh file to automatically download and generate the relationsip diagram of each Open Source sample project.

Todo

  • Improve README
  • Add proper error messages
  • Add examples
  • Call SourceKitten automatically
    • Not a priority, better add support to integrate graph generation in an Xcode plugin.
  • Improve documentation
  • Publish to NPM registry
  • Add support for classes' dependency graph
  • Made it -g-compatible
  • Add legend
  • Add support for generating UML class-like diagrams
  • Add unit tests
  • Add support for filtering by entity (tree mode)

Changelog

0.0.1

  • First version

About

A simple tool to create relationships graphs for Swift codebases

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published