https://github.com/tingerrr/typst-test

A test runner for typst projects.
https://github.com/tingerrr/typst-test

regression-testing testing typst

Last synced: 24 days ago
JSON representation

A test runner for typst projects.

• Host: GitHub
• URL: https://github.com/tingerrr/typst-test
• Owner: tingerrr
• License: mit
• Created: 2024-01-01T19:18:51.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-05T15:41:06.000Z (about 1 month ago)
• Last Synced: 2025-01-05T16:30:59.779Z (about 1 month ago)
• Topics: regression-testing, testing, typst
• Language: Rust
• Homepage: https://tingerrr.github.io/typst-test/
• Size: 692 KB
• Stars: 30
• Watchers: 1
• Forks: 3
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# typst test

`typst-test` is a test runner for [Typst] projects. It helps you worry less about regressions and speeds up your development.

## Features

Out of the box `typst-test` supports the following features:

- locate the project it is invoked in

- collect and manage test scripts and references

- compile and run tests

- compare test output to references

- provide extra scripting functionality

- running custom scripts for test automation

`typst-test` does not currently include a "watch" command to automatically run anytime a file changes.

However, the book [includes a suggested workaround for this](https://tingerrr.github.io/typst-test/guides/watching.html).

## Stability

`typst-test` currently makes no stability guarantees, it is considered pre-0.1.0, see the [Milestones] for its progress towards a first release.

However, all PRs and pushes to main are tested in CI.

A reasonably "stable" version of `typst-test` is available at the `backport` branch, which will receive fixes until 0.1.0.

This version is already used in the CI of various Typst packages, such as cetz, codly, valkyrie, hydra or subpar.

## Documentation

To see how to get started with `typst-test`, check out the [Book].

It provides a few chapters aimed to get you started with `typst-test`.

[![An asciicast showing typst-test running the full cetz test suite.][demo-thumb]][demo]

## Contribution

See [CONTRIBUTING.md][contrib] if you want to contribute to `typst-test`.

[contrib]: CONTRIBUTING.md

[Typst]: https://typst.app

[Book]: https://tingerrr.github.io/typst-test/index.html

[Milestones]: https://github.com/tingerrr/typst-test/milestones

[demo-thumb]: https://asciinema.org/a/rW9HGUBbtBnmkSddgbKb7hRlI.svg

[demo]: https://asciinema.org/a/rW9HGUBbtBnmkSddgbKb7hRlI