Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simonbs/dependency-graph

🕸️ dependency-graph is a command-line tool that can visualize the dependencies of packages.
https://github.com/simonbs/dependency-graph

ios macos swift swiftpackage swiftpackagemanager xcode

Last synced: 7 days ago
JSON representation

🕸️ dependency-graph is a command-line tool that can visualize the dependencies of packages.

Awesome Lists containing this project

README 

        
# 🕸️ dependency-graph



[![Build and Test](https://github.com/simonbs/dependency-graph/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/simonbs/dependency-graph/actions/workflows/build_and_test.yml) [![SwiftLint](https://github.com/simonbs/dependency-graph/actions/workflows/swiftlint.yml/badge.svg)](https://github.com/simonbs/dependency-graph/actions/workflows/swiftlint.yml)



dependency-graph is a command-line tool that can visualize the dependencies of packages. The tool takes the path to an Xcode project or a Package.swift file as input and outputs a graph that shows the dependencies of the packages in the project or package.



## 👀 Examples



The following graphs are examples of the graphs that dependency-graph can output. The first graph built by providing dependency-graph the path to a Package.swift file and the second graph was made by providing dependency-graph the path to an .xcodeproj file as input.



|Swift Package|Xcode Project|

|-|-|

|Example graph showing the dependencies of this package.|Example graph showing the dependencies of an Xcode project.|



Nodes shaped as ellipsis represent products, e.g. the libraries in a Swift package, and the square nodes represent targets.



## 🚀 Getting Started



Start off by installing the tool with [Homebrew](https://brew.sh).



```bash

brew tap simonbs/dependency-graph https://github.com/simonbs/dependency-graph.git

brew install dependency-graph

```



> **Note**

> If you get the following error when attempting to install dependency-graph:

>

> ```

> Error: Cannot install under Rosetta 2 in ARM default prefix (/opt/homebrew)!

> To rerun under ARM use:

>    arch -arm64 brew install ...

> To install under x86_64, install Homebrew into /usr/local.

> ```

>

> You can use the the following to install dependency-graph:

>

> ```bash

> arch -arm64 brew install dependency-graph

> ```



You may now run the following command to verify that the tool was installed correctly. The following command should print information on how the tool can be used.



```

dependency-graph --help

```



Run the `dependency-graph` command with the path to a folder containing an .xcodeproj or Package.swift file.



```bash

dependency-graph ~/Developer/Example

```



You may also pass the full path to the .xcodeproj or Package.swift file as shown below.



```bash

dependency-graph ~/Developer/Example/Example.xcodeproj

```



### Rendering a Graph



The `dependency-graph` command will output a textual representation of a graph. By default the tool will output a graph using the [DOT syntax](https://graphviz.org/doc/info/lang.html). For example, if the Xcode project or Package.swift file contains the following dependencies:



```

Library A in Package A depends on Target A

Library B in Package B depends on Target B

Library A in Package A depends on Library B in Package B

```



The output of the tool would be a graph that looks like this:



```dot

digraph g {

  subgraph cluster_packageA {

    label="Package A"

    libraryA [label="LibraryB", shape=ellipse]

    targetA [label="TargetA", shape=box]

  }



  subgraph cluster_packageB {

    label="Package B"

    libraryB [label="LibraryB", shape=ellipse]

    targetB [label="TargetB", shape=box]

  }



  libraryA -> targetA

  libraryB -> targetB

  libraryA -> libraryB

}

```



The output can be rendered to an image by piping it to a renderer. See the following sections for details on the supported renderers.



#### DOT



Example graph rendered with dot.



By default dependency-graph will use the DOT syntax which can be rendered by the [dot CLI](https://graphviz.org/doc/info/command.html), which is part of [Graphviz](https://graphviz.org).



Install Graphviz and run `dependency-graph` and pass the output to the newly installed `dot` CLI.



```bash

brew install graphviz

dependency-graph ~/Developer/Example | dot -Tsvg -o graph.svg

```



When rendering the graph to a PNG, you will likely want to specify the size of the output to ensure it is readable. To generate an image with dot that is exactly 6000 pixels wide or 8000 pixels tall but not necessarily both, do the following:



```bash

dependency-graph ~/Developer/Example | dot -Tpng -Gsize=60,80\! -Gdpi=100 -o graph.png

```



You may want to play around with the values for `--node-spacing` and `--rank-spacing` to increase the readability of the graph.



```bash

dependency-graph --node-spacing 50 --rank-spacing 150 ~/Developer/Example | dot -Tsvg -o graph.svg

```



For large projects the graph may become unreadable. Passing the output through Grahpviz' [unflatten](https://graphviz.org/docs/cli/unflatten/) command may improve the results.



```bash

dependency-graph ~/Developer/Example | unflatten -l 100 -c 100 -f | dot -Tpng -o graph.png

```



#### Mermaid



Example graph rendered with mermaid.



Specify the `--syntax mermaid` option to have dependency-graph output a graph using [the Mermaid diagram syntax](https://mermaid-js.github.io/mermaid/#/flowchart).



The output be rendered to an image using the [the mermaid cli](https://github.com/mermaid-js/mermaid-cli).



```bash

npm install -g @mermaid-js/mermaid-cli

dependency-graph --syntax mermaid ~/Developer/Example | mmdc -o graph.svg

```



To generate an image on a page that is 6000 pixels wide with mermaid, do the following:



```bash

dependency-graph --syntax mermaid ~/Developer/Example | mmdc -o graph.png -w 6000

```



You may also want to play around with the values for `--node-spacing` and `--rank-spacing` to increase the readability of the graph.



```bash

dependency-graph --syntax mermaid --node-spacing 50 --rank-spacing 150 ~/Developer/Example | mmdc -o graph.png

```



#### D2



Example graph rendered with D2.



Specify the `--syntax d2` option to have dependency-graph output a graph using [the d2 scripting language](https://d2lang.com/tour/intro).



The output be rendered to an image using the [the d2 cli](https://github.com/terrastruct/d2#install).



```bash

curl -fsSL https://d2lang.com/install.sh | sh -s --

dependency-graph --syntax d2 ~/Developer/Example | d2 - graph.png

```



The ELK layout engine renders some quite tidy graphs, as shown in the example below.



Example graph rendered with D2 and the ELK layout engine.



## Graphing Packages Only



Pass the `--packages-only` flag to include only the Xcode project and Swift packages in the graph. This omits the libraries and targets within the Xcode project and Swift packages.



Example graph showing only an Xcode project and Swift packages.



## 🤷‍♂️ OK, why?



As I'm splitting my iOS and macOS applications into small Swift packages with several small targets, I started wishing for a way to visualise the relationship between the products and targets in my Swift packages. That's why I built this tool.



Several other tools can visualise a Swift package, however, I wanted a tool that can take both a Swift package and an Xcode project as input.



The example in the top of this README shows a visualization of a Swift package and the graph below shows a visualisation of an Xcode project.

Notice that the left-most subgraph represents an Xcode project named ScriptUIEditor.xcodeproj and it has three targets: ScriptUIEditor, ScriptBrowserFeature, and ScriptBrowserFeatureUITests. Two of these depends on the Swift packages represented by the remaining subgraphs.



These graphs provide a good way to get an overview of a package or the relationship between several packages. Sometimes it can be helpful to generate multiple graphs to get a good overview, for example, a graph of the entire project and graphs of selected packages. Fortunately, the `dependency-graph` CLI makes this easy as it can take either an Xcode project and a Package.swift file as input.



## 🧐 ...but how?



dependency-graph parses Xcode project using [XcodeProj](https://github.com/tuist/XcodeProj) and interprets Package.swift files using the output from the `swift package dump-package` command. 



This means that dependency-graph does not perform any package resolution or build the project, making it very fast to run the `dependency-graph` command but also produces a less detailed output that tools that rely on package resolution.



The tool has a focus on visualising local dependencies, that is, Swift packages stored locally in a project. dependency-graph will include remote dependencies in the visualisation but it will not clone those dependencies to determine their dependency graph. It is technically possible to include this but it has not been necessary for my use cases.