Skip to content
TangleGuard Docs

Linter

TangleGuard provides also a structural linter, to keep your project’s architecture in place - also when working in large teams.

This CLI tool only verifies your source code regarding the defined dependency rules which you define via the TangleGuard Designer, see here.

Configuration File

Section titled “Configuration File”

The configuration made within the desktop app (the designer), are stored in a JSON file named tangleguard.json in the root of your software project.

  • Directorysrc/
    • …
  • Cargo.toml
  • tangleguard.json

If you use the Desktop App for the first time, TangleGuard will create that file for you. The file is supposed to be included in Git. Below are some advantages listed to have such file.

Below you see an example configuration.

{
  "layers": [
    {
      "name": "Interaction",
      "description": "",
      "packages": ["rest-api", "graphql-api"]
    }
  ],
  "packages": [
    {
      "name": "rest-api",
      "dependencies": ["utils"],
      "focus": "technical"
    }
  ],
  "rules": [
    {
      "from": "Interaction",
      "to": "Services"
    }
  ],
  "domains": [
    {
      "name": "User Management",
      "dsl": ["OAuth", "Token", "Role"],
      "domain_type": "Generic"
    }
  ]
}

You can edit the file manually but it’s highly recommended to use the UI instead.