Dependency Graphs in Readme's

[JacksonUtsch]

GitHub recently introduced rendering support for the Mermaid language in markdown files. This allows diagrams to be rendered.

The flowchart does well to represent unidirectional flow. I've used it in an application to show how the Package.swift is structured. Ultimately this could be made into a GitHub Action and automated using SwiftPM The purpose is for developers to visualize the dependency graph in their projects.

Here's an example:

Dependency Graph

  graph TD;
      TCA--> Shared;
      
      Shared-->FeatureA;
      ClientA--> FeatureA;
      RemoteDependencyA--> FeatureA;
      RemoteDependencyB--> FeatureA;
      
      FeatureA--> FeatureATests;
      
      RemoteDependencyA--> FeatureB;
      Shared--> FeatureB;
      
      FeatureB--> FeatureBTests;
      
      FeatureA-->App;
      FeatureB-->App;
      
      App-->AppTests;

Loading

Would anyone be inclined to use this?

[JackYoustra]

This looks so cool! Did you end up writing it up?

[JacksonUtsch]

Have only opted for manual usage, haven't taken the time to figure out an action for it.