Skip to content

Commit

Permalink
Add local Playwright testing instructions to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: James Maa <[email protected]>
  • Loading branch information
jamesmaa authored Oct 27, 2024
1 parent 086e043 commit 97136ee
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Unit tests, integration tests, and various other tests can be executed by runnin
Other individual tests can be looked up in the [package.json](package.json) file, and the source for specific tests
can be found in the [test](test) directory

### Playwright

To run [playwright](https://playwright.dev/) tests locally, you can run `npx playwright install` to install the headless browsers, then 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)). 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.

## Building

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

0 comments on commit 97136ee

Please sign in to comment.