github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Spelling and Markdown Consistency (#1998)

Browse Source 
- Adding missing language tags to markdown code blocks.
- Fixed various spelling mistakes my IDE complained to me about.
This commit is contained in:
Drew Diamantoukos 2018-02-08 22:59:46 -05:00 committed by Andrey Lushnikov
parent 070243e4b6
commit b275e66594
12 changed files with 92 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
CONTRIBUTING.md
View File

@ -18,13 +18,16 @@ again.
## Getting setup ## Getting setup
1. Clone this repository 1. Clone this repository
```bash ```bash
git clone https://github.com/GoogleChrome/puppeteer git clone https://github.com/GoogleChrome/puppeteer
cd puppeteer cd puppeteer
``` ```
2. Install dependencies
2. Install dependencies
```bash ```bash
yarn # or 'npm install' npm install
``` ```
## Code reviews ## Code reviews
@ -41,7 +44,8 @@ information on using pull requests.
- comments should be generally avoided. If the code would not be understood without comments, consider re-writing the code to make it self-explanatory - comments should be generally avoided. If the code would not be understood without comments, consider re-writing the code to make it self-explanatory
To run code linter, use: To run code linter, use:
```
```bash
npm run lint npm run lint
``` ```
@ -73,11 +77,11 @@ footer
- `test` - changes to puppeteer tests infrastructure - `test` - changes to puppeteer tests infrastructure
- `style` - puppeteer code style: spaces/alignment/wrapping etc - `style` - puppeteer code style: spaces/alignment/wrapping etc
- `chore` - build-related work, e.g. doclint changes / travis / appveyor - `chore` - build-related work, e.g. doclint changes / travis / appveyor
1. *namespace* is put in parenthesis after label and is optional 2. *namespace* is put in parenthesis after label and is optional
2. *title* is a brief summary of changes 3. *title* is a brief summary of changes
3. *description* is **optional**, new-line separated from title and is in present tense 4. *description* is **optional**, new-line separated from title and is in present tense
4. *footer* is **optional**, new-line separated from *description* and contains "fixes" / "references" attribution to github issues 5. *footer* is **optional**, new-line separated from *description* and contains "fixes" / "references" attribution to github issues
5. *footer* should also include "BREAKING CHANGE" if current API clients will break due to this change. It should explain what changed and how to get the old behavior. 6. *footer* should also include "BREAKING CHANGE" if current API clients will break due to this change. It should explain what changed and how to get the old behavior.
Example: Example:
@ -93,13 +97,13 @@ To deliver to a different location, use "deliver" option:
`page.pizza({deliver: 'work'})`. `page.pizza({deliver: 'work'})`.
``` ```
## Writing Documentation ## Writing Documentation
All public API should have a descriptive entry in the [docs/api.md](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md). There's a [documentation linter](https://github.com/GoogleChrome/puppeteer/tree/master/utils/doclint) which makes sure documentation is aligned with the codebase. All public API should have a descriptive entry in the [docs/api.md](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md). There's a [documentation linter](https://github.com/GoogleChrome/puppeteer/tree/master/utils/doclint) which makes sure documentation is aligned with the codebase.
To run documentation linter, use To run documentation linter, use
```
```bash
npm run doc npm run doc
``` ```
@ -110,7 +114,7 @@ For all dependencies (both installation and development):
- if adding a dependency, it should be well-maintained and trustworthy - if adding a dependency, it should be well-maintained and trustworthy
A barrier for introducing new installation dependencies is especially high: A barrier for introducing new installation dependencies is especially high:
- **do not add** installation dependency unless it's critical to project success - **Do not add** installation dependency unless it's critical to project success
## Writing Tests ## Writing Tests
@ -124,14 +128,25 @@ and are written with a [TestRunner](https://github.com/GoogleChrome/puppeteer/tr
Despite being named 'unit', these are integration tests, making sure public API methods and events work as expected. Despite being named 'unit', these are integration tests, making sure public API methods and events work as expected.
- To run all tests: - To run all tests:
```
```bash
npm run unit npm run unit
``` ```
- To run tests in parallel, use `-j` flag:
- To filter tests by name:
```bash
npm run unit --filter=waitFor
``` ```
- To run tests in parallel, use `-j` flag:
```bash
npm run unit -- -j 4 npm run unit -- -j 4
``` ```
- To run a specific test, substitute the `it` with `fit` (mnemonic rule: '*focus it*'): - To run a specific test, substitute the `it` with `fit` (mnemonic rule: '*focus it*'):
```js ```js
... ...
// Using "fit" to run specific test // Using "fit" to run specific test
@ -140,7 +155,9 @@ npm run unit -- -j 4
expect(response.ok).toBe(true); expect(response.ok).toBe(true);
})) }))
``` ```
- To disable a specific test, substitute the `it` with `xit` (mnemonic rule: '*cross it*'): - To disable a specific test, substitute the `it` with `xit` (mnemonic rule: '*cross it*'):
```js ```js
... ...
// Using "xit" to skip specific test // Using "xit" to skip specific test
@ -149,20 +166,28 @@ npm run unit -- -j 4
expect(response.ok).toBe(true); expect(response.ok).toBe(true);
})) }))
``` ```
- To run tests in non-headless mode: - To run tests in non-headless mode:
```
```bash
HEADLESS=false npm run unit HEADLESS=false npm run unit
``` ```
- To run tests with custom Chromium executable: - To run tests with custom Chromium executable:
```
```bash
CHROME=<path-to-executable> npm run unit CHROME=<path-to-executable> npm run unit
``` ```
- To run tests in slow-mode: - To run tests in slow-mode:
```
```bash
HEADLESS=false SLOW_MO=500 npm run unit HEADLESS=false SLOW_MO=500 npm run unit
``` ```
- To debug a test, "focus" a test first and then run: - To debug a test, "focus" a test first and then run:
```
```bash
node --inspect-brk test/test.js node --inspect-brk test/test.js
``` ```
@ -172,10 +197,10 @@ Every public API method or event should be called at least once in tests. To ens
Run coverage: Run coverage:
``` ```bash
npm run coverage npm run coverage
``` ```
## Debugging Puppeteer ## Debugging Puppeteer
See [Debugging Tips](README.md#debugging-tips) in the readme
See [Debugging Tips](README.md#debugging-tips) in the readme

16
README.md
View File

@ -31,7 +31,8 @@ Give it a spin: https://try-puppeteer.appspot.com/
### Installation ### Installation
To use Puppeteer in your project, run: To use Puppeteer in your project, run:
```
```bash
npm i --save puppeteer npm i --save puppeteer
# or "yarn add puppeteer" # or "yarn add puppeteer"
``` ```
@ -131,8 +132,7 @@ const browser = await puppeteer.launch({executablePath: '/path/to/Chrome'});
See [`Puppeteer.launch()`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions) for more information. See [`Puppeteer.launch()`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions) for more information.
See [`this article`](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description See [`this article`](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [`This article`](https://chromium.googlesource.com/chromium/src/+/lkcr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users.
of the differences between Chromium and Chrome. [`This article`](https://chromium.googlesource.com/chromium/src/+/lkcr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users.
**3. Creates a fresh user profile** **3. Creates a fresh user profile**
@ -154,7 +154,7 @@ Explore the [API documentation](docs/api.md) and [examples](https://github.com/G
const browser = await puppeteer.launch({headless: false}); const browser = await puppeteer.launch({headless: false});
1. 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({ const browser = await puppeteer.launch({
@ -162,15 +162,16 @@ Explore the [API documentation](docs/api.md) and [examples](https://github.com/G
slowMo: 250 // slow down by 250ms slowMo: 250 // slow down by 250ms
}); });
1. 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())); 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}`));
await page.evaluate(() => console.log(`url is ${location.href}`));
1. Enable verbose logging - All public API calls and internal protocol traffic 4. Enable verbose logging - All public API calls and internal protocol traffic
will be logged via the [`debug`](https://github.com/visionmedia/debug) module under the `puppeteer` namespace. will be logged via the [`debug`](https://github.com/visionmedia/debug) module under the `puppeteer` namespace.
# Basic verbose logging # Basic verbose logging
@ -218,8 +219,7 @@ See [Contributing](https://github.com/GoogleChrome/puppeteer/blob/master/CONTRIB
The goals of the project are simple: The goals of the project are simple:
- Provide a slim, canonical library that highlights the capabilities of the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/). - Provide a slim, canonical library that highlights the capabilities of the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
- Provide a reference implementation for similar testing libraries. Eventually, these - Provide a reference implementation for similar testing libraries. Eventually, these other frameworks could adopt Puppeteer as their foundational layer.
other frameworks could adopt Puppeteer as their foundational layer.
- Grow the adoption of headless/automated browser testing. - Grow the adoption of headless/automated browser testing.
- Help dogfood new DevTools Protocol features...and catch bugs! - Help dogfood new DevTools Protocol features...and catch bugs!
- Learn more about the pain points of automated browser testing and help fill those gaps. - Learn more about the pain points of automated browser testing and help fill those gaps.

50
docs/api.md
View File

@ -249,7 +249,6 @@ The Puppeteer API is hierarchical and mirrors the browser structure. On the foll
(Diagram source: [link](https://docs.google.com/drawings/d/1Q_AM6KYs9kbyLZF-Lpp5mtpAWth73Cq8IKCsWYgi8MM/edit?usp=sharing)) (Diagram source: [link](https://docs.google.com/drawings/d/1Q_AM6KYs9kbyLZF-Lpp5mtpAWth73Cq8IKCsWYgi8MM/edit?usp=sharing))
### Environment Variables ### Environment Variables
Puppeteer looks for certain [environment variables](https://en.wikipedia.org/wiki/Environment_variable) to aid its operations. These variables can either be set in the environment or in the [npm config](https://docs.npmjs.com/cli/config). Puppeteer looks for certain [environment variables](https://en.wikipedia.org/wiki/Environment_variable) to aid its operations. These variables can either be set in the environment or in the [npm config](https://docs.npmjs.com/cli/config).
@ -315,14 +314,13 @@ This methods attaches Puppeteer to an existing Chromium instance.
The method launches a browser instance with given arguments. The browser will be closed when the parent node.js process is closed. The method launches a browser instance with given arguments. The browser will be closed when the parent node.js process is closed.
> **NOTE** Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chromium it is bundled with. There is no > **NOTE** Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath` option with extreme caution.
guarantee it will work with any other version. Use `executablePath` option with extreme caution. >
If Google Chrome (rather than Chromium) is preferred, a [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested. > If Google Chrome (rather than Chromium) is preferred, a [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested.
> >
> In [puppeteer.launch([options])](#puppeteerlaunchoptions) above, any mention of Chromium also applies to Chrome. > In [puppeteer.launch([options])](#puppeteerlaunchoptions) above, any mention of Chromium also applies to Chrome.
> >
> See [`this article`](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description > See [`this article`](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [`This article`](https://chromium.googlesource.com/chromium/src/+/lkcr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users.
of the differences between Chromium and Chrome. [`This article`](https://chromium.googlesource.com/chromium/src/+/lkcr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users.
### class: BrowserFetcher ### class: BrowserFetcher
@ -600,7 +598,6 @@ The method runs `document.querySelectorAll` within the page. If no elements matc
Shortcut for [page.mainFrame().$$(selector)](#frameselector-1). Shortcut for [page.mainFrame().$$(selector)](#frameselector-1).
#### page.$$eval(selector, pageFunction[, ...args]) #### page.$$eval(selector, pageFunction[, ...args])
- `selector` <[string]> A [selector] to query frame for - `selector` <[string]> A [selector] to query frame for
- `pageFunction` <[function]> Function to be evaluated in browser context - `pageFunction` <[function]> Function to be evaluated in browser context
@ -775,8 +772,8 @@ puppeteer.launch().then(async browser => {
List of all available devices is available in the source code: [DeviceDescriptors.js](https://github.com/GoogleChrome/puppeteer/blob/master/DeviceDescriptors.js). List of all available devices is available in the source code: [DeviceDescriptors.js](https://github.com/GoogleChrome/puppeteer/blob/master/DeviceDescriptors.js).
#### page.emulateMedia(mediaType) #### page.emulateMedia(mediaType)
- `mediaType` <?[string]> Changes the CSS media type of the page. The only allowed values are `'screen'`, `'print'` and `null`. Passing `null` disables media emulation. - `mediaType` <?[string]> Changes the CSS media type of the page. The only allowed values are `'screen'`, `'print'` and `null`. Passing `null` disables media emulation.
- returns: <[Promise]> - returns: <[Promise]>
#### page.evaluate(pageFunction, ...args) #### page.evaluate(pageFunction, ...args)
- `pageFunction` <[function]|[string]> Function to be evaluated in the page context - `pageFunction` <[function]|[string]> Function to be evaluated in the page context
@ -840,7 +837,6 @@ await resultHandle.dispose();
Shortcut for [page.mainFrame().executionContext().evaluateHandle(pageFunction, ...args)](#executioncontextevaluatehandlepagefunction-args). Shortcut for [page.mainFrame().executionContext().evaluateHandle(pageFunction, ...args)](#executioncontextevaluatehandlepagefunction-args).
#### page.evaluateOnNewDocument(pageFunction, ...args) #### page.evaluateOnNewDocument(pageFunction, ...args)
- `pageFunction` <[function]|[string]> Function to be evaluated in browser context - `pageFunction` <[function]|[string]> Function to be evaluated in browser context
- `...args` <...[Serializable]> Arguments to pass to `pageFunction` - `...args` <...[Serializable]> Arguments to pass to `pageFunction`
@ -1124,16 +1120,16 @@ Shortcut for [page.mainFrame().executionContext().queryObjects(prototypeHandle)]
#### page.screenshot([options]) #### page.screenshot([options])
- `options` <[Object]> Options object which might have the following properties: - `options` <[Object]> Options object which might have the following properties:
- `path` <[string]> The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). If no path is provided, the image won't be saved to the disk. - `path` <[string]> The file path to save the image to. The screenshot type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to [current working directory](https://nodejs.org/api/process.html#process_process_cwd). If no path is provided, the image won't be saved to the disk.
- `type` <[string]> Specify screenshot type, can be either `jpeg` or `png`. Defaults to 'png'. - `type` <[string]> Specify screenshot type, can be either `jpeg` or `png`. Defaults to 'png'.
- `quality` <[number]> The quality of the image, between 0-100. Not applicable to `png` images. - `quality` <[number]> The quality of the image, between 0-100. Not applicable to `png` images.
- `fullPage` <[boolean]> When true, takes a screenshot of the full scrollable page. Defaults to `false`. - `fullPage` <[boolean]> When true, takes a screenshot of the full scrollable page. Defaults to `false`.
- `clip` <[Object]> An object which specifies clipping region of the page. Should have the following fields: - `clip` <[Object]> An object which specifies clipping region of the page. Should have the following fields:
- `x` <[number]> x-coordinate of top-left corner of clip area - `x` <[number]> x-coordinate of top-left corner of clip area
- `y` <[number]> y-coordinate of top-left corner of clip area - `y` <[number]> y-coordinate of top-left corner of clip area
- `width` <[number]> width of clipping area - `width` <[number]> width of clipping area
- `height` <[number]> height of clipping area - `height` <[number]> height of clipping area
- `omitBackground` <[boolean]> Hides default white background and allows capturing screenshots with transparency. Defaults to `false`. - `omitBackground` <[boolean]> Hides default white background and allows capturing screenshots with transparency. Defaults to `false`.
- returns: <[Promise]<[Buffer]>> Promise which resolves to buffer with captured screenshot - returns: <[Promise]<[Buffer]>> Promise which resolves to buffer with captured screenshot
#### page.select(selector, ...values) #### page.select(selector, ...values)
@ -1409,7 +1405,6 @@ puppeteer.launch().then(async browser => {
``` ```
Shortcut for [page.mainFrame().waitForXPath(xpath[, options])](#framewaitforxpathxpath-options). Shortcut for [page.mainFrame().waitForXPath(xpath[, options])](#framewaitforxpathxpath-options).
### class: Keyboard ### class: Keyboard
Keyboard provides an api for managing a virtual keyboard. The high level api is [`keyboard.type`](#keyboardtypetext-options), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page. Keyboard provides an api for managing a virtual keyboard. The high level api is [`keyboard.type`](#keyboardtypetext-options), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page.
@ -1897,7 +1892,6 @@ This method behaves differently with respect to the type of the first parameter:
- if `selectorOrFunctionOrTimeout` is a `number`, then the first argument is treated as a timeout in milliseconds and the method returns a promise which resolves after the timeout - if `selectorOrFunctionOrTimeout` is a `number`, then the first argument is treated as a timeout in milliseconds and the method returns a promise which resolves after the timeout
- otherwise, an exception is thrown - otherwise, an exception is thrown
#### frame.waitForFunction(pageFunction[, options[, ...args]]) #### frame.waitForFunction(pageFunction[, options[, ...args]])
- `pageFunction` <[function]|[string]> Function to be evaluated in browser context - `pageFunction` <[function]|[string]> Function to be evaluated in browser context
- `options` <[Object]> Optional waiting parameters - `options` <[Object]> Optional waiting parameters
@ -2160,10 +2154,10 @@ The method evaluates the XPath expression relative to the elementHandle. If ther
#### elementHandle.boundingBox() #### elementHandle.boundingBox()
- returns: <[Promise]<?[Object]>> - returns: <[Promise]<?[Object]>>
- x <[number]> the x coordinate of the element in pixels. - x <[number]> the x coordinate of the element in pixels.
- y <[number]> the y coordinate of the element in pixels. - y <[number]> the y coordinate of the element in pixels.
- width <[number]> the width of the element in pixels. - width <[number]> the width of the element in pixels.
- height <[number]> the height of the element in pixels. - height <[number]> the height of the element in pixels.
This method returns the bounding box of the element (relative to the main frame), or `null` if the element is not visible. This method returns the bounding box of the element (relative to the main frame), or `null` if the element is not visible.
@ -2459,7 +2453,6 @@ Identifies what kind of target this is. Can be `"page"`, `"service_worker"`, or
#### target.url() #### target.url()
- returns: <[string]> - returns: <[string]>
### class: CDPSession ### class: CDPSession
* extends: [`EventEmitter`](https://nodejs.org/api/events.html#events_class_eventemitter) * extends: [`EventEmitter`](https://nodejs.org/api/events.html#events_class_eventemitter)
@ -2492,7 +2485,6 @@ to send messages.
- `params` <[Object]> Optional method parameters - `params` <[Object]> Optional method parameters
- returns: <[Promise]<[Object]>> - returns: <[Promise]<[Object]>>
### class: Coverage ### class: Coverage
Coverage gathers information about parts of JavaScript and CSS that were used by the page. Coverage gathers information about parts of JavaScript and CSS that were used by the page.
@ -2544,7 +2536,6 @@ console.log(`Bytes used: ${usedBytes / totalBytes * 100}%`);
> **NOTE** CSS Coverage doesn't include dynamically injected style tags without sourceURLs. > **NOTE** CSS Coverage doesn't include dynamically injected style tags without sourceURLs.
#### coverage.stopJSCoverage() #### coverage.stopJSCoverage()
- returns: <[Promise]<[Array]<[Object]>>> Promise that resolves to the array of coverage reports for all non-anonymous scripts - returns: <[Promise]<[Array]<[Object]>>> Promise that resolves to the array of coverage reports for all non-anonymous scripts
- `url` <[string]> Script URL - `url` <[string]> Script URL
@ -2556,7 +2547,6 @@ console.log(`Bytes used: ${usedBytes / totalBytes * 100}%`);
> **NOTE** JavaScript Coverage doesn't include anonymous scripts. However, scripts with sourceURLs are > **NOTE** JavaScript Coverage doesn't include anonymous scripts. However, scripts with sourceURLs are
reported. reported.
[Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array" [Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array"
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean" [boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean"
[Buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer "Buffer" [Buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer "Buffer"

5
docs/troubleshooting.md
View File

@ -88,6 +88,7 @@ xorg-x11-fonts-misc
- make sure kernel version is up-to-date - make sure kernel version is up-to-date
- read about linux sandbox here: https://chromium.googlesource.com/chromium/src/+/master/docs/linux_suid_sandbox_development.md - read about linux sandbox here: https://chromium.googlesource.com/chromium/src/+/master/docs/linux_suid_sandbox_development.md
- try running without the sandbox (**Note: running without the sandbox is not recommended due to security reasons!**) - try running without the sandbox (**Note: running without the sandbox is not recommended due to security reasons!**)
```js ```js
const browser = await puppeteer.launch({args: ['--no-sandbox', '--disable-setuid-sandbox']}); const browser = await puppeteer.launch({args: ['--no-sandbox', '--disable-setuid-sandbox']});
``` ```
@ -101,7 +102,7 @@ shared library dependencies.
To fix, you'll need to install the missing dependencies and the To fix, you'll need to install the missing dependencies and the
latest Chromium package in your Dockerfile: latest Chromium package in your Dockerfile:
``` ```Dockerfile
FROM node:8-slim FROM node:8-slim
# See https://crbug.com/795759 # See https://crbug.com/795759
@ -168,7 +169,7 @@ The [newest Chromium package](https://pkgs.alpinelinux.org/package/edge/communit
Example Dockerfile: Example Dockerfile:
``` ```Dockerfile
FROM node:9-alpine FROM node:9-alpine
# Installs latest Chromium (63) package. # Installs latest Chromium (63) package.

4
examples/README.md
View File

@ -8,7 +8,7 @@ NODE_PATH=../ node examples/search.js
# Tips & Tricks # Tips & Tricks
### Load a Chrome extension ## Load a Chrome extension
By default, Puppeteer disables extensions when launching Chrome. You can load a specific By default, Puppeteer disables extensions when launching Chrome. You can load a specific
extension using: extension using:
@ -28,6 +28,7 @@ const browser = await puppeteer.launch({
> Other useful tools, articles, and projects that use Puppeteer. > Other useful tools, articles, and projects that use Puppeteer.
## Rendering and web scraping ## Rendering and web scraping
- [Puppetron](https://github.com/cheeaun/puppetron) - Demo site that shows how to use Puppeteer and Headless Chrome to render pages. Inspired by [GoogleChrome/rendertron](https://github.com/GoogleChrome/rendertron). - [Puppetron](https://github.com/cheeaun/puppetron) - Demo site that shows how to use Puppeteer and Headless Chrome to render pages. Inspired by [GoogleChrome/rendertron](https://github.com/GoogleChrome/rendertron).
- [Thal](https://medium.com/@e_mad_ehsan/getting-started-with-puppeteer-and-chrome-headless-for-web-scrapping-6bf5979dee3e "An article on medium") - Getting started with Puppeteer and Chrome Headless for Web Scraping. - [Thal](https://medium.com/@e_mad_ehsan/getting-started-with-puppeteer-and-chrome-headless-for-web-scrapping-6bf5979dee3e "An article on medium") - Getting started with Puppeteer and Chrome Headless for Web Scraping.
- [pupperender](https://github.com/LasaleFamine/pupperender) - Express middleware that checks the User-Agent header of incoming requests, and if it matches one of a configurable set of bots, render the page using Puppeteer. Useful for PWA rendering. - [pupperender](https://github.com/LasaleFamine/pupperender) - Express middleware that checks the User-Agent header of incoming requests, and if it matches one of a configurable set of bots, render the page using Puppeteer. Useful for PWA rendering.
@ -36,5 +37,6 @@ const browser = await puppeteer.launch({
- [browserless](https://github.com/joelgriffith/browserless) - Headless Chrome as a service letting you execute Puppeteer scripts remotely. Provides a docker image with configuration for concurrency, launch arguments and more. - [browserless](https://github.com/joelgriffith/browserless) - Headless Chrome as a service letting you execute Puppeteer scripts remotely. Provides a docker image with configuration for concurrency, launch arguments and more.
## Testing ## Testing
- [angular-puppeteer-demo](https://github.com/Quramy/angular-puppeteer-demo) - Demo repository explaining how to use Puppeteer in Karma. - [angular-puppeteer-demo](https://github.com/Quramy/angular-puppeteer-demo) - Demo repository explaining how to use Puppeteer in Karma.
- [mocha-headless-chrome](https://github.com/direct-adv-interfaces/mocha-headless-chrome) - Tool which runs client-side **mocha** tests in the command line through headless Chrome. - [mocha-headless-chrome](https://github.com/direct-adv-interfaces/mocha-headless-chrome) - Tool which runs client-side **mocha** tests in the command line through headless Chrome.

2
lib/Coverage.js
View File

@ -223,7 +223,7 @@ class CSSCoverage {
]); ]);
helper.removeEventListeners(this._eventListeners); helper.removeEventListeners(this._eventListeners);
// aggregarte by styleSheetId // aggregate by styleSheetId
const styleSheetIdToCoverage = new Map(); const styleSheetIdToCoverage = new Map();
for (const entry of ruleTrackingResponse.ruleUsage) { for (const entry of ruleTrackingResponse.ruleUsage) {
let ranges = styleSheetIdToCoverage.get(entry.styleSheetId); let ranges = styleSheetIdToCoverage.get(entry.styleSheetId);

8
lib/EmulationManager.js
View File

@ -62,11 +62,11 @@ class EmulationManager {
function injectedTouchEventsFunction() { function injectedTouchEventsFunction() {
const touchEvents = ['ontouchstart', 'ontouchend', 'ontouchmove', 'ontouchcancel']; const touchEvents = ['ontouchstart', 'ontouchend', 'ontouchmove', 'ontouchcancel'];
// @ts-ignore // @ts-ignore
const recepients = [window.__proto__, document.__proto__]; const recipients = [window.__proto__, document.__proto__];
for (let i = 0; i < touchEvents.length; ++i) { for (let i = 0; i < touchEvents.length; ++i) {
for (let j = 0; j < recepients.length; ++j) { for (let j = 0; j < recipients.length; ++j) {
if (!(touchEvents[i] in recepients[j])) { if (!(touchEvents[i] in recipients[j])) {
Object.defineProperty(recepients[j], touchEvents[i], { Object.defineProperty(recipients[j], touchEvents[i], {
value: null, writable: true, configurable: true, enumerable: true value: null, writable: true, configurable: true, enumerable: true
}); });
} }

2
test/server/SimpleServer.js
View File

@ -22,7 +22,7 @@ const path = require('path');
const mime = require('mime'); const mime = require('mime');
const WebSocketServer = require('ws').Server; const WebSocketServer = require('ws').Server;
const fulfillSymbol = Symbol('fullfill callback'); const fulfillSymbol = Symbol('fullfil callback');
const rejectSymbol = Symbol('reject callback'); const rejectSymbol = Symbol('reject callback');
class SimpleServer { class SimpleServer {

6
test/test.js
View File

@ -2957,7 +2957,7 @@ describe('Page', function() {
expect(await page.evaluate(() => 'ontouchstart' in window)).toBe(false); expect(await page.evaluate(() => 'ontouchstart' in window)).toBe(false);
await page.setViewport(iPhone.viewport); await page.setViewport(iPhone.viewport);
expect(await page.evaluate(() => 'ontouchstart' in window)).toBe(true); expect(await page.evaluate(() => 'ontouchstart' in window)).toBe(true);
expect(await page.evaluate(dispatchTouch)).toBe('Recieved touch'); expect(await page.evaluate(dispatchTouch)).toBe('Received touch');
await page.setViewport({width: 100, height: 100}); await page.setViewport({width: 100, height: 100});
expect(await page.evaluate(() => 'ontouchstart' in window)).toBe(false); expect(await page.evaluate(() => 'ontouchstart' in window)).toBe(false);
@ -2965,11 +2965,11 @@ describe('Page', function() {
let fulfill; let fulfill;
const promise = new Promise(x => fulfill = x); const promise = new Promise(x => fulfill = x);
window.ontouchstart = function(e) { window.ontouchstart = function(e) {
fulfill('Recieved touch'); fulfill('Received touch');
}; };
window.dispatchEvent(new Event('touchstart')); window.dispatchEvent(new Event('touchstart'));
fulfill('Did not recieve touch'); fulfill('Did not receive touch');
return promise; return promise;
} }

2
utils/doclint/check_public_api/Documentation.js
View File

@ -16,7 +16,7 @@
class Documentation { class Documentation {
/** /**
* @param {!Array<!Documentation.Class>} clasesArray * @param {!Array<!Documentation.Class>} classesArray
*/ */
constructor(classesArray) { constructor(classesArray) {
this.classesArray = classesArray; this.classesArray = classesArray;

2
utils/doclint/check_public_api/MDBuilder.js
View File

@ -53,7 +53,7 @@ class MDOutline {
currentClass.members.push(member); currentClass.members.push(member);
} else if (element.matches('li') && element.firstChild.matches && element.firstChild.matches('code')) { } else if (element.matches('li') && element.firstChild.matches && element.firstChild.matches('code')) {
member.args.push(element.firstChild.textContent); member.args.push(element.firstChild.textContent);
} else if (element.matches('li') && element.firstChild.nodeType === Element.TEXT_NODE && element.firstChild.textContent.toLowerCase().startsWith('retur')) { } else if (element.matches('li') && element.firstChild.nodeType === Element.TEXT_NODE && element.firstChild.textContent.toLowerCase().startsWith('return')) {
member.hasReturn = true; member.hasReturn = true;
const expectedText = 'returns: '; const expectedText = 'returns: ';
let actualText = element.firstChild.textContent; let actualText = element.firstChild.textContent;

2
utils/doclint/preprocessor/index.js
View File

@ -31,7 +31,7 @@ module.exports = function(sources) {
commandEndRegex.lastIndex = commandStartRegex.lastIndex; commandEndRegex.lastIndex = commandStartRegex.lastIndex;
const end = commandEndRegex.exec(text); const end = commandEndRegex.exec(text);
if (!end) { if (!end) {
messages.push(Message.error(`Failed to find 'gen:stop' for comamnd ${start[0]}`)); messages.push(Message.error(`Failed to find 'gen:stop' for command ${start[0]}`));
break; break;
} }
const name = start[1]; const name = start[1];