History

Andrey Lushnikov 0960dc38d1 Automatically generate table-of-contents for markdown This patch teaches doclint to regenerate table of contents automatically whenever it's needed. This patch: - splits lint.js into lint.js and cli.js - teaches cli.js to generate table-of-contents - removes the test for table-of-contents errors from doclint - adds a test for doclint failing to parse object destructuring in method parameters.		2017-07-21 11:12:05 -07:00
..
test	Automatically generate table-of-contents for markdown	2017-07-21 11:12:05 -07:00
.gitignore	[doclint] move doclint testing to golden	2017-07-13 11:17:02 -07:00
cli.js	Automatically generate table-of-contents for markdown	2017-07-21 11:12:05 -07:00
Documentation.js	[doclint] lint events	2017-07-14 23:52:13 -07:00
JSBuilder.js	Automatically generate table-of-contents for markdown	2017-07-21 11:12:05 -07:00
lint.js	Automatically generate table-of-contents for markdown	2017-07-21 11:12:05 -07:00
MDBuilder.js	Automatically generate table-of-contents for markdown	2017-07-21 11:12:05 -07:00
README.md	[doclint] Move doclint under utils/	2017-07-13 00:28:52 -07:00

DocLint

Doclint is a small program that lints Puppeteer's documentation against Puppeteer's source code.

Doclint works in a few steps:

Read sources in lib/ folder, parse AST trees and extract public API
Read sources in docs/ folder, render markdown to HTML, use puppeteer to traverse the HTML and extract described API
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

Doclint has its own set of jasmine tests, located at utils/doclint/test folder.

To execute tests, run:

npm run test-doclint