yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
playwright/utils/doclint
History
Joel Einbinder 1a25a4efcf
fix(doclint): support lists in comments (#1492) 
Adds logging comments to the doclint tests, and adds a new one with a bulleted list in a comment. Lists can only be used in comments where extra properties would be unexpected.
2020-03-23 14:50:32 -07:00
..
check_public_api
fix(doclint): support lists in comments (#1492)
2020-03-23 14:50:32 -07:00
preprocessor
fix(docs): lint and fix all internal links in api.md
2020-03-18 15:34:53 -07:00
.gitignore
Initial commit
2019-11-19 10:58:15 -08:00
cli.js
fix(docs): lint and fix all internal links in api.md
2020-03-18 15:34:53 -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