TangleGuard

Helps you keep spaghetti code out of your codebase.

TangleGuard visualizes your software architecture, so you know how the degree of coupling and cohesion, and hence can keep an easy-to-maintain and scalable code structure.

View Website, Docs, Live Demos

Features

• Interactive Architecture Analysis: View your codebase as an interactive dependency graph for suitable layouts. Click on edges or hover over nodes to get more information.
• Dependency Rule System: Define dependency rules in a configuration file and TangleGuard detects violations. See the docs on how to set it up.
• Circular dependencies detection: Dependencies which form a cycle are highlighted and a list of all the import statements which form that cycles is displayed, so you know where to refactor.
• Experimental Metrics: Calculates metrics on the fly depending on the current view

Usage

1. Open the UI

1. Open a Rust workspace in VS Code
2. Open the Command Palette (Cmd+Shift+P / Ctrl+Shift+P)
3. Run the command: "Analyze Architecture"

This opens the TangleGuard UI, which is also used in the desktop app.

2. Explore Your Codebase

• Zoom in or out via mouse wheel or touchpad
• Filter the dependency graph
  • Adjust the depth/zoom level for get more or less details
  • Filter packages by their name
  • Filter nodes by their LOC
  • Filter dependencies/edges by type
• Click on edges to see what flows over that edge

More about the exploration feature here.

3. Define Your High-Level Architecture

• Click on the layer icon in the left, vertical menu
• Add layers to the canvas and draw the allowed dependencies
• For each layer, specify the relative path in your codebase, where the components are for that layer
• TangleGuard will automatically run the violation check and you can see the violations

More about the dependency rules here.

Currently Supported Languages

• Rust
• Go
• Javascript (early stage)
• PHP (experimental)
• Kotlin (experimental)

For more information about the language support visit TangleGuard Docs

Performance

• Fast Scanning: Scans your codebase within milliseconds - the scanner is written in Rust
• Fast Visualization Data: The viz data is created within using WebAssembly