microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-12-13 17:14:02 +03:00
Code Issues Projects Releases Wiki Activity
0db09f8ed4
playwright/utils/doclint
History
Pavel Feldman 0db09f8ed4
test: roll test runner to 0.9.20 (#4062)
2020-10-05 17:03:24 -07:00
..
check_public_api test: roll test runner to 0.9.20 (#4062) 2020-10-05 17:03:24 -07:00
preprocessor chore: roll test runner to 0.3.5 (#3832) 2020-09-10 21:31:46 -07:00
.gitignore Initial commit 2019-11-19 10:58:15 -08:00
cli.js refactor: consolidate ffmpeg-related files in third_party/ffmpeg (#3815) 2020-09-09 09:51:28 -07:00
generateApiJson.js fix(api.json): do not copy documentation from base class members (#4048) 2020-10-02 19:19:19 -07:00
Message.js Initial commit 2019-11-19 10:58:15 -08:00
README.md Initial commit 2019-11-19 10:58:15 -08:00
Source.js feat(rpc): plumb CDPSession (#2862) 2020-07-07 18:47:00 -07:00

README.md

DocLint

Doclint is a small program that lints Playwright's documentation against Playwright's source code.

Doclint works in a few steps:

  1. Read sources in lib/ folder, parse AST trees and extract public API
  2. Read sources in docs/ folder, render markdown to HTML, use playwright to traverse the HTML and extract described API
  3. 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