Tools

Command line tools for writing and checking VDR.md files.

These tools are in beta, with general availability coming soon. Expect rough edges and output that changes between releases until then. Everything runs through npx, so there is nothing to install.

Linter Beta

Checks a file against the specification and reports where it departs from it, separating what is invalid from what is merely unwise.

$npx vdrmd:lint path/to/VDR.md

Example output

$ npx vdrmd:lint "1 - Finances/VDR.md" 1 - Finances/VDR.md ok header block Spec and Title present, 9 fields parsed ok references 4 resolved, 0 unresolved ok figures 2 figures, each with a source line and one fenced block warn best practice Figure 1.1 title states no unit or period (R8.6) 1 problem: 0 errors, 1 warning

Example output. Exact wording is not final.

What it checks

R3.1-3.7The header block parses as header fields rather than YAML, carries Spec and Title, and repeats only the fields allowed to repeat.
R6.1-6.5Every @ reference resolves to a file or folder that exists in the room, with exact path comparison.
R7.1-7.4Source lines are well formed and point at source documents rather than at other VDR.md files.
R8.1-8.7Figures carry a unique id, a source line directly beneath the heading, and exactly one fenced block that parses as its declared format.
R3.8The file is not past its Expires date.

More to come

A formatter and a reference resolver are the next candidates. If you are building against the draft and want something specific, say so on the specification before it settles.