microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-12-15 14:11:50 +03:00
Code Issues Projects Releases Wiki Activity
62966144bd
playwright/utils/doclint
History
Joel Einbinder 671cfa0a54
fix(types): support objects with typed keys and values (#1752) 
There are a few places in the API where we use objects as maps. This patch adds them to docs and the types.

For `env`, we accept booleans and numbers as well because they are often used for their string values.
2020-04-23 14:45:57 -07:00
..
check_public_api fix(types): support objects with typed keys and values (#1752) 2020-04-23 14:45:57 -07:00
preprocessor devops: make README.md to always reflect tip-of-tree (#1911) 2020-04-21 22:08:56 -07:00
.gitignore Initial commit 2019-11-19 10:58:15 -08:00
cli.js devops: make README.md to always reflect tip-of-tree (#1911) 2020-04-21 22:08:56 -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