History

Jack Franklin 9737059400 chore: remove doclint generate_types code (#5932 ) This script generated an `index.d.ts` file but that file was never commited to git nor included in Puppeteer when we ship. As of right now people who want TS types can install from the DefinitelyTyped repo and we are working on shipping types from Puppeteer itself. Therefore this script is not adding any value and can be removed.		2020-05-28 15:55:14 +01:00
..
check_public_api	feat(api): add page.emulateVisionDeficiency(type) (#5901 )	2020-05-26 17:14:20 +02:00
preprocessor	chore: add Prettier (#5825 )	2020-05-07 12:54:55 +02:00
.gitignore	[doclint] move doclint testing to golden	2017-07-13 11:17:02 -07:00
cli.js	chore: extract `BrowserRunner` into its own module (#5850 )	2020-05-12 16:30:13 +01:00
Message.js	[doclint] Prepare doclint for more checks	2017-07-31 00:10:59 -07:00
README.md	chore: fix missed `src/` vs `lib/` documentation (#5591 )	2020-04-06 10:32:42 +02:00
Source.js	chore: extract `BrowserRunner` into its own module (#5850 )	2020-05-12 16:30:13 +01:00

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 in src/. We will do this until we have migrated src/ 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

Doclint has its own set of jasmine tests, located at utils/doclint/test folder.

To execute tests, run:

npm run test-doclint