microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-10-28 06:07:53 +03:00
Code Issues Projects Releases Wiki Activity
96331de1f1
playwright/utils/doclint
History
Andrey Lushnikov 9efc66366c
chore: generate README.md for playwright package on prepublish (#1801) 
This will ensure that `playwright` package always has a readme.

Fix #1798
2020-04-15 11:29:59 -07:00
..
check_public_api fix(tests): fix a race with golden setup (#1757) 2020-04-13 14:12:44 -07:00
preprocessor chore(testrunner): split TestRunner into parts (#1679) 2020-04-06 17:21:42 -07:00
.gitignore Initial commit 2019-11-19 10:58:15 -08:00
cli.js chore: generate README.md for playwright package on prepublish (#1801) 2020-04-15 11:29:59 -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