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
f90af6639d
puppeteer/utils/doclint
History
Jack Franklin 547699545a
chore(docs): stop generating devtools-protocol docs (#7464) 
This CL changes our docs generation to not include automatic docs from
devtools-protocol. Long term we probably want this, but for now it's
generating a vast amount of documentation and it's making setting up the
new website and docs harder. Let's focus just on the pptr docs for now
and revisit this once the foundations have been laid.
2021-08-03 14:22:27 +00:00
..
check_public_api chore(docs): stop generating devtools-protocol docs (#7464) 2021-08-03 14:22:27 +00:00
preprocessor chore: upgrade and pin prettier dependencies (#7232) 2021-05-12 16:48:30 +02:00
.gitignore [doclint] move doclint testing to golden 2017-07-13 11:17:02 -07:00
cli.js chore: clean up remaining Travis references (#6826) 2021-02-08 07:41:26 +01:00
Message.js docs: replace @return with @returns (#6006) 2020-06-12 12:38:24 +02:00
README.md chore: automate prettier in docs (#7014) 2021-03-23 10:02:34 +01:00
Source.js docs: replace @return with @returns (#6006) 2020-06-12 12:38:24 +02: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. Note that we run DocLint on the outputted JavaScript in lib/ rather than the source code in src/. We will do this until we have migrated src/ to be exclusively TypeScript and then we can update DocLint to support TypeScript.
  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