mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00

History

Andrey Lushnikov 4ee8eb8afc [doclint] introduce preprocessor's gen:copy and gen:paste tasks The two tasks allow to copy text from one part of document to another. This comes handy in organizing the documentation for our shortcut methods, which should be exactly the same as the original methods. The tasks work like this: - the gen:copy(id) task saves a part of document under the name 'ID'. - the gen:paste(id) task pastes text saved with id 'ID' This patch also fixes a bunch of links in documentation, as well as migrating `api.md` to use the two tasks.		2017-07-31 04:14:41 -07:00
..
check_public_api	[doclint] Prepare doclint for more checks	2017-07-31 00:10:59 -07:00
preprocessor	[doclint] introduce preprocessor's gen:copy and gen:paste tasks	2017-07-31 04:14:41 -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

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