8e45a1c882
Example:
(async () => {
const browser = await puppeteer.launch();
const context = await browser.createIncognitoBrowserContext('myproxy.com:3128');
const page = await context.newPage()
await page.authenticate({username: 'foo', password: 'bar' });
await page.goto('https://google.com');
await browser.close();
})();
Issue: #678
|
||
|---|---|---|
| .. | ||
| check_public_api | ||
| preprocessor | ||
| .gitignore | ||
| cli.js | ||
| Message.js | ||
| README.md | ||
| Source.js | ||
DocLint
Doclint is a small program that lints Puppeteer's documentation against Puppeteer's source code.
Doclint works in a few steps:
- Read sources in
lib/folder, parse AST trees and extract public API. Note that we run DocLint on the outputted JavaScript inlib/rather than the source code insrc/. We will do this until we have migratedsrc/to be exclusively TypeScript and then we can update DocLint to support TypeScript. - Read sources in
docs/folder, render markdown to HTML, use puppeteer to traverse the HTML and extract described API. - Compare one API to another.
Doclint is also responsible for general markdown checks, most notably for the table of contents relevancy.
Running
npm run doc
Tests
Doclint has its own set of jasmine tests, located at utils/doclint/test folder.
To execute tests, run:
npm run test-doclint