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

Files

JoelEinbinder 9212863b92 Node 6 support (#484 )

This patch:
- introduces a transpiler which substitutes async/await logic with
generators.
- starts using the transpiler to generate a node6-compatible version of puppeteer
- introduces a runtime-check to decide which version of code to use

Fixes #316.

2017-08-24 12:20:05 -07:00

check_public_api

Node 6 support (#484 )

2017-08-24 12:20:05 -07:00

preprocessor

Stricter eslint rules (#472 )

2017-08-22 14:18:07 -07:00

.gitignore

[doclint] move doclint testing to golden

2017-07-13 11:17:02 -07:00

cli.js

Use puppeteer.launch instead of browser constructor (#255 )

2017-08-14 18:08:06 -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

Change let into const (#457 )

2017-08-21 16:39:04 -07: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:

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