Herramientas

CLI

El paquete incluye el ejecutable donly. No hace falta instalarlo: se puede correr con npx o bunx. Tiene dos comandos: validar un documento con reglas y mostrar cómo se interpreta.

$ npx donly <comando> [opciones]
$ bunx donly <comando> [opciones]

Commands:
  lint --rules <rules.json|rules.donly> [--output|-o default|json] <file.donly>
  inspect [--strategy|-s nested|tuple|raw] <file.donly>

Los ejemplos de esta página usan este app.donly:

name "my-app"
server {
  port 8080
  route GET /home {
    respond 200
  }
}

donly lint

donly lint --rules <reglas> <archivo> valida el archivo con lintSchema. El archivo de reglas puede ser .json o, con extensión .donly o .don, estar escrito en sintaxis DON (ver Lint). Estas reglas, en rules.donly, piden que el puerto sea un string:

/server {
  /port {
    [1] { type "string" }
  }
}
$ donly lint --rules rules.donly app.donly
app.donly
  3:8  error  argument at position 1 must be of type string

1 error 0 warnings 0 info
$ donly lint --rules rules.donly -o json app.donly
{
  "filePath": "app.donly",
  "issues": [
    {
      "line": 3,
      "column": 8,
      "severity": "error",
      "message": "argument at position 1 must be of type string"
    }
  ],
  "summary": { "errors": 1, "warnings": 0, "info": 0 }
}

donly inspect

donly inspect <archivo> parsea el archivo y lo imprime como JSON. La opción --strategy / -s elige la forma:

$ donly inspect app.donly
{
  "name": "my-app",
  "server": {
    "port": 8080,
    "route": { "GET": { "/home": { "respond": 200 } } }
  }
}
$ donly inspect -s tuple app.donly
{
  "name": "my-app",
  "server": {
    "port": 8080,
    "route": ["GET", "/home", { "respond": 200 }]
  }
}
$ donly inspect -s raw app.donly
[
  { "name": "name", "args": ["my-app"], "children": [] },
  { "name": "server", "args": [], "children": [
    { "name": "port", "args": [8080], "children": [] },
    ...
  ] }
]

Códigos de salida

# falla el job si hay errores de lint
npx donly lint --rules rules.donly app.donly || exit 1