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
Andrey Lushnikov d29625c281
chore: generate browser versions when doing release (#999) 
This introduces a handful of new markdown preprocessor commands to
insert browser versions:
- `GEN:chromium-version-if-release` - inserts current Chromium version
  if we're doing release; noop otherwise.
- `GEN:firefox-version-if-release` - inserts current Firefox version
  if we're doing release; noop otherwise.

And to generate badge links:
- `GEN:chromium-version-badge-if-release` - inserts current Chromium version
  badge if we're doing release; noop otherwise.
- `GEN:firefox-version-badge-if-release` - inserts current Firefox version
  badge if we're doing release; noop otherwise.

This doesn't touch webkit at all - we're yet to figure what to do with
webkit version.

NOTE: versions will be updated only once we release. This way our
README.md always represents last released version.
2020-02-13 18:26:38 -08:00
..
check_public_api
fix(doclint): fix doclint for new typescript (#879)
2020-02-06 16:26:36 -08:00
preprocessor
chore: generate browser versions when doing release (#999)
2020-02-13 18:26:38 -08:00
.gitignore
Initial commit
2019-11-19 10:58:15 -08:00
cli.js
chore: generate browser versions when doing release (#999)
2020-02-13 18:26:38 -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