thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
52a103024b
puppeteer/utils/doclint
History
Joel Einbinder 9ba3261571 feat(accessibility): snapshot the accessibility tree (#3470) 
This adds `page.accessibility.snapshot()`. It serializes and returns the accessibility tree for the page. By default, uninteresting nodes are filtered out of the snapshot.

fixes #2033
2018-11-01 18:54:51 -07:00
..
check_public_api feat(accessibility): snapshot the accessibility tree (#3470) 2018-11-01 18:54:51 -07:00
preprocessor chore: preserve links to master version of API from README.md (#3197) 2018-09-05 20:33:04 +01:00
.gitignore [doclint] move doclint testing to golden 2017-07-13 11:17:02 -07:00
cli.js chore: enhance markdown preprocessor (#3050) 2018-08-08 18:20:20 -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
Source.js chore(doclint): remove SourceFactory (#2447) 2018-04-25 18:07:20 -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