cypress 5.2.0 → 5.3.0

package/lib/cli.js

@@ -55,6 +55,10 @@ function unknownOption(flag) {
 
 commander.Command.prototype.unknownOption = unknownOption;
 
+var coerceFalseOrString = function coerceFalseOrString(arg) {
+  return arg !== 'false' ? arg : false;
+};
+
 var coerceFalse = function coerceFalse(arg) {
   return arg !== 'false';
 };
@@ -196,7 +200,7 @@ var castCypressRunOptions = function castCypressRunOptions(opts) {
   // boolean arguments
   var result = R.evolve({
     port: coerceAnyStringToInt,
-    configFile: coerceFalse
+    configFile: coerceFalseOrString
   })(opts);
   return result;
 };

package/lib/util.js

@@ -449,20 +449,19 @@ var util = {
   },
   getEnv: function getEnv(varName, trim) {
     la(is.unemptyString(varName), 'expected environment variable name, not', varName);
-    var envVar = process.env[varName];
-    var configVar = process.env["npm_config_".concat(varName)];
-    var packageConfigVar = process.env["npm_package_config_".concat(varName)];
+    var configVarName = "npm_config_".concat(varName);
+    var packageConfigVarName = "npm_package_config_".concat(varName);
     var result;
 
-    if (envVar) {
+    if (process.env.hasOwnProperty(varName)) {
       debug("Using ".concat(varName, " from environment variable"));
-      result = envVar;
-    } else if (configVar) {
+      result = process.env[varName];
+    } else if (process.env.hasOwnProperty(configVarName)) {
       debug("Using ".concat(varName, " from npm config"));
-      result = configVar;
-    } else if (packageConfigVar) {
+      result = process.env[configVarName];
+    } else if (process.env.hasOwnProperty(packageConfigVarName)) {
       debug("Using ".concat(varName, " from package.json config"));
-      result = packageConfigVar;
+      result = process.env[packageConfigVarName];
     } // environment variables are often set double quotes to escape characters
     // and on Windows it can lead to weird things: for example
     //  set FOO="C:\foo.txt" && node -e "console.log('>>>%s<<<', process.env.FOO)"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",

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

@@ -264,6 +264,7 @@ declare namespace CypressCommandLine {
    * @see https://on.cypress.io/module-api
    */
   interface CypressRunResult {
+    status: 'finished'
     startedTestsAt: dateTimeISO
     endedTestsAt: dateTimeISO
     totalDuration: ms
@@ -294,7 +295,8 @@ declare namespace CypressCommandLine {
      * @example
       ```
       const result = await cypress.run()
-      if (result.failures) {
+      if (result.status === 'failed') {
+        console.error('failures %d', result.failures)
         console.error(result.message)
         process.exit(result.failures)
       }
@@ -302,6 +304,7 @@ declare namespace CypressCommandLine {
      *
   **/
   interface CypressFailedRunResult {
+    status: 'failed'
     failures: number
     message: string
   }
@@ -347,7 +350,11 @@ declare module 'cypress' {
      cypress.run({
        spec: 'cypress/integration/admin*-spec.js'
      }).then(results => {
-       // inspect results object
+       if (results.status === 'failed') {
+          // Cypress could not run
+        } else {
+          // inspect results object
+       }
      })
      ```
      */

package/types/cypress.d.ts

@@ -2564,7 +2564,7 @@ declare namespace Cypress {
      */
     waitForAnimations: boolean
     /**
-     * Firefox-only: The number of tests that will run between forced garbage collections.
+     * Firefox version 79 and below only: The number of tests that will run between forced garbage collections.
      * If a number is supplied, it will apply to `run` mode and `open` mode.
      * Set the interval to `null` or 0 to disable forced garbage collections.
      * @default { runMode: 1, openMode: null }
@@ -5042,7 +5042,7 @@ declare namespace Cypress {
       })
     ```
      */
-    (action: 'uncaught:exception', fn: (error: Error, runnable: Mocha.IRunnable) => false | void): void
+    (action: 'uncaught:exception', fn: (error: Error, runnable: Mocha.Runnable) => false | void): void
     /**
      * Fires when your app calls the global `window.confirm()` method.
      * Cypress will auto accept confirmations. Return `false` from this event and the confirmation will be canceled.
@@ -5102,7 +5102,7 @@ declare namespace Cypress {
      * Fires when the test has failed. It is technically possible to prevent the test from actually failing by binding to this event and invoking an async `done` callback. However this is **strongly discouraged**. Tests should never legitimately fail. This event exists because it's extremely useful for debugging purposes.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'fail', fn: (error: Error, mocha: Mocha.IRunnable) => void): void
+    (action: 'fail', fn: (error: Error, mocha: Mocha.Runnable) => void): void
     /**
      * Fires whenever the viewport changes via a `cy.viewport()` or naturally when Cypress resets the viewport to the default between tests. Useful for debugging purposes.
      * @see https://on.cypress.io/catalog-of-events#App-Events
@@ -5147,16 +5147,16 @@ declare namespace Cypress {
      * Fires before the test and all **before** and **beforeEach** hooks run.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'test:before:run', fn: (attributes: ObjectLike, test: Mocha.ITest) => void): void
+    (action: 'test:before:run', fn: (attributes: ObjectLike, test: Mocha.Test) => void): void
     /**
      * Fires before the test and all **before** and **beforeEach** hooks run. If a `Promise` is returned, it will be awaited before proceeding.
      */
-    (action: 'test:before:run:async', fn: (attributes: ObjectLike, test: Mocha.ITest) => void | Promise<any>): void
+    (action: 'test:before:run:async', fn: (attributes: ObjectLike, test: Mocha.Test) => void | Promise<any>): void
     /**
      * Fires after the test and all **afterEach** and **after** hooks run.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'test:after:run', fn: (attributes: ObjectLike, test: Mocha.ITest) => void): void
+    (action: 'test:after:run', fn: (attributes: ObjectLike, test: Mocha.Test) => void): void
   }
 
   // $CommandQueue from `command_queue.coffee` - a lot to type. Might be more useful if it was written in TS