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
211c372a3a
puppeteer/utils/doclint
History
JoelEinbinder bd72e40e73 Introduce page.tracing (#181) 
This patch introduces page.tracing, which allows to start and stop
trace recording for a page. The trace could be then saved to file.
2017-08-02 10:45:11 -07:00
..
check_public_api Introduce page.tracing (#181) 2017-08-02 10:45:11 -07:00
preprocessor [doclint] remove preprocessor's gen:copy and gen:paste commands 2017-07-31 21:21:45 -07:00
.gitignore [doclint] move doclint testing to golden 2017-07-13 11:17:02 -07:00
cli.js [doclint] Implement simple markdown preprocessor 2017-07-31 02:06:27 -07:00
Message.js [doclint] Prepare doclint for more checks 2017-07-31 00:10:59 -07:00
README.md [doclint] Move doclint under utils/ 2017-07-13 00:28:52 -07:00
SourceFactory.js [doclint] Implement simple markdown preprocessor 2017-07-31 02:06:27 -07:00
toc.js [doclint] Prepare doclint for more checks 2017-07-31 00:10:59 -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