thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
98c3894c84
puppeteer/utils/doclint
History
Pavel Feldman 98c3894c84 Introduce Page.waitForNavigation (#94) 
This patch introduces Page.waitForNavigation which allows to wait
for render-initiated navigation.

This patch also does a nice refactoring, replacing Navigator with NavigatorWatcher which
is not a part of a page state.

References #89
2017-07-18 18:54:24 -07:00
..
test Introduce Page.$ and Page.$$ (#75) 2017-07-17 18:56:56 -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 [doclint] lint events 2017-07-14 23:52:13 -07:00
lint.js Introduce Page.waitForNavigation (#94) 2017-07-18 18:54:24 -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