summaryrefslogtreecommitdiff
path: root/tools/test-helper/README.md
diff options
context:
space:
mode:
authorLaurenz <laurmaedje@gmail.com>2021-02-20 23:41:42 +0100
committerLaurenz <laurmaedje@gmail.com>2021-02-20 23:41:42 +0100
commit4ff59baf5e8268d607643aeec23d113cd40324c7 (patch)
tree47cd10bc9c48815d65cdf5a84fdf246f39b9e091 /tools/test-helper/README.md
parent05727bfc3a9cfd45a8e2028dfd0806f7a8f88015 (diff)
VS Code extension for easier testing 🛠
This extension enables you to - quickly open the actual and reference output for a test case to the side - re-run the test with the click of a button - approve the test output (moves output to reference folder and optimizes with oxipng)
Diffstat (limited to 'tools/test-helper/README.md')
-rw-r--r--tools/test-helper/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/tools/test-helper/README.md b/tools/test-helper/README.md
new file mode 100644
index 00000000..8494edeb
--- /dev/null
+++ b/tools/test-helper/README.md
@@ -0,0 +1,9 @@
+# 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 test output: Opens the output and reference images of a test to the side.
+- Refresh test output: Re-runs the test and reloads the preview.
+- Approve test output: Copies the output into the reference folder and optimizes it with `oxipng`.