github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
52de75742b
puppeteer/utils/doclint
History
Andrey Lushnikov 52de75742b Implement visible option for Page.waitFor method 
This patch adds a 'visible' option to the Page.waitFor method, making
it possible to wait for the element to become actually visible.

References #89, #91.
2017-07-21 10:01:19 -07:00
..
test Implement visible option for Page.waitFor method 2017-07-21 10:01:19 -07:00
.gitignore [doclint] move doclint testing to golden 2017-07-13 11:17:02 -07:00
Documentation.js [doclint] lint events 2017-07-14 23:52:13 -07:00
JSBuilder.js Implement visible option for Page.waitFor method 2017-07-21 10:01:19 -07:00
lint.js Implement waitFor which survives navigation (#99) 2017-07-19 19:04:51 -07:00
MDBuilder.js Introduce Page.$ and Page.$$ (#75) 2017-07-17 18:56:56 -07:00
README.md [doclint] Move doclint under utils/ 2017-07-13 00:28:52 -07:00

README.md

DocLint

Doclint is a small program that lints Puppeteer's documentation against Puppeteer'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 puppeteer 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