94077e0e74
chore: remove JS types checker, rely on typescript We keep checking that all methods are documented, and no extra methods are documented, but rely on typescript for everything else. |
||
|---|---|---|
| .. | ||
| 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