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

Files

Andrey Lushnikov 0b94fa70eb chore: stop using console.assert everywhere (#2646 )

Since Node 10, `console.assert` no longer throws an AssertionError.
(This is generally good since it aligns Node.js with Browsers.)

This patch migrates all usages of `console.assert` in our codebase.
- All the `lib/` and testing code is migrated onto a handmade `assert`
function. This is to make Puppeteer transpilation / bundling easier.
- All the tooling is switched to use Node's `assert` module.

Fixes #2547.

2018-05-31 16:53:51 -07:00

check_public_api

chore: stop using console.assert everywhere (#2646 )

2018-05-31 16:53:51 -07:00

preprocessor

docs(api.md): fix table-of-contents (#2636 )

2018-05-31 14:21:43 -07:00

.gitignore

…

cli.js

chore: link to the latest-released API from the README.md (#2449 )

2018-04-25 18:18:08 -07:00

Message.js

…

README.md

…

Source.js

chore(doclint): remove SourceFactory (#2447 )

2018-04-25 18:07:20 -07:00

toc.js

…

README.md

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

Tests

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

To execute tests, run:

npm run test-doclint