yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
playwright/utils/doclint
History
Dmitry Gozman 29a6cdff6b
fix(tests): fix a race with golden setup (#1757) 
When running multiple browsers, we should take the golden information from the state.
2020-04-13 14:12:44 -07:00
..
check_public_api
fix(tests): fix a race with golden setup (#1757)
2020-04-13 14:12:44 -07:00
preprocessor
chore(testrunner): split TestRunner into parts (#1679)
2020-04-06 17:21:42 -07:00
.gitignore
Initial commit
2019-11-19 10:58:15 -08:00
cli.js
chore: remove web mode (#1625)
2020-04-01 14:42:47 -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
chore(packages): copy readme from root folder into packages/playwright (#552)
2020-01-21 17:24:47 -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