dw-check

🇺🇸 Read in English

CLI para validar scripts DataWeave 2.x via API pública do MuleSoft DataWeave Playground.

Zero dependências. Roda em Node.js >= 14.

Instalação

npm install -g @mrvook/dw-check
# ou use via npx:
npx @mrvook/dw-check script.dwl

Uso

# Validar arquivo de script
dw-check meu-script.dwl

# Validar script inline
dw-check --inline "%dw 2.0\noutput json\n---\n{message: \"hello\"}"

# Com inputs (payload, vars, etc.)
dw-check script.dwl --input payload=entrada.json
dw-check script.dwl --input payload=dados.json --input vars=contexto.json

# Checagem de sintaxe apenas (ignora erros de input)
dw-check script.dwl --only-syntax

# Mostrar output em caso de sucesso
dw-check script.dwl --input payload=entrada.json --output

# Saída JSON (para CI/CD)
dw-check script.dwl --json

# Saída otimizada para agentes AI (com contexto, snippets, sugestões)
dw-check script.dwl --agent

# Silencioso — só retorna exit code (0=ok, 1=erro, 2=falha)
dw-check script.dwl --silent

# Validar todos os scripts DW em um arquivo XML do Mule
dw-check --mule-file wallet.xml --resources src/main/resources

# Resolver imports de módulos customizados
dw-check script.dwl --resources src/main/resources
dw-check script.dwl -r src/main/resources -r src/test/resources

# Via stdin
cat script.dwl | dw-check --input payload=entrada.json

Exit codes

| Code | Significado | |------|-------------| | 0 | Script válido | | 1 | Erro de compilação/validação | | 2 | Falha na requisição (rede, timeout) | | 3 | Resposta inválida da API |

Formato dos erros

Erros incluem: tipo (CompilationException, etc.), mensagem, e localização exata (linha, coluna, snippet).

Exemplo:

✘ CompilationException
Missing Object Field Expression. e.g  {a: 123}

4| {message: }
            ^
Location:
main (line: 4, column:10)

  em main line 4:10

Modo somente sintaxe (--only-syntax)

Ignora erros relacionados a inputs (payload/vars ausentes, etc.) e reporta apenas erros de sintaxe e compilação. Útil para validar a estrutura do script sem fornecer dados de entrada.

# Script referencia payload — normalmente daria erro, suprimido com --only-syntax
dw-check script.dwl --only-syntax
# ✔ Script valid (script.dwl) — input errors suppressed

# Script com erro de sintaxe real — ainda é exibido
dw-check script.dwl --only-syntax
# ✘ CompilationException
# Missing Object Field Expression. e.g {a: 123}

Saída JSON inclui contagem inputErrorsSuppressed:

{ "success": true, "output": null, "inputErrorsSuppressed": 1 }

Rastreamento de erros em imports

Ao usar --resources para importar um arquivo .dwl, erros que ocorrerem no arquivo importado são reportados com o arquivo e linha reais de origem — não a linha do import no script principal.

Exemplo — erro em módulo importado:

main.dwl:

%dw 2.0
output json
import formatName from modules::utils
---
formatName(payload.name)

modules/utils.dwl (linha 5 tem erro de sintaxe):

%dw 2.0
import * from dw::core::Strings

fun formatName(name) =
    {name: }  // ← valor ausente após ":" na linha 5

Saída:

✘ CompilationException
Missing Object Field Expression. e.g {a: 123}

  em modules/utils.dwl line 5:12

O erro aponta para modules/utils.dwl linha 5 — o arquivo e linha reais onde está o bug.

Saída JSON inclui sourceFile:

{
  "success": false,
  "error": {
    "kind": "CompilationException",
    "message": "Missing Object Field Expression.",
    "location": {
      "source": "modules/utils.dwl",
      "sourceFile": "modules/utils.dwl",
      "line": 5,
      "column": 12
    }
  }
}

Imports aninhados são rastreados por toda a cadeia. Se A importa de B que importa de C, um erro em C aponta corretamente para o arquivo e linha em C.

Modo arquivo Mule (--mule-file)

Detecta todos os blocos de script DataWeave (%dw 2.0 dentro de CDATA) em um arquivo de configuração XML do MuleSoft e valida cada um individualmente. Os blocos são validados somente sintaxe — erros de input como payload ausente são automaticamente ignorados.

# Validar todos os scripts DW em um XML do Mule
dw-check --mule-file wallet.xml

