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 d4f0084f67
chore: move element coordinates handling to common (#139) 
Browser now implement boundingBox(), contentQuads() and layoutViewport().
2019-12-05 09:54:50 -08:00
..
check_public_api
chore: move element coordinates handling to common (#139)
2019-12-05 09:54:50 -08:00
generate_types
chore: move interception API into features/ (#43)
2019-11-21 14:41:38 -08:00
preprocessor
Revert "docs: show browser test stats in the readme (#24)"
2019-11-21 13:00:48 -08:00
.gitignore
Initial commit
2019-11-19 10:58:15 -08:00
cli.js
doc: fix doc linter (#2)
2019-11-19 13:59:52 -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
Initial commit
2019-11-19 10:58:15 -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