puppeteer - npm Package Compare versions

Comparing version 0.0.0 to 0.9.0

index.js

@@ -1,7 +0,17 @@
-var puppeteer = module.exports = function () {
-  console.log("This is going to do something magical... just wait an see!"); 
-};
+/**
+ * Copyright 2017 Google Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 
-if (require.module === module) {
-  puppeteer();
-}
+module.exports = require('./lib/Puppeteer');

package.json

 {
   "name": "puppeteer",
-  "version": "0.0.0",
-  "description": "A script for setting up and installing new Ubuntu machines with Puppet",
+  "version": "0.9.0",
+  "description": "A high-level API to control headless Chrome over the DevTools Protocol",
   "main": "index.js",
+  "repository": "github:GoogleChrome/puppeteer",
+  "engines": {
+    "node": ">=7.10.0"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "unit": "jasmine test/test.js",
+    "debug-unit": "DEBUG_TEST=true node --inspect-brk ./node_modules/.bin/jasmine test/test.js",
+    "test-phantom": "python third_party/phantomjs/test/run-tests.py",
+    "test-doclint": "jasmine utils/doclint/check_public_api/test/test.js && jasmine utils/doclint/preprocessor/test.js",
+    "test": "npm run lint --silent && npm run coverage && npm run test-phantom && npm run test-doclint",
+    "install": "node install.js",
+    "lint": "([ \"$CI\" = true ] && eslint --quiet -f codeframe . || eslint .) && npm run doc",
+    "doc": "node utils/doclint/cli.js",
+    "coverage": "COVERAGE=true npm run unit"
   },
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/plus3network/puppeteer.git"
+  "author": "The Chromium Authors",
+  "license": "SEE LICENSE IN LICENSE",
+  "dependencies": {
+    "debug": "^2.6.8",
+    "extract-zip": "^1.6.5",
+    "mime": "^1.3.4",
+    "progress": "^2.0.0",
+    "rimraf": "^2.6.1",
+    "ws": "^3.0.0"
   },
-  "keywords": [
-    "puppet",
-    "devops",
-    "install",
-    "ubuntu"
-  ],
-  "author": "Chris Cowan",
-  "license": "MIT",
-  "readmeFilename": "README.md",
-  "gitHead": "730fbe50ac90eeaf2a5f02859b258b5dd2dbe92b"
+  "puppeteer": {
+    "chromium_revision": "494755"
+  },
+  "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",
+    "pdfjs-dist": "^1.8.595",
+    "pixelmatch": "^4.0.2",
+    "pngjs": "^3.2.0",
+    "text-diff": "^1.0.1"
+  }
 }

README.md

@@ -1,4 +0,147 @@
-puppeteer
-=========
+# Puppeteer [![Build Status](https://travis-ci.com/GoogleChrome/puppeteer.svg?token=8jabovWqb8afz5RDcYqx&branch=master)](https://travis-ci.com/GoogleChrome/puppeteer) [![NPM puppeteer package](https://img.shields.io/npm/v/puppeteer.svg)](https://npmjs.org/package/puppeteer)
 
-For setting up and installing new Ubuntu machines with puppet.
+<img src="https://user-images.githubusercontent.com/39191/29330067-dfc2be5a-81ac-11e7-9cc2-c569dd5f078c.png" height="200" align="right">
+
+###### [API](docs/api.md) | [FAQ](#faq) | [Contributing](https://github.com/GoogleChrome/puppeteer/blob/master/CONTRIBUTING.md)
+
+> Puppeteer is a Node library which provides a high-level API to control [headless](https://developers.google.com/web/updates/2017/04/headless-chrome) Chrome over the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/). It can also be configured to use full (non-headless) Chrome.
+
+###### What can I do?
+
+Most things that you can do manually in the browser can be done using Puppeteer! Here are a few examples to get you started:
+
+* Generate screenshots and PDFs of pages.
+* Crawl a SPA and generate pre-rendered content (i.e. "SSR").
+* Scrape content from websites.
+* Automate form submission, UI testing, keyboard input, etc.
+* Create an up-to-date, automated testing environment. Run your tests directly in the latest version of Chrome using the latest JavaScript and browser features.
+* Capture a [timeline trace](https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/reference) of your site to help diagnose performance issues.
+
+## Getting Started
+
+### Installation
+
+*Puppeteer requires Node version 7.10 or greater*
+
+To use Puppeteer in your project, run:
+```
+yarn add puppeteer
+# or "npm i puppeteer"
+```
+
+> **Note**: When you install Puppeteer, it downloads a recent version of Chromium (~71Mb Mac, ~90Mb Linux, ~110Mb Win) that is guaranteed to work with the API. 
+
+### Usage
+
+Puppeteer will be familiar to using other browser testing frameworks. You create an instance
+of `Browser`, open pages, and then manipulate them with [Puppeteer's API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#).
+
+**Example** - navigating to https://example.com and saving a screenshot as *example.png*:
+
+```js
+const puppeteer = require('puppeteer');
+
+(async() => {
+
+const browser = await puppeteer.launch();
+const page = await browser.newPage();
+await page.goto('https://example.com');
+await page.screenshot({path: 'example.png'});
+
+browser.close();
+})();
+```
+
+Puppeteer sets an initial page size to 800px x 600px, which defines the screenshot size. The page size can be customized  with [`Page.setViewport()`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagesetviewportviewport).
+
+**Example** - create a PDF.
+
+```js
+const puppeteer = require('puppeteer');
+
+(async() => {
+
+const browser = await puppeteer.launch();
+const page = await browser.newPage();
+await page.goto('https://news.ycombinator.com', {waitUntil: 'networkidle'});
+await page.pdf({path: 'hn.pdf', format: 'A4'});
+
+browser.close();
+})();
+```
+
+See [`Page.pdf()`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions) for more information about creating pdfs.
+
+## Default runtime settings
+
+**1. Uses Headless mode**
+
+Puppeteer launches Chromium in [headless mode](https://developers.google.com/web/updates/2017/04/headless-chrome). To launch a full version of Chromium, set the ['headless' option](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions) when creating a browser:
+
+```js
+const browser = await puppeteer.launch({headless: false});
+```
+
+**2. Runs a bundled version of Chromium**
+
+By default, Puppeteer downloads and uses a specific version of Chromium so its API
+is guaranteed to work out of the box. To use Puppeteer with a different version of Chrome,
+pass in the executable's path when creating a `Browser` instance:
+
+```js
+const browser = await puppeteer.launch({executablePath: '/path/to/Chrome'});
+```
+
+See [`Puppeteer.launch()`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions) for more information.
+
+**3. Creates a fresh user profile**
+
+Puppeteer creates its own Chromium user profile which it **cleans up on every run**.
+
+## API Documentation
+
+Explore the [API documentation](docs/api.md) and [examples](https://github.com/GoogleChrome/puppeteer/tree/master/examples/) to learn more.
+
+## Contributing to Puppeteer
+
+Check out [contributing guide](https://github.com/GoogleChrome/puppeteer/blob/master/CONTRIBUTING.md) to get an overview of Puppeteer development.
+
+# FAQ
+
+#### Q: Which Chromium version does Puppeteer use?
+
+Look for `chromium_revision` in [package.json](https://github.com/GoogleChrome/puppeteer/blob/master/package.json).
+
+Puppeteer bundles Chromium to ensure that the latest features it uses are guaranteed to be available. As the DevTools protocol and browser improve over time, Puppeteer will be updated to depend on newer versions of Chromium.
+
+
+#### Q: What is the difference between Puppeteer, Selenium / WebDriver, and PhantomJS?
+
+Selenium / WebDriver is a well-established cross-browser API that is useful for testing cross-browser support.
+
+Puppeteer works only with Chrome. However, many teams only run unit tests with a single browser (e.g. PhantomJS). In non-testing use cases, Puppeteer provides a powerful but simple API because it's only targeting one browser that enables you to rapidly develop automation scripts.
+
+Puppeteer uses the latest versions of Chromium.
+
+
+#### Q: Who maintains Puppeteer?
+
+The Chrome DevTools team maintains the library, but we'd love your help and expertise on the project!
+See [Contributing](https://github.com/GoogleChrome/puppeteer/blob/master/CONTRIBUTING.md).
+
+#### Q: Why is the Chrome team building Puppeteer?
+
+The goals of the project are simple:
+
+- Provide a slim, canonical library that highlights the capabilities of the [DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/).
+- Provide a reference implementation for similar testing libraries. Eventually, these
+other frameworks could adopt Puppeteer as their foundational layer.
+- Grow the adoption of headless/automated browser testing.
+- Help dogfood new DevTools Protocol features...and catch bugs!
+- Learn more about the pain points of automated browser testing and help fill those gaps.
+
+#### Q: How does Puppeteer compare with other headless Chrome projects?
+ 
+The past few months have brought [several new libraries for automating headless Chrome](https://medium.com/@kensoh/chromeless-chrominator-chromy-navalia-lambdium-ghostjs-autogcd-ef34bcd26907). As the team authoring the underlying DevTools Protocol, we're excited to witness and support this flourishing ecosystem.
+
+We've reached out to a number of these projects to see if there are opportunities for collaboration, and we're happy to do what we can to help.

New alerts

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 2 instances in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses eval() which is a dangerous function. This prevents the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

313693

increased by34832.41%

Number of package files

54

increased by1250%

Lines of code

5780

increased by96233.33%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

148

increased by3600%

Published versions last months

4

increased by33.33%

Worsened metrics

Dependency count

6

increased byInfinity%

Dev dependency count

12

increased byInfinity%

Number of high supply chain risk alerts

1

increased byInfinity%

Number of low supply chain risk alerts

7

increased byInfinity%

Number of medium supply chain risk alerts

9

increased by800%

Dependency changes

• + Addeddebug@^2.6.8

• + Addedextract-zip@^1.6.5

• + Addedmime@^1.3.4

• + Addedprogress@^2.0.0

• + Addedrimraf@^2.6.1

• + Addedws@^3.0.0

• + Addedasync-limiter@1.0.1(transitive)

• + Addedbalanced-match@1.0.2(transitive)

• + Addedbrace-expansion@1.1.11(transitive)

• + Addedbuffer-crc32@0.2.13(transitive)

• + Addedbuffer-from@1.1.2(transitive)

• + Addedconcat-map@0.0.1(transitive)

• + Addedconcat-stream@1.6.2(transitive)

• + Addedcore-util-is@1.0.3(transitive)

• + Addeddebug@2.6.9(transitive)

• + Addedextract-zip@1.7.0(transitive)

• + Addedfd-slicer@1.1.0(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedglob@7.2.3(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedisarray@1.0.0(transitive)

• + Addedmime@1.6.0(transitive)

• + Addedminimatch@3.1.2(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addedms@2.0.0(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedpend@1.2.0(transitive)

• + Addedprocess-nextick-args@2.0.1(transitive)

• + Addedprogress@2.0.3(transitive)

• + Addedreadable-stream@2.3.8(transitive)

• + Addedrimraf@2.7.1(transitive)

• + Addedsafe-buffer@5.1.2(transitive)

• + Addedstring_decoder@1.1.1(transitive)

• + Addedtypedarray@0.0.6(transitive)

• + Addedultron@1.1.1(transitive)

• + Addedutil-deprecate@1.0.2(transitive)

• + Addedwrappy@1.0.2(transitive)

• + Addedws@3.3.3(transitive)

• + Addedyauzl@2.10.0(transitive)