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
3b5dbe2308
puppeteer/utils/doclint
History
Andrey Lushnikov 3b5dbe2308 [doclint] be more permissive with syntax 
This patch adds a helpful message if the 'returns' statement is somehow
mistyped.

References #14.
2017-07-15 10:22:07 -07:00
..
test [doclint] be more permissive with syntax 2017-07-15 10:22:07 -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 [doclint] lint events 2017-07-14 23:52:13 -07:00
MDBuilder.js [doclint] be more permissive with syntax 2017-07-15 10:22:07 -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