133abb07cf
* chore: migrate src/Input to typescript This moves `Keyboard`, `Mouse` and `Touchscreen` to TypeScript. We gain some nice TS benefits here; by creating a type for all the keycodes we support we can type the input args as that rather than `string` which will hopefully save some users some debugging once we ship our TS types in a future version. * Remove from externs file * Update utils/doclint/check_public_api/index.js Co-Authored-By: Mathias Bynens <mathias@qiwi.be> Co-authored-by: Mathias Bynens <mathias@qiwi.be> |
||
|---|---|---|
| .. | ||
| check_public_api | ||
| generate_types | ||
| 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