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 тудырады (немесе severity: warn кезінде W501). 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 түйінінің ->] түйініне бағытталған кемінде бір жиегі болуы керек.
• `!<->` — 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 орнын қамтиды. Төмендегі кестеде құралдар тізбегі шығара алатын әрбір код берілген.

Қателер (E×××)

• `E100` — Сиқырлы тақырып #!DATRO 1.0 жоқ немесе дұрыс емес
• `E201` — Түйін идентификаторының көшірмелері
• `E202` — Түйін белгісіз топ идентификаторына сілтеме жасайды
• `E301` — Edge from түйіні табылмады
• `E302` — Edge to түйіні табылмады
• `E303` — weight жиегі теріс
• `E401` — Қайталанатын топ идентификаторы
• `E402` — members тобы белгісіз идентификаторға сілтеме жасайды
• `E403` — Түйін бірнеше топқа тағайындалған
• `E404` — Дөңгелек топтың ұя салуы анықталды
• `E500` — Шектеу ережесінде синтаксистік қате бар
• `E501` — Шектеу ережесі бұзылды (қаттылық шектеудің өз severity көрінісін көрсетеді)

Ескертулер (W×××)

• `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 бетіне оралыңыз.