microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-12-14 21:53:35 +03:00
Code Issues Projects Releases Wiki Activity
774eb53980
playwright/utils/doclint
History
Pavel Feldman 1717cbd3d5
doc: describe return value as a part of method (#4608)
2020-12-05 15:29:16 -08:00
..
check_public_api chore: fix the doclint tests 2020-12-04 12:10:44 -08:00
preprocessor chore: remove the --only-update-browsers option 2020-12-04 12:22:34 -08:00
.gitignore Initial commit 2019-11-19 10:58:15 -08:00
cli.js doc: describe return value as a part of method (#4608) 2020-12-05 15:29:16 -08:00
generateApiJson.js fix(api.json): use separate maps for methods and events (#4310) 2020-11-02 18:31:32 -08: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 docs: generate method signatures in docs (#4590) 2020-12-03 22:28:11 -08: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