Introduction

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

Bird's-Eye View

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

A Closer Look

This book contains a few sections aimed at answering the most common questions right out the gate.

  • Installation outlines various ways to install typst-test.
  • Usage goes over some basic commands to get started with typst-test.

After the quick start, a few guides delve deeper into some advanced topics.

  • Using Test Sets delves into the test set language and how it can be used to isolate tests and speed up your TDD workflow.
  • Watching for Changes automatically run tests while developing your package.
  • Setting Up CI shows how to set up typst-test to continuously test all changes to your package.

The later sections of the book are a technical reference to typst-test and its various features or concepts.

  • Tests outlines which types of tests typst-test supports, how they can be customized and which features are offered within the test scripts.
  • Test Set Language defines the test set language and its built in test sets.