microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-12-15 06:02:57 +03:00
Code Issues Projects Releases Wiki Activity
1eabd182e9
playwright/utils/doclint
History
Joel Einbinder ffc1022717
fix(doclint): fix doclint for new typescript (#879) 
Some types now have `innerTypeNames.length === 0`. Fun!
2020-02-06 16:26:36 -08:00
..
check_public_api fix(doclint): fix doclint for new typescript (#879) 2020-02-06 16:26:36 -08:00
preprocessor docs(readme): fix API link to always point to last released API 2020-02-05 12:05:36 -08:00
.gitignore Initial commit 2019-11-19 10:58:15 -08:00
cli.js feat(launch): introduce client, server & persistent launch modes (2) (#840) 2020-02-05 12:41:55 -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