cypress 12.1.0 → 12.2.0

package/index.js

@@ -1,35 +1,26 @@
 "use strict";
 
 const minimist = require('minimist');
-
 const debug = require('debug')('cypress:cli');
-
 const args = minimist(process.argv.slice(2));
+const util = require('./lib/util');
 
-const util = require('./lib/util'); // we're being used from the command line
-
-
+// we're being used from the command line
 switch (args.exec) {
   case 'install':
     debug('installing Cypress from NPM');
-
     require('./lib/tasks/install').start({
       force: args.force
     }).catch(util.logErrorExit1);
-
     break;
-
   case 'verify':
     // for simple testing in the monorepo
     debug('verifying Cypress');
-
     require('./lib/tasks/verify').start({
       force: true
     }) // always force verification
     .catch(util.logErrorExit1);
-
     break;
-
   default:
     debug('exporting Cypress module interface');
     module.exports = require('./lib/cypress');

package/lib/VerboseRenderer.js

@@ -2,26 +2,20 @@
 
 // Vendored from @cypress/listr-verbose-renderer
 const figures = require('figures');
-
 const cliCursor = require('cli-cursor');
-
 const chalk = require('chalk');
-
 const dayjs = require('dayjs');
-
 const formattedLog = (options, output) => {
-  const timestamp = dayjs().format(options.dateFormat); // eslint-disable-next-line no-console
+  const timestamp = dayjs().format(options.dateFormat);
 
+  // eslint-disable-next-line no-console
   console.log(`${chalk.dim(`[${timestamp}]`)} ${output}`);
 };
-
 const renderHelper = (task, event, options) => {
   const log = formattedLog.bind(undefined, options);
-
   if (event.type === 'STATE') {
     const message = task.isPending() ? 'started' : task.state;
     log(`${task.title} [${message}]`);
-
     if (task.isSkipped() && task.output) {
       log(`${figures.arrowRight} ${task.output}`);
     }
@@ -29,7 +23,6 @@ const renderHelper = (task, event, options) => {
     log(`${task.title} [title changed]`);
   }
 };
-
 const render = (tasks, options) => {
   for (const task of tasks) {
     task.subscribe(event => {
@@ -37,7 +30,6 @@ const render = (tasks, options) => {
         render(task.subtasks, options);
         return;
       }
-
       renderHelper(task, event, options);
     }, err => {
       // eslint-disable-next-line no-console
@@ -45,7 +37,6 @@ const render = (tasks, options) => {
     });
   }
 };
-
 class VerboseRenderer {
   constructor(tasks, options) {
     this._tasks = tasks;
@@ -53,20 +44,15 @@ class VerboseRenderer {
       dateFormat: 'HH:mm:ss'
     }, options);
   }
-
   static get nonTTY() {
     return true;
   }
-
   render() {
     cliCursor.hide();
     render(this._tasks, this._options);
   }
-
   end() {
     cliCursor.show();
   }
-
 }
-
 module.exports = VerboseRenderer;

package/lib/cli.js

@@ -2,27 +2,19 @@
 
 // @ts-check
 const _ = require('lodash');
-
 const commander = require('commander');
-
 const {
   stripIndent
 } = require('common-tags');
-
 const logSymbols = require('log-symbols');
-
 const debug = require('debug')('cypress:cli:cli');
-
 const util = require('./util');
-
 const logger = require('./logger');
-
 const errors = require('./errors');
+const cache = require('./tasks/cache');
 
-const cache = require('./tasks/cache'); // patch "commander" method called when a user passed an unknown option
+// patch "commander" method called when a user passed an unknown option
 // we want to print help for the current command and exit with an error
-
-
 function unknownOption(flag, type = 'option') {
   if (this._allowUnknownOption) return;
   logger.error();
@@ -31,17 +23,13 @@ function unknownOption(flag, type = 'option') {
   this.outputHelp();
   util.exit(1);
 }
-
 commander.Command.prototype.unknownOption = unknownOption;
-
 const coerceFalse = arg => {
   return arg !== 'false';
 };
-
 const coerceAnyStringToInt = arg => {
   return typeof arg === 'string' ? parseInt(arg) : arg;
 };
-
 const spaceDelimitedArgsMsg = (flag, args) => {
   let msg = `
     ${logSymbols.warning} Warning: It looks like you're passing --${flag} a space-separated list of arguments:
@@ -53,7 +41,6 @@ const spaceDelimitedArgsMsg = (flag, args) => {
     If you are trying to pass multiple arguments, separate them with commas instead:
       cypress run --${flag} arg1,arg2,arg3
   `;
-
   if (flag === 'spec') {
     msg += `
     The most common cause of this warning is using an unescaped glob pattern. If you are
@@ -61,35 +48,27 @@ const spaceDelimitedArgsMsg = (flag, args) => {
       cypress run --spec "**/*.spec.js"
     `;
   }
-
   logger.log();
   logger.warn(stripIndent(msg));
   logger.log();
 };
-
 const parseVariableOpts = (fnArgs, args) => {
   const [opts, unknownArgs] = fnArgs;
-
   if (unknownArgs && unknownArgs.length && (opts.spec || opts.tag)) {
     // this will capture space-delimited args after
     // flags that could have possible multiple args
     // but before the next option
     // --spec spec1 spec2 or --tag foo bar
-    const multiArgFlags = _.compact([opts.spec ? 'spec' : opts.spec, opts.tag ? 'tag' : opts.tag]);
 
+    const multiArgFlags = _.compact([opts.spec ? 'spec' : opts.spec, opts.tag ? 'tag' : opts.tag]);
     _.forEach(multiArgFlags, flag => {
       const argIndex = _.indexOf(args, `--${flag}`) + 2;
-
       const nextOptOffset = _.findIndex(_.slice(args, argIndex), arg => {
         return _.startsWith(arg, '--');
       });
-
       const endIndex = nextOptOffset !== -1 ? argIndex + nextOptOffset : args.length;
-
       const maybeArgs = _.slice(args, argIndex, endIndex);
-
       const extraArgs = _.intersection(maybeArgs, unknownArgs);
-
       if (extraArgs.length) {
         opts[flag] = [opts[flag]].concat(extraArgs);
         spaceDelimitedArgsMsg(flag, opts[flag]);
@@ -97,14 +76,12 @@ const parseVariableOpts = (fnArgs, args) => {
       }
     });
   }
-
   debug('variable-length opts parsed %o', {
     args,
     opts
   });
   return util.parseOpts(opts);
 };
-
 const descriptions = {
   browser: 'runs Cypress in the browser with the given name. if a filesystem path is supplied, Cypress will attempt to use the browser at that path.',
   cacheClear: 'delete all cached binaries',
@@ -139,19 +116,15 @@ const descriptions = {
   version: 'prints Cypress version'
 };
 const knownCommands = ['cache', 'help', '-h', '--help', 'install', 'open', 'run', 'open-ct', 'run-ct', 'verify', '-v', '--version', 'version', 'info'];
-
 const text = description => {
   if (!descriptions[description]) {
     throw new Error(`Could not find description for: ${description}`);
   }
-
   return descriptions[description];
 };
-
 function includesVersion(args) {
   return _.includes(args, 'version') || _.includes(args, '--version') || _.includes(args, '-v');
 }
-
 function showVersions(args) {
   debug('printing Cypress version');
   debug('additional arguments %o', args);
@@ -161,14 +134,12 @@ function showVersions(args) {
     component: parsed.component
   };
   debug('parsed version arguments %o', parsedOptions);
-
   const reportAllVersions = versions => {
     logger.always('Cypress package version:', versions.package);
     logger.always('Cypress binary version:', versions.binary);
     logger.always('Electron version:', versions.electronVersion);
     logger.always('Bundled Node version:', versions.electronNodeVersion);
   };
-
   const reportComponentVersion = (componentName, versions) => {
     const names = {
       package: 'package',
@@ -176,21 +147,16 @@ function showVersions(args) {
       electron: 'electronVersion',
       node: 'electronNodeVersion'
     };
-
     if (!names[componentName]) {
       throw new Error(`Unknown component name "${componentName}"`);
     }
-
     const name = names[componentName];
-
     if (!versions[name]) {
       throw new Error(`Cannot find version for component "${componentName}" under property "${name}"`);
     }
-
     const version = versions[name];
     logger.always(version);
   };
-
   const defaultVersions = {
     package: undefined,
     binary: undefined,
@@ -203,35 +169,31 @@ function showVersions(args) {
     } else {
       reportAllVersions(versions);
     }
-
     process.exit(0);
   }).catch(util.logErrorExit1);
 }
-
 const createProgram = () => {
-  const program = new commander.Command(); // bug in commander not printing name
-  // in usage help docs
+  const program = new commander.Command();
 
+  // bug in commander not printing name
+  // in usage help docs
   program._name = 'cypress';
   program.usage('<command> [options]');
   return program;
 };
-
 const 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('browser')).option('--ci-build-id <id>', text('ciBuildId')).option('--component', text('component')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('--e2e', text('e2e')).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);
 };
-
 const addCypressOpenCommand = program => {
   return program.command('open').usage('[options]').description('Opens Cypress in the interactive GUI.').option('-b, --browser <browser-path>', text('browser')).option('--component', text('component')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('--e2e', text('e2e')).option('-e, --env <env>', text('env')).option('--global', text('global')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('--dev', text('dev'), coerceFalse);
 };
-
 const maybeAddInspectFlags = program => {
   if (process.argv.includes('--dev')) {
     return program.option('--inspect', 'Node option').option('--inspect-brk', 'Node option');
   }
-
   return program;
 };
+
 /**
  * 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
@@ -239,22 +201,18 @@ const maybeAddInspectFlags = program => {
  *
  * Returns a clone of the original object.
  */
-
-
 const castCypressOptions = opts => {
   // only properties that have type "string | false" in our TS definition
   // require special handling, because CLI parsing takes care of purely
   // boolean arguments
-  const castOpts = { ...opts
+  const castOpts = {
+    ...opts
   };
-
   if (_.has(opts, 'port')) {
     castOpts.port = coerceAnyStringToInt(opts.port);
   }
-
   return castOpts;
 };
-
 module.exports = {
   /**
    * Parses `cypress run` command line option array into an object
@@ -267,11 +225,11 @@ module.exports = {
     return new Promise((resolve, reject) => {
       if (!Array.isArray(args)) {
         return reject(new Error('Expected array of arguments'));
-      } // make a copy of the input arguments array
+      }
+
+      // 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
-
-
       const cliArgs = args[0] === 'cypress' ? [...args.slice(1)] : [...args];
       cliArgs.unshift(null, null);
       debug('creating program parser');
@@ -288,7 +246,6 @@ module.exports = {
       program.parse(cliArgs);
     });
   },
-
   /**
    * Parses `cypress open` command line option array into an object
    * with options that you can feed into cy.openModeSystemTest test calls
@@ -300,11 +257,11 @@ module.exports = {
     return new Promise((resolve, reject) => {
       if (!Array.isArray(args)) {
         return reject(new Error('Expected array of arguments'));
-      } // make a copy of the input arguments array
+      }
+
+      // 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
-
-
       const cliArgs = args[0] === 'cypress' ? [...args.slice(1)] : [...args];
       cliArgs.unshift(null, null);
       debug('creating program parser');
@@ -321,7 +278,6 @@ module.exports = {
       program.parse(cliArgs);
     });
   },
-
   /**
    * Parses the command line and kicks off Cypress process.
    */
@@ -329,12 +285,10 @@ module.exports = {
     if (!args) {
       args = process.argv;
     }
-
     const {
       CYPRESS_INTERNAL_ENV,
       CYPRESS_DOWNLOAD_USE_CA
     } = process.env;
-
     if (process.env.CYPRESS_DOWNLOAD_USE_CA) {
       let msg = `
         ${logSymbols.warning} Warning: It looks like you're setting CYPRESS_DOWNLOAD_USE_CA=${CYPRESS_DOWNLOAD_USE_CA}
@@ -347,12 +301,10 @@ module.exports = {
       logger.warn(stripIndent(msg));
       logger.log();
     }
-
     if (!util.isValidCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {
       debug('invalid CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);
       return errors.exitWithError(errors.errors.invalidCypressEnv)(`CYPRESS_INTERNAL_ENV=${CYPRESS_INTERNAL_ENV}`);
     }
-
     if (util.isNonProductionCypressInternalEnvValue(CYPRESS_INTERNAL_ENV)) {
       debug('non-production CYPRESS_INTERNAL_ENV value', CYPRESS_INTERNAL_ENV);
       let msg = `
@@ -366,7 +318,6 @@ module.exports = {
       logger.warn(stripIndent(msg));
       logger.log();
     }
-
     const program = createProgram();
     program.command('help').description('Shows CLI help and exits').action(() => {
       program.help();
@@ -376,12 +327,10 @@ module.exports = {
     });
     maybeAddInspectFlags(addCypressOpenCommand(program)).action(opts => {
       debug('opening Cypress');
-
       require('./exec/open').start(util.parseOpts(opts)).then(util.exit).catch(util.logErrorExit1);
     });
     maybeAddInspectFlags(addCypressRunCommand(program)).action((...fnArgs) => {
       debug('running Cypress with args %o', fnArgs);
-
       require('./exec/run').start(parseVariableOpts(fnArgs, args)).then(util.exit).catch(util.logErrorExit1);
     });
     program.command('open-ct').usage('[options]').description('Opens Cypress component testing interactive mode. Deprecated: use "open --component"').option('-b, --browser <browser-path>', text('browser')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-e, --env <env>', text('env')).option('--global', text('global')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('--dev', text('dev'), coerceFalse).action(opts => {
@@ -394,8 +343,8 @@ module.exports = {
       logger.warn();
       logger.warn(stripIndent(msg));
       logger.warn();
-
-      require('./exec/open').start({ ...util.parseOpts(opts),
+      require('./exec/open').start({
+        ...util.parseOpts(opts),
         testingType: 'component'
       }).then(util.exit).catch(util.logErrorExit1);
     });
@@ -408,8 +357,8 @@ module.exports = {
       logger.warn();
       logger.warn(stripIndent(msg));
       logger.warn();
-
-      require('./exec/run').start({ ...util.parseOpts(opts),
+      require('./exec/run').start({
+        ...util.parseOpts(opts),
         testingType: 'component'
       }).then(util.exit).catch(util.logErrorExit1);
     });
@@ -422,9 +371,7 @@ module.exports = {
         welcomeMessage: false
       };
       const parsedOpts = util.parseOpts(opts);
-
       const options = _.extend(parsedOpts, defaultOpts);
-
       require('./tasks/verify').start(options).catch(util.logErrorExit1);
     });
     program.command('cache').usage('[command]').description('Manages the Cypress binary cache').option('list', text('cacheList')).option('path', text('cachePath')).option('clear', text('cacheClear')).option('prune', text('cachePrune')).option('--size', text('cacheSize')).action(function (opts, args) {
@@ -432,13 +379,10 @@ module.exports = {
         this.outputHelp();
         util.exit(1);
       }
-
       const [command] = args;
-
       if (!_.includes(['list', 'path', 'clear', 'prune'], command)) {
         unknownOption.call(this, `cache ${command}`, 'command');
       }
-
       if (command === 'list') {
         debug('cache command %o', {
           command,
@@ -454,29 +398,28 @@ module.exports = {
           util.logErrorExit1(e);
         });
       }
-
       cache[command]();
     });
     program.command('info').usage('[command]').description('Prints Cypress and system information').option('--dev', text('dev'), coerceFalse).action(opts => {
       require('./exec/info').start(opts).then(util.exit).catch(util.logErrorExit1);
     });
     debug('cli starts with arguments %j', args);
-    util.printNodeOptions(); // if there are no arguments
+    util.printNodeOptions();
 
+    // if there are no arguments
     if (args.length <= 2) {
       debug('printing help');
-      program.help(); // exits
+      program.help();
+      // exits
     }
 
     const firstCommand = args[2];
-
     if (!_.includes(knownCommands, firstCommand)) {
       debug('unknown command %s', firstCommand);
       logger.error('Unknown command', `"${firstCommand}"`);
       program.outputHelp();
       return util.exit(1);
     }
-
     if (includesVersion(args)) {
       // commander 2.11.0 changes behavior
       // and now does not understand top level options
@@ -484,13 +427,12 @@ module.exports = {
       // so we have to manually catch '-v, --version'
       return showVersions(args);
     }
-
     debug('program parsing arguments');
     return program.parse(args);
   }
+};
 
-}; // @ts-ignore
-
+// @ts-ignore
 if (!module.parent) {
   logger.error('This CLI module should be required from another Node module');
   logger.error('and not executed directly');

package/lib/cypress.js

@@ -1,20 +1,14 @@
 "use strict";
 
 // https://github.com/cypress-io/cypress/issues/316
-const Promise = require('bluebird');
 
+const Promise = require('bluebird');
 const tmp = Promise.promisifyAll(require('tmp'));
-
 const fs = require('./fs');
-
 const open = require('./exec/open');
-
 const run = require('./exec/run');
-
 const util = require('./util');
-
 const cli = require('./cli');
-
 const cypressModuleApi = {
   /**
    * Opens Cypress GUI
@@ -24,7 +18,6 @@ const cypressModuleApi = {
     options = util.normalizeModuleOptions(options);
     return open.start(options);
   },
-
   /**
    * Runs Cypress tests in the current project
    * @see https://on.cypress.io/module-api#cypress-run
@@ -33,7 +26,6 @@ const cypressModuleApi = {
     if (!run.isValidProject(options.project)) {
       return Promise.reject(new Error(`Invalid project path parameter: ${options.project}`));
     }
-
     options = util.normalizeModuleOptions(options);
     tmp.setGracefulCleanup();
     return tmp.fileAsync().then(outputPath => {
@@ -49,13 +41,11 @@ const cypressModuleApi = {
               message: 'Could not find Cypress test run results'
             };
           }
-
           return output;
         });
       });
     });
   },
-
   cli: {
     /**
      * Parses CLI arguments into an object that you can pass to "cypress.run"
@@ -70,9 +60,7 @@ const cypressModuleApi = {
     parseRunArguments(args) {
       return cli.parseRunCommand(args);
     }
-
   },
-
   /**
    * Provides automatic code completion for configuration in many popular code editors.
    * While it's not strictly necessary for Cypress to parse your configuration, we
@@ -89,6 +77,5 @@ const cypressModuleApi = {
   defineConfig(config) {
     return config;
   }
-
 };
 module.exports = cypressModuleApi;