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
Files
06dbb72c7338c201dc76842eb35004d03f26adc1
puppeteer/utils/doclint
History
Mathias Bynens 11ff374ca3 chore: drop Node.js v6 support (#5045) 
Node.js v6 was end-of-life'd in April, 2019, with AWS Lambda prohibiting updaets to the Node.js v6 runtime since June 30, 2019.

This makes it quite safe for us to remove the Node 6 support from the repository.
2019-10-16 17:00:20 +02:00
..
check_public_api
feat(puppeteer): introduce puppeteer.errors and puppeteer.devices (#4312)
2019-04-19 15:33:06 -07:00
generate_types
feat(puppeteer): introduce puppeteer.errors and puppeteer.devices (#4312)
2019-04-19 15:33:06 -07:00
preprocessor
docs: add table-of-contents to troubleshooting (#4234)
2019-04-02 19:08:22 -07:00
.gitignore
…
cli.js
docs(contributing): add instructions to build Chromium revisions (#4246)
2019-04-04 15:34:41 -07:00
Message.js
[doclint] Prepare doclint for more checks
2017-07-31 00:10:59 -07:00
README.md
…
Source.js
chore: drop Node.js v6 support (#5045)
2019-10-16 17:00:20 +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
  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