4846b8723c
The `Launcher` class was serving two purposes: 1. Launch browsers 2. Connect to browsers Number 1) only needs to be done in Node land, but 2) is agnostic; in a browser version of Puppeteer we'll need the ability to connect over a websocket to send commands back and forth. As part of the agnostification work we needed to split the `Launcher` up so that the connection part can be made agnostic. Additionally, I removed dependencies on `https`, `http` and `URL` from Node, instead leaning on fetch (via `node-fetch` if in Node land) and the browser `URL` API (which was added to Node in Node 10). |
||
|---|---|---|
| .. | ||
| 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 in
lib/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.
- note that we run DocLint on the outputted JavaScript in
- 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