microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-12-15 22:22:53 +03:00
Code Issues Projects Releases Wiki Activity
2f993018ea
playwright/utils/doclint
History
Pavel Feldman e558f0516b
chore: print the launch error message to console (#2304)
2020-05-20 00:10:10 -07:00
..
check_public_api chore: print the launch error message to console (#2304) 2020-05-20 00:10:10 -07:00
preprocessor chore: add script to generate release notes (#2099) 2020-05-04 22:28:09 -07:00
.gitignore Initial commit 2019-11-19 10:58:15 -08:00
cli.js chore: remove main index.js from playwright-core (#2178) 2020-05-11 09:38:09 -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 devops: auto-correct links in our documentation (#1955) 2020-04-23 19:52:06 -07: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