webdriver-manager - npm Package Compare versions

Comparing version 12.1.0 to 13.0.0-beta

package.json

 {
   "name": "webdriver-manager",
-  "version": "12.1.0",
-  "description": "A selenium server and browser driver manager for your end to end tests.",
+  "version": "13.0.0-beta",
+  "description": "webdriver-manager",
+  "bin": {
+    "webdriver-manager": "bin/webdriver-manager"
+  },
+  "main": "dist/lib/index.js",
+  "types": "dist/lib/index.d.ts",
   "scripts": {
-    "format": "gulp format",
-    "format-enforce": "gulp format:enforce",
-    "gulp": "gulp",
+    "check": "gts check",
+    "clean": "gts clean",
+    "compile": "npm run tsc",
+    "fix": "gts fix",
+    "gts": "gts",
+    "http-server": "tsc && node dist/spec/server/http_server.js",
     "jasmine": "jasmine",
-    "prepublish": "npm run format-enforce && tsc && gulp copy",
-    "tsc": "tsc",
-    "pretest": "tsc && gulp copy",
-    "test": "npm run test-unit && npm run test-e2e",
-    "test-unit": "jasmine",
-    "pretest-e2e:update": "webdriver-manager update --android --android-accept-licenses --avds none",
-    "pretest-e2e:start": "webdriver-manager start --detach --seleniumPort 4444 --android --appium-port 4723 --quiet",
-    "pretest-e2e": "npm run pretest && npm run pretest-e2e:update && npm run pretest-e2e:start",
-    "test-e2e": "jasmine JASMINE_CONFIG_PATH=e2e_spec/support/headless.json",
-    "posttest-e2e": "webdriver-manager shutdown"
+    "prepare": "npm run compile",
+    "pretest": "npm run compile",
+    "pretsc": "rm -rf dist/ && rm -rf downloads/",
+    "posttest": "npm run check",
+    "proxy-server": "tsc && node dist/spec/server/proxy_server.js",
+    "test": "tsc && npm run test-unit && npm run test-int && npm run test-proxy && npm run test-e2e",
+    "test-e2e": "tsc && jasmine JASMINE_CONFIG_PATH=spec/jasmine-e2e.json",
+    "test-int": "tsc && jasmine JASMINE_CONFIG_PATH=spec/jasmine-int.json",
+    "test-proxy": "tsc && jasmine JASMINE_CONFIG_PATH=spec/jasmine-proxy.json",
+    "test-unit": "tsc && jasmine JASMINE_CONFIG_PATH=spec/jasmine-unit.json",
+    "tslint": "tslint -c tslint.json --fix lib/**/*.ts spec/**/*.ts",
+    "tsc": "tsc"
   },
   "keywords": [
-    "angular",
+    "automation",
+    "browser",
+    "browsers",
+    "browser test",
+    "browser testing",
+    "chromedriver",
+    "geckodriver",
+    "iedriver",
+    "selenium",
+    "selenium-webdriver",
     "test",
     "testing",
-    "protractor",
     "webdriver",
-    "webdriverjs",
-    "selenium",
-    "selenium-webdriver"
+    "webdriverjs"
   ],
   "repository": {
     "type": "git",
-    "url": "git://github.com/angular/webdriver-manager.git"
+    "url": "git+https://github.com/angular/webdriver-manager.git"
   },
-  "bin": {
-    "webdriver-manager": "bin/webdriver-manager"
-  },
-  "main": "built/lib/webdriver.js",
   "author": "Craig Nishina <[e-mail]>",
   "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/angular/webdriver-manager/issues"
+  },
+  "homepage": "https://github.com/angular/webdriver-manager#readme",
   "dependencies": {
-    "adm-zip": "^0.4.9",
-    "chalk": "^1.1.1",
-    "del": "^2.2.0",
-    "glob": "^7.0.3",
-    "ini": "^1.3.4",
-    "minimist": "^1.2.0",
-    "q": "^1.4.1",
-    "request": "^2.87.0",
-    "rimraf": "^2.5.2",
-    "semver": "^5.3.0",
-    "xml2js": "^0.4.17"
+    "adm-zip": "^0.4.13",
+    "loglevel": "^1.6.1",
+    "request": "^2.88.0",
+    "semver": "^5.6.0",
+    "tar": "^4.4.8",
+    "xml2js": "^0.4.19",
+    "yargs": "^12.0.5"
   },
   "devDependencies": {
-    "@types/adm-zip": "^0.4.29",
-    "@types/chalk": "^0.4.28",
-    "@types/form-data": "^0.0.33",
-    "@types/glob": "^5.0.29",
-    "@types/ini": "^1.3.28",
-    "@types/jasmine": "^2.5.43",
-    "@types/minimatch": "^2.0.28",
-    "@types/minimist": "^1.1.28",
-    "@types/node": "^7.0.4",
-    "@types/q": "^0.0.32",
-    "@types/request": "^0.0.39",
-    "@types/rimraf": "^0.0.28",
-    "@types/selenium-webdriver": "^2.53.35",
-    "@types/semver": "^5.3.30",
-    "@types/xml2js": "0.0.32",
-    "clang-format": "^1.0.35",
-    "gulp": "^4.0.0",
-    "gulp-clang-format": "^1.0.23",
-    "jasmine": "^2.4.1",
-    "run-sequence": "^1.1.5",
-    "selenium-webdriver": "~3.0.1",
-    "typescript": "~2.3.0"
-  },
-  "engines": {
-    "node": ">=6.9.x"
+    "@types/adm-zip": "^0.4.31",
+    "@types/http-proxy": "^1.16.2",
+    "@types/jasmine": "^3.3.1",
+    "@types/loglevel": "^1.5.3",
+    "@types/node": "^10.12.12",
+    "@types/request": "^2.48.1",
+    "@types/rimraf": "^2.0.2",
+    "@types/semver": "^5.5.0",
+    "@types/tar": "^4.0.0",
+    "@types/xml2js": "^0.4.3",
+    "@types/yargs": "^12.0.1",
+    "clang-format": "^1.2.4",
+    "gts": "^0.9.0",
+    "http-proxy": "^1.17.0",
+    "jasmine": "^3.3.1",
+    "rimraf": "^2.6.2",
+    "tslint": "^5.11.0",
+    "typescript": "^3.2.2"
   }
 }

