Skip to content

Commit f462278

Browse files
authored
Add local Playwright testing instructions to CONTRIBUTING.md (#1537)
* Add local Playwright testing instructions to CONTRIBUTING.md Signed-off-by: James Maa <[email protected]> * Update CONTRIBUTING.md Signed-off-by: James Maa <[email protected]> --------- Signed-off-by: James Maa <[email protected]>
1 parent e79b3c7 commit f462278

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

+8
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ Unit tests, integration tests, and various other tests can be executed by runnin
3030
Other individual tests can be looked up in the [package.json](package.json) file, and the source for specific tests
3131
can be found in the [test](test) directory
3232

33+
### Playwright
34+
35+
Steps to run [playwright](https://playwright.dev/) tests locally:
36+
37+
1. Run `npx playwright install` to install the headless browsers
38+
2. Copy the dictionary test data located in the `dictionaries` branch to a directory named `dictionaries` via `git clone --branch dictionaries [email protected]:yomidevs/yomitan.git dictionaries` ([source](https://github.com/yomidevs/yomitan/blob/086e043856ad54cf13cb65f9ba4c63afe8a22cc3/.github/workflows/playwright.yml#L52-L57)).
39+
3. Now you can run `npx playwright test`. The first run might produce some benign errors complaining about `Error: A snapshot doesn't exist at ...writing actual.`, but subsequent runs should succeed.
40+
3341
## Building
3442

3543
By default, the development repository is configured for Chrome, and the [ext](ext) directory can be directly

0 commit comments

Comments
 (0)