summaryrefslogtreecommitdiff
path: root/tools/test-helper/README.md
blob: f6ee79e02e3b5cec3c3e985c64dc5b6207005c59 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Test helper

This is a small VS Code extension that helps with managing Typst's test suite.
When installed, three new buttons appear in the menubar for all `.typ` files in
the `tests` folder.

- Open: Opens the output and reference images of a test to the side.
- Refresh: Refreshes the preview.
- Rerun: Re-runs the test.
- Approve: Copies the output into the reference folder and optimizes
  it with `oxipng`.

# License
The images used for the commands are slightly modified versions of emojis from
the [Twemoji] emoji set by Twitter, Inc. and other contributors, which is
licensed under [CC-BY 4.0][cc40].

[Twemoji]: https://twemoji.twitter.com/
[cc40]: https://creativecommons.org/licenses/by/4.0/