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
43eed027bd
playwright/utils/doclint
History
Andrey Lushnikov 43eed027bd
chore: rename root index-for-dev.js into index.js (#2337)
2020-05-23 00:03:57 -07:00
..
check_public_api chore: rename root index-for-dev.js into index.js (#2337) 2020-05-23 00:03:57 -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: rename root index-for-dev.js into index.js (#2337) 2020-05-23 00:03:57 -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