cypress 4.9.0 → 4.12.1

package/lib/cli.js

@@ -1,5 +1,13 @@
 "use strict";
 
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && Symbol.iterator in Object(iter)) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -14,6 +22,8 @@ function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
 var _ = require('lodash');
 
+var R = require('ramda');
+
 var commander = require('commander');
 
 var _require = require('common-tags'),
@@ -49,6 +59,10 @@ var coerceFalse = function coerceFalse(arg) {
   return arg !== 'false';
 };
 
+var coerceAnyStringToInt = function coerceAnyStringToInt(arg) {
+  return typeof arg === 'string' ? parseInt(arg) : arg;
+};
+
 var spaceDelimitedArgsMsg = function spaceDelimitedArgsMsg(flag, args) {
   var msg = "\n    ".concat(logSymbols.warning, " Warning: It looks like you're passing --").concat(flag, " a space-separated list of arguments:\n\n    \"").concat(args.join(' '), "\"\n\n    This will work, but it's not recommended.\n\n    If you are trying to pass multiple arguments, separate them with commas instead:\n      cypress run --").concat(flag, " arg1,arg2,arg3\n  ");
 
@@ -155,7 +169,79 @@ function showVersions() {
   })["catch"](util.logErrorExit1);
 }
 
+var createProgram = function createProgram() {
+  var program = new commander.Command(); // bug in commander not printing name
+  // in usage help docs
+
+  program._name = 'cypress';
+  program.usage('<command> [options]');
+  return program;
+};
+
+var addCypressRunCommand = function addCypressRunCommand(program) {
+  return program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('--ci-build-id <id>', text('ciBuildId')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-e, --env <env>', text('env')).option('--group <name>', text('group')).option('-k, --key <record-key>', text('key')).option('--headed', text('headed')).option('--headless', text('headless')).option('--no-exit', text('exit')).option('--parallel', text('parallel')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('-q, --quiet', text('quiet')).option('--record [bool]', text('record'), coerceFalse).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-s, --spec <spec>', text('spec')).option('-t, --tag <tag>', text('tag')).option('--dev', text('dev'), coerceFalse);
+};
+/**
+ * Casts known command line options for "cypress run" to their intended type.
+ * For example if the user passes "--port 5005" the ".port" property should be
+ * a number 5005 and not a string "5005".
+ *
+ * Returns a clone of the original object.
+ */
+
+
+var castCypressRunOptions = function castCypressRunOptions(opts) {
+  // only properties that have type "string | false" in our TS definition
+  // require special handling, because CLI parsing takes care of purely
+  // boolean arguments
+  var result = R.evolve({
+    port: coerceAnyStringToInt,
+    configFile: coerceFalse
+  })(opts);
+  return result;
+};
+
 module.exports = {
+  /**
+   * Parses `cypress run` command line option array into an object
+   * with options that you can feed into a `cypress.run()` module API call.
+   * @example
+   *  const options = parseRunCommand(['cypress', 'run', '--browser', 'chrome'])
+   *  // options is {browser: 'chrome'}
+   */
+  parseRunCommand: function parseRunCommand(args) {
+    return new Promise(function (resolve, reject) {
+      if (!Array.isArray(args)) {
+        return reject(new Error('Expected array of arguments'));
+      } // make a copy of the input arguments array
+      // and add placeholders where "node ..." would usually be
+      // also remove "cypress" keyword at the start if present
+
+
+      var cliArgs = args[0] === 'cypress' ? _toConsumableArray(args.slice(1)) : _toConsumableArray(args);
+      cliArgs.unshift(null, null);
+      debug('creating program parser');
+      var program = createProgram();
+      addCypressRunCommand(program).action(function () {
+        for (var _len = arguments.length, fnArgs = new Array(_len), _key = 0; _key < _len; _key++) {
+          fnArgs[_key] = arguments[_key];
+        }
+
+        debug('parsed Cypress run %o', fnArgs);
+        var options = parseVariableOpts(fnArgs, cliArgs);
+        debug('parsed options %o', options);
+        var casted = castCypressRunOptions(options);
+        debug('casted options %o', casted);
+        resolve(casted);
+      });
+      debug('parsing args: %o', cliArgs);
+      program.parse(cliArgs);
+    });
+  },
+
+  /**
+   * Parses the command line and kicks off Cypress process.
+   */
   init: function init(args) {
     if (!args) {
       args = process.argv;
@@ -176,18 +262,14 @@ module.exports = {
       logger.log();
     }
 
-    var program = new commander.Command(); // bug in commander not printing name
-    // in usage help docs
-
-    program._name = 'cypress';
-    program.usage('<command> [options]');
+    var program = createProgram();
     program.command('help').description('Shows CLI help and exits').action(function () {
       program.help();
     });
     program.option('-v, --version', text('version')).command('version').description(text('version')).action(showVersions);
-    program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('--ci-build-id <id>', text('ciBuildId')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-e, --env <env>', text('env')).option('--group <name>', text('group')).option('-k, --key <record-key>', text('key')).option('--headed', text('headed')).option('--headless', text('headless')).option('--no-exit', text('exit')).option('--parallel', text('parallel')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('-q, --quiet', text('quiet')).option('--record [bool]', text('record'), coerceFalse).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-s, --spec <spec>', text('spec')).option('-t, --tag <tag>', text('tag')).option('--dev', text('dev'), coerceFalse).action(function () {
-      for (var _len = arguments.length, fnArgs = new Array(_len), _key = 0; _key < _len; _key++) {
-        fnArgs[_key] = arguments[_key];
+    addCypressRunCommand(program).action(function () {
+      for (var _len2 = arguments.length, fnArgs = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+        fnArgs[_key2] = arguments[_key2];
       }
 
       debug('running Cypress with args %o', fnArgs);

package/lib/cypress.js

@@ -13,6 +13,8 @@ var _run = require('./exec/run');
 
 var util = require('./util');
 
+var cli = require('./cli');
+
 var cypressModuleApi = {
   /**
    * Opens Cypress GUI
@@ -53,6 +55,21 @@ var cypressModuleApi = {
         });
       });
     });
+  },
+  cli: {
+    /**
+     * Parses CLI arguments into an object that you can pass to "cypress.run"
+     * @example
+     *  const cypress = require('cypress')
+     *  const cli = ['cypress', 'run', '--browser', 'firefox']
+     *  const options = await cypress.cli.parseRunArguments(cli)
+     *  // options is {browser: 'firefox'}
+     *  await cypress.run(options)
+     * @see https://on.cypress.io/module-api
+     */
+    parseRunArguments: function parseRunArguments(args) {
+      return cli.parseRunCommand(args);
+    }
   }
 };
 module.exports = cypressModuleApi;

package/package.json

@@ -1,49 +1,49 @@
 {
   "name": "cypress",
-  "version": "4.9.0",
+  "version": "4.12.1",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",
     "size": "t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";"
   },
   "dependencies": {
-    "@cypress/listr-verbose-renderer": "0.4.1",
-    "@cypress/request": "2.88.5",
-    "@cypress/xvfb": "1.2.4",
-    "@types/sinonjs__fake-timers": "6.0.1",
-    "@types/sizzle": "2.3.2",
-    "arch": "2.1.2",
-    "bluebird": "3.7.2",
-    "cachedir": "2.3.0",
-    "chalk": "2.4.2",
-    "check-more-types": "2.24.0",
-    "cli-table3": "0.5.1",
-    "commander": "4.1.1",
-    "common-tags": "1.8.0",
-    "debug": "4.1.1",
-    "eventemitter2": "6.4.2",
-    "execa": "1.0.0",
-    "executable": "4.1.1",
-    "extract-zip": "1.7.0",
-    "fs-extra": "8.1.0",
-    "getos": "3.2.1",
-    "is-ci": "2.0.0",
-    "is-installed-globally": "0.3.2",
-    "lazy-ass": "1.6.0",
-    "listr": "0.14.3",
-    "lodash": "4.17.15",
-    "log-symbols": "3.0.0",
-    "minimist": "1.2.5",
-    "moment": "2.26.0",
-    "ospath": "1.2.2",
-    "pretty-bytes": "5.3.0",
-    "ramda": "0.26.1",
-    "request-progress": "3.0.0",
-    "supports-color": "7.1.0",
-    "tmp": "0.1.0",
-    "untildify": "4.0.0",
-    "url": "0.11.0",
-    "yauzl": "2.10.0"
+    "@cypress/listr-verbose-renderer": "^0.4.1",
+    "@cypress/request": "^2.88.5",
+    "@cypress/xvfb": "^1.2.4",
+    "@types/sinonjs__fake-timers": "^6.0.1",
+    "@types/sizzle": "^2.3.2",
+    "arch": "^2.1.2",
+    "bluebird": "^3.7.2",
+    "cachedir": "^2.3.0",
+    "chalk": "^2.4.2",
+    "check-more-types": "^2.24.0",
+    "cli-table3": "~0.5.1",
+    "commander": "^4.1.1",
+    "common-tags": "^1.8.0",
+    "debug": "^4.1.1",
+    "eventemitter2": "^6.4.2",
+    "execa": "^1.0.0",
+    "executable": "^4.1.1",
+    "extract-zip": "^1.7.0",
+    "fs-extra": "^8.1.0",
+    "getos": "^3.2.1",
+    "is-ci": "^2.0.0",
+    "is-installed-globally": "^0.3.2",
+    "lazy-ass": "^1.6.0",
+    "listr": "^0.14.3",
+    "lodash": "^4.17.19",
+    "log-symbols": "^3.0.0",
+    "minimist": "^1.2.5",
+    "moment": "^2.27.0",
+    "ospath": "^1.2.2",
+    "pretty-bytes": "^5.3.0",
+    "ramda": "~0.26.1",
+    "request-progress": "^3.0.0",
+    "supports-color": "^7.1.0",
+    "tmp": "~0.1.0",
+    "untildify": "^4.0.0",
+    "url": "^0.11.0",
+    "yauzl": "^2.10.0"
   },
   "files": [
     "bin",

package/types/cypress-npm-api.d.ts

@@ -6,7 +6,7 @@
 // in the future the NPM module itself will be in TypeScript
 // but for now describe it as an ambient module
 
-declare module 'cypress' {
+declare namespace CypressCommandLine {
   /**
    * All options that one can pass to "cypress.run"
    * @see https://on.cypress.io/module-api#cypress-run
@@ -306,6 +306,27 @@ declare module 'cypress' {
     message: string
   }
 
+  /**
+   * Methods allow parsing given CLI arguments the same way Cypress CLI does it.
+   */
+  interface CypressCliParser {
+    /**
+     * Parses the given array of string arguments to "cypress run"
+     * just like Cypress CLI does it.
+     * @see https://on.cypress.io/module-api
+     * @example
+     *  const cypress = require('cypress')
+     *  const args = ['cypress', 'run', '--browser', 'chrome']
+     *  const options = await cypress.cli.parseRunArguments(args)
+     *  // options is {browser: 'chrome'}
+     *  // pass the options to cypress.run()
+     *  const results = await cypress.run(options)
+     */
+    parseRunArguments(args: string[]): Promise<Partial<CypressRunOptions>>
+  }
+}
+
+declare module 'cypress' {
   /**
    * Cypress NPM module interface.
    * @see https://on.cypress.io/module-api
@@ -330,13 +351,19 @@ declare module 'cypress' {
      })
      ```
      */
-    run(options?: Partial<CypressRunOptions>): Promise<CypressRunResult | CypressFailedRunResult>,
+    run(options?: Partial<CypressCommandLine.CypressRunOptions>): Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>,
     /**
      * Opens Cypress GUI. Resolves with void when the
      * GUI is closed.
      * @see https://on.cypress.io/module-api#cypress-open
      */
-    open(options?: Partial<CypressOpenOptions>): Promise<void>
+    open(options?: Partial<CypressCommandLine.CypressOpenOptions>): Promise<void>
+
+    /**
+     * Utility functions for parsing CLI arguments the same way
+     * Cypress does
+     */
+    cli: CypressCommandLine.CypressCliParser
   }
 
   // export Cypress NPM module interface