34c1b338be
This patch: - introduces non-exported but used in api/impl struct types (e.g. Point); - makes all client classes implement respective public api interface. Pros: - Typescript is now responsible for type checking. We can remove our doclint checker (not removed yet). - Electron and Android types can be defined in the same way (this is not implemented yet). - We can move most of the type structs like Point to the public api and make some of them available. Cons: - Any cons? |
||
|---|---|---|
| .. | ||
| check_public_api | ||
| preprocessor | ||
| .gitignore | ||
| cli.js | ||
| generateApiJson.js | ||
| Message.js | ||
| README.md | ||
| Source.js | ||
DocLint
Doclint is a small program that lints Playwright's documentation against Playwright's source code.
Doclint works in a few steps:
- Read sources in
lib/folder, parse AST trees and extract public API - Read sources in
docs/folder, render markdown to HTML, use playwright 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