tingerrr / typst-test

A visual regression test runner for typst packages.

typst test

typst-test is a program to compile, compare and update references of tests scripts for typst. It is currently work in progress and is aimed at providing automated visual regression testing for typst packages.

Features

• auto discovery of current project using typst.toml
• overriding of typst binary to test typst PRs or multiple versions
• automatic compilation and optional visual comparison of test output for all tests
• diff image generation for visual aid
• project setup with git support
• updating and optimizing of reference images

Stability

This is work in progress, as such no stability guarantees are made, any commit may change the behavior of various commands. Such changes will be documented in the migration log.

The tag ci-semi-stable is available to use typst-test in CI, see tests.yml for an example workflow which will run typst-test for PRs and pushes to your repo. This tag will only be bumped when critical bugs related to exisiting functionality are fixed. It will be retired once typst-test reaches 0.1.0.

Tutorial

You can install typst-test by running:

cargo install typst-test --git https://github.com/tingerrr/typst-test

Assuming typst-test is in your path and you're in a package project, this is how you use it on a new project:

typst-test init
typst-test run