Language Reference

Полный справочник по синтаксису Datro DSL (файлы .dtro). Каждый тип блока, каждое поле, каждый диагностический код — все в одном месте.

Каждый файл .dtro должен начинаться с магического заголовка в строке 1. Анализатор возвращает E100 если он отсутствует или имеет неверный формат.

#!DATRO 1.0

Необязательные метаданные уровня документа. Создает информационную подсказку I003, если она опущена. Все поля являются необязательными строками/массивами, кроме kind.

#!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
}

Объявляет сущность на диаграмме. Каждый узел имеет уникальный идентификатор, семантический type, который управляет его отображаемой формой и цветом по умолчанию, а также необязательный блок attrs для метаданных.

# 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" } }

Объявляет связь между двумя узлами. Направление ребра записывается непосредственно в объявлении: -> (направленное), <-> (двунаправленное) или -- (ненаправленное).

# 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 }

Кластеризует связанные узлы в помеченный блок подграфа. Узел может принадлежать не более чем к одной группе — E403 срабатывает при конфликтах. Группы могут быть вложенными: идентификатор участника может ссылаться на другой идентификатор группы.

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
}

Объявляет архитектурное правило, которое валидатор сравнивает с IR. Нарушения приводят к появлению E501 (или W501 при severity: warn). Поле rule использует краткую грамматику из трех токенов.

# 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
}

Ограничительные глаголы

• `!->` — ни один узел SUBJECT не может иметь направленное ребро ни к одному узлу OBJECT.
• `->` — каждый узел SUBJECT должен иметь хотя бы одно ребро, направленное к узлу OBJECT.
• `!<->` — между узлами SUBJECT и OBJECT не может существовать двунаправленного ребра.
• `<->` — каждый узел SUBJECT должен иметь двунаправленное ребро к некоторому узлу OBJECT.
• `in` — каждый узел SUBJECT должен быть членом группы OBJECT.
• `!in` — ни один узел SUBJECT не может быть членом группы OBJECT.

Разбивает большие диаграммы на несколько файлов .dtro. Резолвер объединяет импортированный IR с родительским перед проверкой. Используйте as для пространства имен и expose для внесения в белый список определенных идентификаторов.

# 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]

Подсказки рендереру о том, как расположить график. Все поля являются необязательными — средство визуализации использует разумные значения по умолчанию, когда блок опущен.

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
}

Управляет внешним видом визуализированной диаграммы. palette отображает типы узлов в шестнадцатеричные цвета. Субблок accessibility включает автоматическую проверку контрастности 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
  }
}

После темы применяются детальные переопределения для каждого элемента. Каскад правил: by_id переопределяет by_type. Каждый подблок сопоставляет ключ с картой свойств.

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" }
  }
}

Все диагностические данные включают в себя code, severity, message и необязательное расположение line:col. В таблице ниже перечислены все коды, которые может генерировать инструментальная цепочка.

Ошибки (Е×××)

• `E100` — Магический заголовок #!DATRO 1.0 отсутствует или имеет неверный формат.
• `E201` — Повторяющийся идентификатор узла
• `E202` — Узел ссылается на неизвестный идентификатор группы.
• `E301` — Краевой узел from не найден
• `E302` — Краевой узел to не найден
• `E303` — Край weight отрицательный
• `E401` — Повторяющийся идентификатор группы
• `E402` — Группа members ссылается на неизвестный идентификатор.
• `E403` — Узел принадлежит более чем одной группе.
• `E404` — Обнаружено циклическое вложение групп.
• `E500` — Правило ограничения содержит синтаксическую ошибку.
• `E501` — Правило ограничения нарушено (серьезность соответствует собственной severity) ограничения.

Предупреждения (Ш×××)

• `W301` — Дублирующееся ребро (то же самое от/до/вид/метка)
• `W501` — правило ограничения использует неизвестный глагол.
• `W601` — метка узла превышает max_label_length (80 символов по умолчанию)
• `W602` — цвет палитры темы ниже контрастности WCAG AA (4,5:1)
• `W603` — цвет палитры темы ниже контрастности WCAG AAA (7,0:1)

Информационные подсказки (I×××)

• `I001` — Изолированный узел — к нему не подключаются ребра
• `I002` — Пустая группа — члены не объявлены
• `I003` — Блок meta отсутствует — рекомендуется для документации
• `I601` — Палитра темы не определена — проверки контрастности пропускаются.

• Используйте CLI Reference для проверки, форматирования и экспорта из командной строки.
• Встраивайте диаграммы в Markdown с помощью Markdown plugin.
• Вернитесь к Quick Start для пошагового руководства.