mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
e3922ea1f3
The codebase was incredibly inconsistent with the use of spacing around
curly braces, e.g.:
```
// this?
const a = {b: 1}
// or?
const a = { b: 1 }
```
This extended into import statements also. Google's styleguide is no
spacing, so we're going with that.
|
||
|---|---|---|
| .. | ||
| check_public_api | ||
| generate_types | ||
| preprocessor | ||
| .gitignore | ||
| cli.js | ||
| Message.js | ||
| README.md | ||
| Source.js | ||
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- note that we run DocLint on the outputted JavaScript in
lib/rather than the source code insrc/. We will do this until we have migratedsrc/to be exclusively TypeScript and then we can update DocLint to support TypeScript.
- note that we run DocLint on the outputted JavaScript in
- 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