thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a2f1e2774a
puppeteer/utils/doclint
History
Joel Einbinder f2c968fdb8 chore(types): generate our own d.ts file from api.md (#3744) 
Generate `//index.d.ts` file with precise typescript definitions for all of the
Puppeteer API.
2019-01-28 15:12:45 -08:00
..
check_public_api chore(types): generate our own d.ts file from api.md (#3744) 2019-01-28 15:12:45 -08:00
generate_types chore(types): generate our own d.ts file from api.md (#3744) 2019-01-28 15:12:45 -08: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(types): lint the api docs with typescript (#3577) 2018-11-21 14:49:08 -08: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