Schema and code

The schema file

A template can have a JSON Schema next to it, with the same name:

rechnung.md
rechnung.schema.json

When the file exists, every brevier render checks two things before it prints:

1. Each {{ }} tag in the template names a field that the schema has.
2. The data matches the schema: required fields, types, lists.

If one check fails, nothing is printed. brevier lists every problem, with the template line for the first check.

When there is no schema file, brevier skips both checks.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "rechnung": {
      "type": "object",
      "properties": {
        "nummer": { "type": "string", "title": "Rechnungsnummer" },
        "summe": { "type": "number", "format": "decimal" }
      },
      "required": ["nummer", "summe"]
    }
  },
  "required": ["rechnung"]
}

From your classes

You do not have to write the schema by hand. from-code reads your classes and writes four files:

brevier from-code com.ww.Rechnung com.ww.Kunde --format md

The files take the name of the first class. --format html (the default) writes an HTML template instead of Markdown.

from-code never overwrites a file. If one of the four files exists, it writes none of them. Add --force to replace them all.