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
89007c8f3d
playwright/utils/doclint
History
Andrey Lushnikov 89007c8f3d
devops: make README.md to always reflect tip-of-tree (#1911) 
As of today, we have tooling in place that makes sure that our
main README.md **roughly** represents the state of the last release:
- browser versions and browser badges are those that we released last
- links to our API point to the last-released API version

This tooling, however, relies on the fact that every release is a sequence
of two consecutive commits:
- one commit that sets `package.json` version to a released version
- the following that "bumps" version to `-post`.

This release process is very unfortunate, because:
- it made releasing from branch impossible
- it required "freezing" commits to the master branch

This patch removes all the tooling and transitions `README.md` to always
represent tip-of-tree state. We will fully rely on
`https://playwright.dev` to show versioned docs.
2020-04-21 22:08:56 -07:00
..
check_public_api fix(tests): fix a race with golden setup (#1757) 2020-04-13 14:12:44 -07:00
preprocessor devops: make README.md to always reflect tip-of-tree (#1911) 2020-04-21 22:08:56 -07:00
.gitignore Initial commit 2019-11-19 10:58:15 -08:00
cli.js devops: make README.md to always reflect tip-of-tree (#1911) 2020-04-21 22:08:56 -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