Skip to content

Commit bbcfe52

Browse files
authored
docs: Update README.md links for util packages (#122)
1 parent b1d56ee commit bbcfe52

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -70,19 +70,19 @@ describe('What is my browser', () => {
7070

7171
## Configuration
7272

73-
You can specify a `jest-playwright.config.js` at the root of the project or define a custom path using `JEST_PLAYWRIGHT_CONFIG` environment variable. It should export a config object.
73+
You can specify a `jest-playwright.config.js` at the root of the project or define a custom path using the `JEST_PLAYWRIGHT_CONFIG` environment variable. It should export a config object.
7474

7575
- `launchBrowserApp` <[object]> [All Playwright launch options](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsertypelaunchoptions) can be specified in config. Since it is JavaScript, you can use all stuff you need, including environment.
7676
- `connectBrowserApp` <[object]> [All Playwright connect options](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsertypeconnectoptions) can be specified in config.
7777
- `context` <[object]> [All Playwright context options](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsernewcontextoptions) can be specified in config.
78-
- `browsers` <[string[]]>. Define a [browsers](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-browsertype) to run tests into.
78+
- `browsers` <[string[]]>. Define [browsers](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-browsertype) to run tests in.
7979
- `chromium` Each test runs Chromium (default).
8080
- `firefox` Each test runs Firefox.
8181
- `webkit` Each test runs Webkit.
82-
- `devices` <[string[]]>. Define a [devices](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsertypedevices) to run tests into. Actual list of devices can be found [here](https://github.com/Microsoft/playwright/blob/master/src/deviceDescriptors.ts)
82+
- `devices` <[string[]]>. Define a [devices](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsertypedevices) to run tests in. Actual list of devices can be found [here](https://github.com/Microsoft/playwright/blob/master/src/deviceDescriptors.ts).
8383
- `exitOnPageError` <[boolean]> Exits process on any page error. Defaults to `true`.
84-
- `server` <[object]> [All `jest-dev-server` options](https://github.com/smooth-code/jest-puppeteer/tree/master/packages/jest-dev-server#options)
85-
- `selectors` <[array]>. Define [selector](https://github.com/microsoft/playwright/blob/v0.11.1/docs/api.md#class-selectors). Each selector must be an object with name and script properties.
84+
- `server` <[object]> [All `jest-dev-server` options](https://github.com/smooth-code/jest-puppeteer/tree/master/packages/jest-dev-server#options).
85+
- `selectors` <[array]>. Define [selectors](https://github.com/microsoft/playwright/blob/v0.11.1/docs/api.md#class-selectors). Each selector must be an object with name and script properties.
8686

8787
Usage with [query-selector-shadow-dom](https://github.com/Georgegriff/query-selector-shadow-dom):
8888

@@ -104,7 +104,7 @@ module.exports = {
104104

105105
**Note**:
106106

107-
- You can also specify browser with `BROWSER` environment variable. You should do it only if you are using the whole playwright package.
107+
- You can also specify browser with the `BROWSER` environment variable. You should do it only if you are using the whole playwright package.
108108
- You can specify device with `DEVICE` environment variable.
109109

110110
## Put in debug mode
@@ -135,17 +135,17 @@ Other options are documented in [jest-dev-server](https://github.com/smooth-code
135135

136136
## expect-playwright
137137

138-
There is a utility package [expect-playwright](https://github.com/mxschmitt/expect-playwright) which simplifies the expect statements in combination with Playwright to make e.g. shorter text comparisons.
138+
There is a utility package [expect-playwright](https://github.com/playwright-community/expect-playwright) which simplifies the expect statements in combination with Playwright to make e.g. shorter text comparisons.
139139

140140
## ESLint globals / `'page' is not defined`
141141

142-
There is [eslint-plugin-jest-playwright](https://github.com/mxschmitt/eslint-plugin-jest-playwright) available which includes the globals for using jest-playwright.
142+
There is an ESLint plugin available [eslint-plugin-jest-playwright](https://github.com/playwright-community/eslint-plugin-jest-playwright) available which includes the globals for using jest-playwright.
143143

144144
## Unstable and experimental API
145145

146146
You can run tests for multiple browsers and devices:
147147

148-
- You must have installed **playwright** package
148+
- You must have installed the **playwright** package
149149
- You must define browsers to test with your `jest-playwright.config.js`:
150150

151151
```javascript
@@ -167,7 +167,7 @@ If there is no defined browsers in config it will run tests for chromium browser
167167

168168
## Usage with [jest-circus](https://github.com/facebook/jest/tree/master/packages/jest-circus)
169169

170-
You can use **jest-playwright** with **jest-circus** runner for taking screenshots during test failures for example:
170+
You can use **jest-playwright** with the **jest-circus** runner for taking screenshots during test failures for example:
171171

172172
**jest.config.json**
173173

@@ -278,7 +278,7 @@ If for your individual tests a new entire browser instance spins up each time an
278278

279279
## Inspiration
280280

281-
Thanks to [Smooth Code](https://github.com/smooth-code) for great [jest-puppeteer](https://github.com/smooth-code/jest-puppeteer).
281+
Thanks to [Smooth Code](https://github.com/smooth-code) for the great [jest-puppeteer](https://github.com/smooth-code/jest-puppeteer).
282282

283283
## License
284284

0 commit comments

Comments
 (0)