Language Reference

Pełna referencja syntax dla plików Datro DSL (.dtro-Pliki). Każdy typ bloku, każde pole, każdy kod diagnostyczny wszystko w jednym miejscu.

Każdy .dtro-Plik musi rozpocząć się od magicznego nagłówka w linii 1. Parser daje E100 w przypadku braku lub błędu.

#!DATRO 1.0

Opcjonalne metadata na poziomie dokumentu. Wywołuje I003-Wskazówka, jeżeli zostaje ona pominięta. Wszystkie pole z wyjątkiem kind są opcjonalnymi ciągami/arryami.

#!DATRO 1.0

meta {
  title:       "Payment Service"
  version:     "2.1.0"
  description: "Handles card and crypto charges"
  author:      "jane@example.com"
  owner:       "payments-team"
  tags:        ["payments", "critical"]
  sla:         "99.95%"
  criticality: "P0"
  kind:        architecture
}

Oświadczenie jednostki w wykresie. Każdy węzeł ma jednoznaczny identyfikator, type, który kontroluje jego zmieniony kształt i kolor standardowy, oraz opcjonalny attrs-Blok metadanych.

# Minimal
node api_gw { type: gateway label: "API Gateway" }

# With attrs block
node payment_svc {
  type:  service
  label: "Payment Service"
  attrs {
    tech:       "nestjs"
    owner:      "payments-team"
    deprecated: false
    sla:        "99.95%"
  }
}

# Inline attrs (alternative syntax)
node db { type: database label: "Payments DB"  attrs { tech: "postgres" } }

Wyjaśnia relację między dwoma węzłami. Położenie krawędzi jest napisane bezpośrednio w deklaracji.: -> (wysyłane), <-> (bidirekcjonalnie) lub -- (niewykonane).

# Minimal
edge api_gw -> payment_svc { kind: http }

# Full metadata
edge payment_svc -> stripe {
  kind:   http
  label:  "charge API"
  weight: 2.0
  async:  false
  attrs { sla: "200ms" }
}

# Bidirectional edge
edge cache <-> service { kind: read }

# Undirected edge
edge svc_a -- svc_b { kind: depends }

Grupa wiązanych węzłów w opisywanym polu poddiagramu. Węzeł może należeć do jednej grupy – E403 jest wywołana w przypadku konfliktów. Grupy mogą być zestawione: ID członka może odnosić się do innego ID grupy.

group data_tier {
  label:   "Data Layer"
  members: [payments_db, fraud_cache, audit_log]
  attrs { compliance: "PCI-DSS" }
}

# Alternative: assign group on the node
node payments_db {
  type:  database
  label: "Payments DB"
  group: data_tier
}

Oświadcza zasadę architektoniczną, którą weryfikujący ocenia na podstawie IR. Stworzenie naruszeń E501 (lub W501, jeżeli: severity: warn). Połączenie rule wykorzystuje przenikającą gramatykę trzech tokenów.

# Prohibition: databases may not call external services
constraint {
  id:       "no-db-external"
  rule:     "database !-> external"
  message:  "Databases must not connect directly to external APIs"
  severity: error
}

# Requirement: every gateway must connect to a service
constraint {
  rule:     "gateway -> service"
  message:  "Each gateway must route to at least one service"
  severity: warn
}

# Membership: all databases must be in the data_tier group
constraint {
  rule:     "database in data_tier"
  message:  "All database nodes must belong to the data_tier group"
  severity: error
}

Ograniczenia

• `!->` – nie SUBJECT-Węzeł może mieć obręb skierowany do dowolnego OBJECT-Węzły.
• `->` – Każdy SUBJECT-Węzeł musi mieć co najmniej jeden obrót w kierunku OBJECT-Węzły.
• `!<->` – pomiędzy węzłami SUBJECT i OBJECT nie ma dwuosobowej krawędzi.
• `<->` – Każdy SUBJECT-Węzeł musi mieć dwuwyjazdową krawędzię OBJECT-Węzły.
• `in` – Każdy SUBJECT-Węzeł musi być członkiem grupy OBJECT być.
• `!in` – nie SUBJECT-Węzeł może być członkiem grupy OBJECT być.

Rozdziela duże wykresy na kilka .dtro-Pliki. Rozporządnik łączy przywożony IR przed weryfikacją z najwyższym IR. Wykorzystaj as w odniesieniu do przestrzeni nazwisk i expose, Aby umieścić określone identyfikatory na liście białych.

# Import everything from another .dtro file
import "auth.dtro"

