docs(readme): syntax-highlight nested snippets in debugging section (#5799)

This commit is contained in:
Anderson Aguiar 2020-05-05 15:45:21 +10:00 committed by GitHub
parent 53d6fabf80
commit 209e25c0e1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -198,22 +198,28 @@ Puppeteer creates its own browser user profile which it **cleans up on every run
displaying. Instead of launching in headless mode, launch a full version of displaying. Instead of launching in headless mode, launch a full version of
the browser using `headless: false`: the browser using `headless: false`:
const browser = await puppeteer.launch({headless: false}); ```js
const browser = await puppeteer.launch({headless: false});
```
2. Slow it down - the `slowMo` option slows down Puppeteer operations by the 2. Slow it down - the `slowMo` option slows down Puppeteer operations by the
specified amount of milliseconds. It's another way to help see what's going on. specified amount of milliseconds. It's another way to help see what's going on.
const browser = await puppeteer.launch({ ```js
headless: false, const browser = await puppeteer.launch({
slowMo: 250 // slow down by 250ms headless: false,
}); slowMo: 250 // slow down by 250ms
});
```
3. Capture console output - You can listen for the `console` event. 3. Capture console output - You can listen for the `console` event.
This is also handy when debugging code in `page.evaluate()`: This is also handy when debugging code in `page.evaluate()`:
page.on('console', msg => console.log('PAGE LOG:', msg.text())); ```js
page.on('console', msg => console.log('PAGE LOG:', msg.text()));
await page.evaluate(() => console.log(`url is ${location.href}`)); await page.evaluate(() => console.log(`url is ${location.href}`));
```
4. Use debugger in application code browser 4. Use debugger in application code browser
@ -223,7 +229,9 @@ Puppeteer creates its own browser user profile which it **cleans up on every run
- Use `{devtools: true}` when launching Puppeteer: - Use `{devtools: true}` when launching Puppeteer:
`const browser = await puppeteer.launch({devtools: true});` ```js
const browser = await puppeteer.launch({devtools: true});
```
- Change default test timeout: - Change default test timeout:
@ -235,7 +243,9 @@ Puppeteer creates its own browser user profile which it **cleans up on every run
- Add an evaluate statement with `debugger` inside / add `debugger` to an existing evaluate statement: - Add an evaluate statement with `debugger` inside / add `debugger` to an existing evaluate statement:
`await page.evaluate(() => {debugger;});` ```js
await page.evaluate(() => {debugger;});
```
The test will now stop executing in the above evaluate statement, and chromium will stop in debug mode. The test will now stop executing in the above evaluate statement, and chromium will stop in debug mode.
@ -248,10 +258,12 @@ Puppeteer creates its own browser user profile which it **cleans up on every run
you want to try something out, you have to add it to your test file. you want to try something out, you have to add it to your test file.
- Add `debugger;` to your test, eg: - Add `debugger;` to your test, eg:
```
```js
debugger; debugger;
await page.click('a[target=_blank]'); await page.click('a[target=_blank]');
``` ```
- Set `headless` to `false` - Set `headless` to `false`
- Run `node --inspect-brk`, eg `node --inspect-brk node_modules/.bin/jest tests` - Run `node --inspect-brk`, eg `node --inspect-brk node_modules/.bin/jest tests`
- In Chrome open `chrome://inspect/#devices` and click `inspect` - In Chrome open `chrome://inspect/#devices` and click `inspect`