mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
62cacbe5f5
This patch implements documentation linter, which leaves under `test/doclint` folder. The documentation linter works like this: 1. Parse javascript source code with esprima and construct a "documentation" out of source code 2. Generate HTML out of `api.md` and traverse the HTML with puppeteer. 3. Make sure javascript aligns nicely with HTML The documentation linter adds the following commands: - `yarn doc` - to test that documentation covers all the relevant apis - `yarn generate-toc` - to update the table-of-contents for the `api.md`
44 lines
1.1 KiB
JSON
44 lines
1.1 KiB
JSON
{
|
|
"name": "puppeteer",
|
|
"version": "0.0.1",
|
|
"description": "",
|
|
"main": "index.js",
|
|
"engines": {
|
|
"node": ">=7.10.0"
|
|
},
|
|
"scripts": {
|
|
"unit": "jasmine test/test.js",
|
|
"test-phantom": "python third_party/phantomjs/test/run-tests.py",
|
|
"test": "npm run lint --silent && npm run unit && npm run test-phantom",
|
|
"install": "node install.js",
|
|
"lint": "[ \"$CI\" = true ] && eslint --quiet -f codeframe . || eslint .",
|
|
"generate-toc": "markdown-toc -i docs/api.md",
|
|
"doc": "jasmine test/doclint/lint.js"
|
|
},
|
|
"author": "The Chromium Authors",
|
|
"license": "SEE LICENSE IN LICENSE",
|
|
"dependencies": {
|
|
"extract-zip": "^1.6.5",
|
|
"mime": "^1.3.4",
|
|
"progress": "^2.0.0",
|
|
"rimraf": "^2.6.1",
|
|
"ws": "^3.0.0"
|
|
},
|
|
"puppeteer": {
|
|
"chromium_revision": "484159"
|
|
},
|
|
"devDependencies": {
|
|
"commonmark": "^0.27.0",
|
|
"deasync": "^0.1.9",
|
|
"eslint": "^4.0.0",
|
|
"esprima": "^4.0.0",
|
|
"jasmine": "^2.6.0",
|
|
"markdown-toc": "^1.1.0",
|
|
"minimist": "^1.2.0",
|
|
"ncp": "^2.0.0",
|
|
"pixelmatch": "^4.0.2",
|
|
"pngjs": "^3.2.0",
|
|
"text-diff": "^1.0.1"
|
|
}
|
|
}
|