Skip to content

oselvar/var

Repository files navigation

Vár

Executable Markdown documentation for humans and agents — turn your docs into tests.

Vár lets you write plain-Markdown examples that read like prose, then runs them as tests: if the code stops doing what the documentation says, the test fails. It closes the gap where code, tests, and docs quietly drift apart — so a programmer or coding agent that breaks the oath gets caught, every time.

📖 Full documentation, tutorials, and a live browser playground: var.oselvar.com

Vár is a multi-language project with the same behaviour across five ports — TypeScript, Java, Kotlin, Python, and Ruby — verified by a shared, language-neutral conformance corpus.

Coverage

Line and branch coverage per port, distilled from each tool's native report into coverage.json and refreshed by make coverage.

Port Line coverage Branch coverage
TypeScript 82.5% 71.4%
Java / Kotlin 86.2% 76.8%
Python 65.7% n/a
Ruby 90.9% n/a

Development

This is a multi-language monorepo. Build and test every port from the repo root:

make            # build + test all ports (same gates as CI)
make typescript # one port at a time: typescript / python / java / ruby
make coverage   # test with coverage in every port + regenerate coverage.json

See CONTRIBUTING.md for the full workflow and CLAUDE.md for the repository layout and architectural principles.

License

MIT