mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
f666be3f5f
Now the async hooks helper is gone api.ts was only used by the coverage tools and by doclint. DocLint is nearing the end of its lifespan with the TSDoc work, so I focused on how best to define a list of modules for the coverage tooling. They define an object of classes, and the path to that module. They need the full path because we also check if the module exports any events that need to be emitted - the coverage tool asserts that the emitting of those events is also tested. It's not _great_ that DocLint relies on a constant defined in the coverage utils, but it should only be this way for a short period of time and no one is actively working on DocLint (bar the effort to remove it) so I don't think this is worth worrying about. This change also broke the DocLint tests; based on the fact that DocLint is on its way out it doesn't feel worth fixing the tests, so this commit also removes them. |
||
|---|---|---|
| .. | ||
| 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