thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4bd855c66b
puppeteer/utils/doclint
History
Andrey Lushnikov 56619baa64 [doclint] simplify error reporting 
This patch simplifies error reporting, making it straight-forward.
It also adds a few tests to make doclint more robust.
2017-07-13 15:52:49 -07:00
..
test [doclint] simplify error reporting 2017-07-13 15:52:49 -07:00
.gitignore [doclint] move doclint testing to golden 2017-07-13 11:17:02 -07:00
Documentation.js [doclint] simplify error reporting 2017-07-13 15:52:49 -07:00
JSBuilder.js [doclint] Move doclint under utils/ 2017-07-13 00:28:52 -07:00
lint.js [doclint] simplify error reporting 2017-07-13 15:52:49 -07:00
MDBuilder.js [doclint] Move doclint under utils/ 2017-07-13 00:28:52 -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