Language Reference

Referência de sintaxe completa para o Datro DSL (arquivos .dtro). Cada tipo de bloco, cada campo, cada código de diagnóstico — tudo em um só lugar.

Todo arquivo .dtro deve começar com o cabeçalho mágico na linha 1. O analisador retorna E100 se estiver ausente ou malformado.

#!DATRO 1.0

Metadados opcionais em nível de documento. Produz dica de informação I003 se omitida. Todos os campos são strings/matrizes opcionais, exceto 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
}

Declara uma entidade no diagrama. Cada nó possui um ID exclusivo, um type semântico que controla sua forma renderizada e cor padrão e um bloco attrs opcional para metadados.

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

Declara um relacionamento entre dois nós. A direção da borda é escrita diretamente na declaração: -> (direcionado), <-> (bidirecional) ou -- (não direcionado).

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

Agrupa nós relacionados em uma caixa de subgráfico rotulada. Um nó pode pertencer a no máximo um grupo — E403 dispara em conflitos. Os grupos podem ser aninhados: um ID de membro pode fazer referência a outro ID de grupo.

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
}

Declara uma regra arquitetônica que o validador avalia em relação ao IR. Violações produzem E501 (ou W501 quando severity: warn). O campo rule usa uma gramática concisa de três tokens.

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

Verbos de restrição

• `!->` — nenhum nó SUBJECT pode ter uma borda direcionada para qualquer nó OBJECT.
• `->` — cada nó SUBJECT deve ter pelo menos uma aresta direcionada para um nó OBJECT.
• `!<->` — nenhuma borda bidirecional pode existir entre os nós SUBJECT e OBJECT.
• `<->` — todo nó SUBJECT deve ter uma borda bidirecional para algum nó OBJECT.
• `in` — cada nó SUBJECT deve ser membro do grupo OBJECT.
• `!in` — nenhum nó SUBJECT pode ser membro do grupo OBJECT.

Divide diagramas grandes em vários arquivos .dtro. O resolvedor mescla o IR importado no pai antes da validação. Use as para namespace e expose para colocar IDs específicos na lista de permissões.

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

Dicas para o renderizador sobre como organizar o gráfico. Todos os campos são opcionais — o renderizador usa padrões sensíveis quando o bloco é omitido.

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
}

Controla a aparência visual do diagrama renderizado. O palette mapeia os tipos de nós para cores hexadecimais. O subbloco accessibility permite a verificação automática de contraste 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
  }
}

Substituições refinadas por elemento aplicadas após o tema. Cascata de regras: by_id substitui by_type. Cada subbloco mapeia uma chave para um mapa de propriedades.

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

Todos os diagnósticos incluem um local code, severity, message e um local opcional line:col. A tabela abaixo lista todos os códigos que o conjunto de ferramentas pode emitir.

Erros (E×××)

• `E100` — Cabeçalho mágico #!DATRO 1.0 ausente ou malformado
• `E201` — ID do nó duplicado
• `E202` — O nó faz referência a um ID de grupo desconhecido
• `E301` — Nó de borda from não encontrado
• `E302` — Nó de borda to não encontrado
• `E303` — A borda weight é negativa
• `E401` — ID de grupo duplicado
• `E402` — O grupo members faz referência a um ID desconhecido
• `E403` — O nó é atribuído a mais de um grupo
• `E404` — Aninhamento de grupo circular detectado
• `E500` — A regra de restrição tem um erro de sintaxe
• `E501` — A regra de restrição foi violada (a gravidade reflete a própria severity da restrição)

Avisos (L×××)

• `W301` — Borda duplicada (igual de/para/tipo/rótulo)
• `W501` — A regra de restrição usa um verbo desconhecido
• `W601` — O rótulo do nó excede max_label_length (padrão 80 caracteres)
• `W602` — A cor da paleta do tema fica abaixo do contraste WCAG AA (4,5:1)
• `W603` — A cor da paleta do tema fica abaixo do contraste WCAG AAA (7,0:1)

Dicas de informação (I×××)

• `I001` — Nó isolado — nenhuma aresta se conecta a ele
• `I002` — Grupo vazio — nenhum membro declarado
• `I003` — Sem bloco meta — recomendado para documentação
• `I601` — Nenhuma paleta de tema definida — verificações de contraste ignoradas

• Use o CLI Reference para validar, formatar e exportar a partir da linha de comando.
• Incorpore diagramas no Markdown com o Markdown plugin.
• Volte para Quick Start para um passo a passo.