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
c468c451c5
puppeteer/utils/doclint
History
Andrey Lushnikov c468c451c5 [doclint] move doclint testing to golden 
This patch:
- move doclint testing to golden
- refactor doclint/lint.js to drop specs and everything
2017-07-13 11:17:02 -07:00
..
test [doclint] move doclint testing to golden 2017-07-13 11:17:02 -07:00
.gitignore [doclint] move doclint testing to golden 2017-07-13 11:17:02 -07:00
Documentation.js [doclint] Move doclint under utils/ 2017-07-13 00:28:52 -07:00
JSBuilder.js [doclint] Move doclint under utils/ 2017-07-13 00:28:52 -07:00
lint.js [doclint] move doclint testing to golden 2017-07-13 11:17:02 -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