thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
3204f2780f
puppeteer/utils/doclint
History
Jack Franklin 3204f2780f
chore: fix eslint warnings around type defs (#7230) 
This PR updates some code to remove constant ESLint warnings. It also
upgrades those warnings to errors - so that they have to be resolved
as part of the PR, rather than landing as a warning and causing noise.

Fixes #7229.
2021-05-12 17:43:05 +01:00
..
check_public_api chore: fix eslint warnings around type defs (#7230) 2021-05-12 17:43:05 +01: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