# Com resolução de módulos customizados
dw-check --mule-file wallet.xml --resources src/main/resources

# Saída JSON para CI/CD
dw-check --mule-file wallet.xml --json

Saída:

── wallet.xml: 15 DW scripts ──

  [OK    ] #1 var=formatName (line 45)
  [OK    ] #2 var=validateInput (line 92)
  [ERROR ] #3 var=transformResponse (line 134)
  [OK    ] #4 set-payload (line 201)
  ...

── Results ──
Total: 15 | OK: 13 | ERROR: 2

ERRORS:
  #3 var=transformResponse (line 134):
    [CompilationException] Missing Object Field Expression.
    at modules/utils.dwl line 5:12

Saída JSON:

{
  "muleFile": "wallet.xml",
  "totalScripts": 15,
  "ok": 13,
  "errors": 2,
  "networkErrors": 0,
  "scripts": [
    { "index": 1, "name": "formatName", "xmlLine": 45, "status": "OK" },
    { "index": 3, "name": "transformResponse", "xmlLine": 134, "status": "ERROR",
      "error": { "kind": "CompilationException", "message": "...", "location": {...} } }
  ]
}

Os nomes dos scripts são detectados pelo contexto XML: <ee:set-variable variableName="X"> resulta em X, <ee:set-payload> resulta em set-payload.

Modo agente (--agent)

Output JSON otimizado para consumo por agentes AI (Claude, ChatGPT, etc.):

{
  "status": "error",
  "script": { "name": "script.dwl", "lines": 4 },
  "errors": [{
    "severity": "error",
    "kind": "CompilationException",
    "message": "Unable to resolve reference of: `payload`.",
    "location": { "source": "main", "start": { "line": 4, "column": 1 } },
    "context": [
      { "line": 2, "text": "output json", "error": false },
      { "line": 3, "text": "---", "error": false },
      { "line": 4, "text": "payload", "error": true }
    ],
    "suggestion": "adicione --input payload=arquivo.json"
  }]
}

Formatos de input suportados

JSON, XML, CSV, texto, YAML, NDJSON. O MIME type é detectado automaticamente pela extensão do arquivo.

Imports

Módulos padrão (stdlib): todos funcionam — dw::core::*, dw::util::*, dw::Runtime::*, etc.

dw-check --inline "%dw 2.0
import * from dw::core::Strings
output json
---
{upper: upper('hello')}" --output

Módulos customizados (seus próprios .dwl): resolvidos localmente via flag --resources. O CLI inlineia as funções importadas antes de enviar o script para a API.

Dada a estrutura de projeto:

src/main/resources/
  modules/
    utils.dwl
  meu-script.dwl

Com meu-script.dwl:

%dw 2.0
output json
import formatName, validateEmail from modules::utils
---
formatName(payload.name)

E modules/utils.dwl:

%dw 2.0
import * from dw::core::Strings

fun formatName(name) = trim(upper(name))
fun validateEmail(email) = email contains "@"

Execute:

dw-check meu-script.dwl --resources src/main/resources

Formatos de import suportados:

• Import nomeado: import foo, bar from modules::utils
• Import wildcard: import * from modules::utils
• Imports aninhados: módulos que importam outros módulos são resolvidos recursivamente
• Imports circulares: detectados e reportados como erro fatal

Paths de módulo usam :: como separador (convenção DataWeave), mapeados para paths do sistema de arquivos: modules::utils → modules/utils.dwl.

A flag --resources pode ser usada múltiplas vezes. O primeiro diretório que contiver o arquivo .dwl solicitado vence.

Mapeamento de linhas: quando a API reporta um erro em um módulo importado, o output mostra o caminho do arquivo do módulo e a linha real — não a linha do import no script principal. Veja Rastreamento de erros em imports.

$ em strings

$ dentro de strings DataWeave dispara interpolação: $var (shorthand) ou $(expr). Para $ literal, escape com \$.

| Script | Resultado | |--------|-----------| | "$(name)" | Interpola a variável name | | "$100" | Erro — $ tenta interpolar | | "\$100" | $100 (literal) |

Comportamento correto do DataWeave 2.x. Scripts com $ em CDATA no Mule XML funcionam porque o parser de expressão do Mule processa o $ antes do DataWeave.

Disclaimer

Esta ferramenta é um wrapper não-oficial da API pública do DataWeave Playground. Não é mantida pela MuleSoft/Salesforce.