From ba06133d4814c6fb92ea8ebd95072a68b968d816 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Greg=20Berg=C3=A9?= Date: Sat, 3 Nov 2018 17:00:57 +0100 Subject: [PATCH] docs(readme): document setupTestFrameworkScriptFile --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 003702b8..398877ed 100644 --- a/README.md +++ b/README.md @@ -151,6 +151,25 @@ module.exports = { } ``` +### Specify a `setupTestFrameworkScriptFile` + +Jest Puppeteer use `expect-puppeteer` as `setupTestFrameworkScriptFile`. If you want to use `expect-puppeteer` don't forget to add it in your custom `setupTestFrameworkScriptFile`: + +```js +// setupTestFrameworkScriptFile.js +require('expect-puppeteer') + +// Your custom setup +``` + +```js +// jest.config.js +module.exports = { + // ... + setupTestFrameworkScriptFile: './setupTestFrameworkScriptFile.js', +} +``` + ### Extend `PuppeteerEnvironment` Sometimes you want to use your own environment, to do that you can extend `PuppeteerEnvironment`.