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
8aa88d5021
playwright/utils/doclint
History
Joel Einbinder 8aa88d5021
fix(doc): check and update optional types in the api (#1206) 
This adds a new check to doclint for whether a member is correctly marked as optional. 
part of #6
2020-03-03 17:29:12 -08:00
..
check_public_api fix(doc): check and update optional types in the api (#1206) 2020-03-03 17:29:12 -08:00
preprocessor chore: generate browser versions when doing release (#999) 2020-02-13 18:26:38 -08:00
.gitignore Initial commit 2019-11-19 10:58:15 -08:00
cli.js chore: generate browser versions when doing release (#999) 2020-02-13 18:26:38 -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 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