README.md

@@ -0,76 +1,124 @@
+# webdriver-manager [![CircleCI](https://circleci.com/gh/angular/webdriver-manager/tree/replacement.svg?style=svg)](https://circleci.com/gh/angular/webdriver-manager/tree/replacement)
 
-Webdriver Manager [![CircleCI Status](https://circleci.com/gh/angular/webdriver-manager.svg?style=shield)](https://circleci.com/gh/angular/webdriver-manager) [![Join the chat at https://gitter.im/angular/webdriver-manager](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/angular/webdriver-manager?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-=================
+* [Use as a dependency](#use-as-a-dependency)
+* [Use as a command line interface](#use-as-a-command-line-interface)
+* [The command line interface help commands](#the-command-line-interface-help-commands)
+* [Environment variables](docs/env_vars.md)
 
-A selenium server and browser driver manager for your end to end tests. This is the same tool as `webdriver-manager` from the [Protractor](https://github.com/angular/protractor) repository.
 
-**Note:** Version 9 and lower please reference [pose/webdriver-manager](https://github.com/pose/webdriver-manager). If there are features that existed in version 9 and lower, please open up an issue with the missing feature or a create a pull request.
+## Use as a dependency
 
-Getting Started
----------------
+To install this as a dependency: `npm install -D webdriver-manager`. The
+following is an example running webdriver-manager as a dependency.
+The test downloads the providers and starts the selenium server standalone as
+detached. After the test, it will shutdown the selenium server standalone.
 
+
 ```
-npm install -g webdriver-manager
-```
+import {
+  Options,
+  setLogLevel,
+  shutdown,
+  start,
+  update,
+} from 'webdriver-manager';
 
-Setting up a Selenium Server
-----------------------------
+const options: Options = {
+  browserDrivers: [{
+    name: 'chromedriver'     // For browser drivers, we just need to use a valid
+                             // browser driver name. Other possible values
+                             // include 'geckodriver' and 'iedriver'.
+  }],
+  server: {
+    name: 'selenium',
+    runAsNode: true,          // If we want to run as a node. By default
+                              // running as detached will set this to true.
+    runAsDetach: true         // To run this in detached. This returns the
+                              // process back to the parent process.
+  }
+};
+setLogLevel('info');          // Required if we webdriver-manager to log to
+                              // console. Not setting this will hide the logs.
 
-Prior to starting the selenium server, download the selenium server jar and driver binaries. By default it will download the selenium server jar and chromedriver binary.
+describe('some web test', () => {
+  beforeAll(async () => {
+    await update(options);
+    await start(options);
+  });
 
-```
-webdriver-manager update
-```
+  it('should run some web test', async () => {
+    // Your async / await web test with some framework.
+  });
 
-Starting the Selenium Server
-----------------------------
+  afterAll(async () => {
+    await shutdown(options);  // Makes the web request to shutdown the server.
+                              // If we do not call shutdown, the java command
+                              // will still be running the server on port 4444.
+  });
+});
 
-By default, the selenium server will run on `http://localhost:4444/wd/hub`.
+```
 
+## Use as a command line interface
 
 ```
-webdriver-manager start
+npm i -g webdriver-manager
+
+webdriver-manager update      // Downloads the latest binaries.
+webdriver-manager start       // Starts the selenium server standalone.
 ```
 
-Other useful commands
----------------------
+Note: Installing globally will not work with Protractor if you are trying to
+start a Selenium Standalone server with a "local" or "directConnect". It will
+not work for these since Protractor is looking files downloaded locally to
+the project.
 
-View different versions of server and driver files:
+## The command line interface help commands
 
-```
-webdriver-manager status
-```
+To get a list of commands for webdriver-manager, use the help flag.
 
-Clear out the server and driver files. If `webdriver-manager start` does not work, try to clear out the saved files.
-
 ```
-webdriver-manager clean
-```
+webdriver-manager --help
+webdriver-manager [command]
 
-Running / stopping server in background process (stopping is not yet supported on standalone server 3.x.x):
+Commands:
+  webdriver-manager clean     Removes downloaded files from the out_dir.
+  webdriver-manager shutdown  Shutdown a local selenium server with GET request
+  webdriver-manager start     Start up the selenium server.
+  webdriver-manager status    List the current available binaries.
+  webdriver-manager update    Install or update selected binaries.
 
+Options:
+  --version  Show version number                                       [boolean]
+  --help     Show help                                                 [boolean]
 ```
-webdriver-manager start --detach
-webdriver-manager shutdown
-```
 
-Help commands
--------------
+To get a list of options that can be passed to the `webdriver-manager update`
+command, use the help flag.
 
-Wedriver-manager has a main help option: `webdriver-manager help`. There are also other built in help menus for each of the commands. So for example, if you would like to look up all the flag options you can set in `update`, you could run `webdriver-manager update help`.
-
-Here are a list of all the commands with help:
-
 ```
-webdriver-manager update help
-webdriver-manager start help
-webdriver-manager clean help
-webdriver-manager status help
-```
+webdriver-manager update --help
+webdriver-manager update
 
-Other topics:
---------------
+Install or update selected binaries.
 
-- [mobile browser support](docs/mobile.md)
-- [protractor support](docs/protractor.md)
-- [set specific versions](docs/versions.md)
+Options:
+  --version              Show version number                           [boolean]
+  --help                 Show help                                     [boolean]
+  --out_dir              Location of output.                            [string]
+  --chrome               Install or update chromedriver.
+                                                       [boolean] [default: true]
+  --gecko                Install or update geckodriver.[boolean] [default: true]
+  --github_token         Use a GitHub token to prevent rate limit issues.
+                                                                        [string]
+  --iedriver             Install or update ie driver. [boolean] [default: false]
+  --ignore_ssl           Ignore SSL certificates.                      [boolean]
+  --log_level            The log level of this CLI.   [string] [default: "info"]
+  --proxy                Use a proxy server to download files.          [string]
+  --standalone           Install or update selenium server standalone.
+                                                       [boolean] [default: true]
+  --versions.chrome      The chromedriver version.                      [string]
+  --versions.gecko       The geckodriver version.                       [string]
+  --versions.ie          The ie driver version.                         [string]
+  --versions.standalone  The selenium server standalone version.        [string]
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

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

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

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 3 instances in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Dependency count

7

decreased by-36.36%

Dev dependency count

18

decreased by-18.18%

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

124

increased by63.16%

Number of low supply chain risk alerts

21

decreased by-4.55%

Number of medium supply chain risk alerts

4

decreased by-42.86%

Worsened metrics

Total package byte prevSize

184688

decreased by-46.3%

Number of package files

71

decreased by-41.8%

Lines of code

3223

decreased by-29.2%

Dependency changes

• + Addedloglevel@^1.6.1

• + Addedtar@^4.4.8

• + Addedyargs@^12.0.5

• + Addedansi-regex@3.0.1(transitive)

• + Addedcamelcase@5.3.1(transitive)

• + Addedchownr@1.1.4(transitive)

• + Addedcliui@4.1.0(transitive)

• + Addedcode-point-at@1.1.0(transitive)

• + Addedcross-spawn@6.0.6(transitive)

• + Addeddecamelize@1.2.0(transitive)

• + Addedend-of-stream@1.4.4(transitive)

• + Addedexeca@1.0.0(transitive)

• + Addedfind-up@3.0.0(transitive)

• + Addedfs-minipass@1.2.7(transitive)

• + Addedget-caller-file@1.0.3(transitive)

• + Addedget-stream@4.1.0(transitive)

• + Addedinvert-kv@2.0.0(transitive)

• + Addedis-fullwidth-code-point@1.0.02.0.0(transitive)

• + Addedis-stream@1.1.0(transitive)

• + Addedisexe@2.0.0(transitive)

• + Addedlcid@2.0.0(transitive)

• + Addedlocate-path@3.0.0(transitive)

• + Addedloglevel@1.9.2(transitive)

• + Addedmap-age-cleaner@0.1.3(transitive)

• + Addedmem@4.3.0(transitive)

• + Addedmimic-fn@2.1.0(transitive)

• + Addedminipass@2.9.0(transitive)

• + Addedminizlib@1.3.3(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addednice-try@1.0.5(transitive)

• + Addednpm-run-path@2.0.2(transitive)

• + Addednumber-is-nan@1.0.1(transitive)

• + Addedos-locale@3.1.0(transitive)

• + Addedp-defer@1.0.0(transitive)

• + Addedp-finally@1.0.0(transitive)

• + Addedp-is-promise@2.1.0(transitive)

• + Addedp-limit@2.3.0(transitive)

• + Addedp-locate@3.0.0(transitive)

• + Addedp-try@2.2.0(transitive)

• + Addedpath-exists@3.0.0(transitive)

• + Addedpath-key@2.0.1(transitive)

• + Addedpump@3.0.2(transitive)

• + Addedrequire-directory@2.1.1(transitive)

• + Addedrequire-main-filename@1.0.1(transitive)

• + Addedset-blocking@2.0.0(transitive)

• + Addedshebang-command@1.2.0(transitive)

• + Addedshebang-regex@1.0.0(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedstring-width@1.0.22.1.1(transitive)

• + Addedstrip-ansi@4.0.0(transitive)

• + Addedstrip-eof@1.0.0(transitive)

• + Addedtar@4.4.19(transitive)

• + Addedwhich@1.3.1(transitive)

• + Addedwhich-module@2.0.1(transitive)

• + Addedwrap-ansi@2.1.0(transitive)

• + Addedy18n@4.0.3(transitive)

• + Addedyallist@3.1.1(transitive)

• + Addedyargs@12.0.5(transitive)

• + Addedyargs-parser@11.1.1(transitive)

• - Removedchalk@^1.1.1

• - Removeddel@^2.2.0

• - Removedglob@^7.0.3

• - Removedini@^1.3.4

• - Removedminimist@^1.2.0

• - Removedq@^1.4.1

• - Removedrimraf@^2.5.2

• - Removedansi-styles@2.2.1(transitive)

• - Removedarray-union@1.0.2(transitive)

• - Removedarray-uniq@1.0.3(transitive)

• - Removedarrify@1.0.1(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedchalk@1.1.3(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removeddel@2.2.2(transitive)

• - Removedescape-string-regexp@1.0.5(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedglob@7.2.3(transitive)

• - Removedglobby@5.0.0(transitive)

• - Removedhas-ansi@2.0.0(transitive)

• - Removedinflight@1.0.6(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedini@1.3.8(transitive)

• - Removedis-path-cwd@1.0.0(transitive)

• - Removedis-path-in-cwd@1.0.1(transitive)

• - Removedis-path-inside@1.0.1(transitive)

• - Removedminimatch@3.1.2(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedpath-is-inside@1.0.2(transitive)

• - Removedpify@2.3.0(transitive)

• - Removedpinkie@2.0.4(transitive)

• - Removedpinkie-promise@2.0.1(transitive)

• - Removedq@1.5.1(transitive)

• - Removedrimraf@2.7.1(transitive)

• - Removedsupports-color@2.0.0(transitive)

• Updatedadm-zip@^0.4.13

• Updatedrequest@^2.88.0

• Updatedsemver@^5.6.0

• Updatedxml2js@^0.4.19