# Import with a namespace alias — IDs become auth.user_service, etc.
import "auth.dtro" as auth

# Import only specific IDs (whitelist)
import "infra.dtro" as infra expose [load_balancer, cdn]

Informacje dla przedstawiciela w sprawie układu wykresu. Wszystkie pole są opcjonalne renderer używa istotnych wartości standardowych, gdy blok zostaje pominięty.

layout {
  direction:       LR          # LR | RL | TB | BT
  algo:            dagre        # dagre | dot | elk | force | none
  node_sep:        60           # px between nodes in the same rank
  rank_sep:        120          # px between ranks
  margin:          20           # graph margin in px
  cluster_padding: 16           # padding inside group boxes
}

Kontrola wygląd wizualny zwrotnego wykresu. Ten palette Kształtuje typy węzłów w kolorze hex. Podblokowy accessibility umożliwia automatyczne sprawdzanie kontrastów WCAG 2.1.

theme {
  name: "Corporate"

  palette {
    service:    "#D0E8FF"
    database:   "#FFE8C0"
    gateway:    "#FFD0D0"
    queue:      "#E8D0FF"
    cache:      "#C0FFE8"
    external:   "#F0F0F0"
    background: "#FFFFFF"
  }

  typography {
    font_family:      "Inter, sans-serif"
    node_font_size:   11
    edge_font_size:   9
    label_font_weight: "600"
  }

  accessibility {
    min_contrast:    AA          # AA | AAA | none
    max_label_length: 60
  }
}

Szczegółowe stopniowe przesłanki dla każdego elementu, stosowane według tematu. Wykorzystanie władzy: by_id przekształcanie by_type. Każdy podbloki ustawia klucz do przydziału właściwości.

style {
  # Override by node type
  by_type {
    database { fill: "#FFF3CD"  stroke: "#E6A817"  shape: cylinder }
    external { fill: "#F8F9FA"  stroke: "#6C757D"  dash: true }
  }

  # Override individual node by id
  by_id {
    stripe { fill: "#635BFF"  stroke: "#4B44CC" }
  }

  # Style edge kinds
  by_edge_kind {
    query   { color: "#E6A817"  width: 2 }
    publish { color: "#198754"  dash: true }
  }

  # Style edges that carry a boolean attr set to true
  by_edge_attr {
    async { dash: true  color: "#ADB5BD" }
  }
}

Wszystkie diagnozy obejmują code, severity, message i opcjonalny line:col-Mieszkanie. W poniższej tabeli znajduje się każdy kod, który może wydać łańcuch narzędzi.

Błąd (E)×××)

• `E100` – "Magic-Header" #!DATRO 1.0 brakuje lub jest błędne
• `E201` – Podwójny identyfikator węzłów
• `E202` – Węzły odnoszą się do nieznanego ID grupy
• `E301` – Węzły krawędzi from nie znaleziono
• `E302` – Węzły krawędzi to nie znaleziono
• `E303` – Krawędzi weight jest negatywny
• `E401` – Podwójna identyfikacja grupy
• `E402` – Grupa members wskazuje na nieznany identyfikator
• `E403` – Węzły przypisane do więcej niż jednej grupy
• `E404` – Zidentyfikowane zakładki grup w kształcie okręgowym
• `E500` – Rzecz ograniczająca wykazuje błąd w syntaxie
• `E501` – W przypadku naruszenia reguły ograniczenia (sciwota odzwierciedla własną severity ograniczenia)

ostrzeżenia (B)×××)

• `W301` – Duplikowanie krawędzi (równoważne z / do / rodzaju / oznakowania))
• `W501` – Rzecz ograniczająca używa nieznanego czasownika
• `W601` – Powyższe oznakowanie węzłów max_label_length (Standardowe 80 znaków)
• `W602` – Kolor palety tematycznej jest poniżej kontrastu WCAG AA (4,5:1)
• `W603` – Kolor palety tematycznej jest poniżej kontrastu AAA WCAG (7,0:1)

Informacje (I)×××)

• `I001` – Węzły izolowane bez krawędzi do niego połączonych
• `I002` – Puste grupy nie deklarowany członek
• `I003` – Żaden meta-Blok zalecany do dokumentacji
• `I601` – Nie zdefiniowano palety tematycznych przejście kontrastów

• Wykorzystaj CLI Reference do weryfikacji, formatowania i eksportowania za pomocą linii poleceń.
• Wkładać wykresy w markdown za pomocą plugina markdown.
• Wróć do Quick Start dla instrukcji krok po kroku.