codeceptjs 3.3.4 → 3.3.5-beta.3

package/docs/wiki/Upgrading-to-CodeceptJS-3.md

@@ -1,7 +1,7 @@
-🚀 CodeceptJS 3 is in beta now. Install it:
+🚀 CodeceptJS 3 is out now. Install it:
 
 ```
-npm i codeceptjs@3.0.0-beta.3
+npm i codeceptjs
 ```
 
 * [COMPLETE CHANGELOG](https://github.com/Codeception/CodeceptJS/blob/codeceptjs-v3.0/CHANGELOG.md#300-beta)

package/lib/command/generate.js

@@ -33,6 +33,7 @@ module.exports.test = function (genPath) {
       type: 'input',
       name: 'feature',
       message: 'Feature which is being tested (ex: account, login, etc)',
+      validate: (val) => !!val,
     },
     {
       type: 'input',
@@ -85,6 +86,7 @@ module.exports.pageObject = function (genPath, opts) {
     type: 'input',
     name: 'name',
     message: `Name of a ${kind} object`,
+    validate: (val) => !!val,
   }, {
     type: 'input',
     name: 'filename',
@@ -156,6 +158,7 @@ module.exports.helper = function (genPath) {
     type: 'input',
     name: 'name',
     message: 'Name of a Helper',
+    validate: (val) => !!val,
   }, {
     type: 'input',
     name: 'filename',

package/lib/command/init.js

@@ -18,8 +18,6 @@ const defaultConfig = {
   output: '',
   helpers: {},
   include: {},
-  bootstrap: null,
-  mocha: {},
 };
 
 const helpers = ['Playwright', 'WebDriver', 'Puppeteer', 'REST', 'GraphQL', 'Appium', 'TestCafe', 'Nightmare'];
@@ -28,10 +26,13 @@ const translations = Object.keys(require('../../translations'));
 const noTranslation = 'English (no localization)';
 translations.unshift(noTranslation);
 
-let packages;
+const packages = [];
+let isTypeScript = false;
+let extension = 'js';
 
 const configHeader = `const { setHeadlessWhen, setCommonPlugins } = require('@codeceptjs/configure');
 
+
 // turn on headless mode when running with HEADLESS=true environment variable
 // export HEADLESS=true && npx codeceptjs run
 setHeadlessWhen(process.env.HEADLESS);
@@ -80,11 +81,23 @@ module.exports = function (initPath) {
     return;
   }
 
+  const typeScriptconfigFile = path.join(testsPath, 'codecept.conf.ts');
+  if (fileExists(typeScriptconfigFile)) {
+    error(`Config is already created at ${typeScriptconfigFile}`);
+    return;
+  }
+
   inquirer.prompt([
+    {
+      name: 'typescript',
+      type: 'confirm',
+      default: false,
+      message: 'Do you plan to write tests in TypeScript?',
+    },
     {
       name: 'tests',
       type: 'input',
-      default: './*_test.js',
+      default: (answers) => `./*_test.${answers.typescript ? 'ts' : 'js'}`,
       message: 'Where are your tests located?',
     },
     {
@@ -105,23 +118,29 @@ module.exports = function (initPath) {
       choices: translations,
     },
   ]).then((result) => {
+    if (result.typescript === true) {
+      isTypeScript = true;
+      extension = isTypeScript === true ? 'ts' : 'js';
+      packages.push('typescript');
+      packages.push('ts-node');
+      packages.push('@types/node');
+    }
+
     const config = defaultConfig;
     config.name = testsPath.split(path.sep).pop();
     config.output = result.output;
 
     config.tests = result.tests;
+    if (isTypeScript) {
+      config.tests = `${config.tests.replace(/\.js$/, `.${extension}`)}`;
+    }
+
     // create a directory tests if it is included in tests path
     const matchResults = config.tests.match(/[^*.]+/);
     if (matchResults) {
       mkdirp.sync(path.join(testsPath, matchResults[0]));
     }
 
-    // append file mask to the end of tests
-    if (!config.tests.match(/\*(.*?)$/)) {
-      config.tests = `${config.tests.replace(/\/+$/, '')}/*_test.js`;
-      print(`Adding default test mask: ${config.tests}`);
-    }
-
     if (result.translation !== noTranslation) config.translation = result.translation;
 
     const helperName = result.helper;
@@ -132,7 +151,7 @@ module.exports = function (initPath) {
     try {
       const Helper = require(`../helper/${helperName}`);
       if (Helper._checkRequirements) {
-        packages = Helper._checkRequirements();
+        packages.concat(Helper._checkRequirements());
       }
 
       if (!Helper._config()) return;
@@ -148,20 +167,28 @@ module.exports = function (initPath) {
 
     const finish = async () => {
       // create steps file by default
-      const stepFile = './steps_file.js';
-      fs.writeFileSync(path.join(testsPath, stepFile), defaultActor);
-      config.include.I = stepFile;
-      print(`Steps file created at ${stepFile}`);
+      if (!isTypeScript) { // no extra step file for typescript (as it doesn't match TS conventions)
+        const stepFile = `./steps_file.${extension}`;
+        fs.writeFileSync(path.join(testsPath, stepFile), defaultActor);
+        config.include.I = stepFile;
+        print(`Steps file created at ${stepFile}`);
+      }
 
-      let configSource = beautify(`exports.config = ${inspect(config, false, 4, false)}`);
+      let configSource = beautify(`/** @type {CodeceptJS.MainConfig} */\nexports.config = ${inspect(config, false, 4, false)}`);
 
       if (require.resolve('@codeceptjs/configure') && isLocal && !initPath) {
         // prepend @codeceptjs/configure only when this module can be required in config
         configSource = configHeader + configSource;
       }
 
-      fs.writeFileSync(configFile, configSource, 'utf-8');
-      print(`Config created at ${configFile}`);
+      if (isTypeScript) {
+        configSource = beautify(`export const config : CodeceptJS.MainConfig = ${inspect(config, false, 4, false)}`);
+        fs.writeFileSync(typeScriptconfigFile, configSource, 'utf-8');
+        print(`Config created at ${typeScriptconfigFile}`);
+      } else {
+        fs.writeFileSync(configFile, configSource, 'utf-8');
+        print(`Config created at ${configFile}`);
+      }
 
       if (config.output) {
         if (!fileExists(config.output)) {
@@ -177,13 +204,41 @@ module.exports = function (initPath) {
           allowJs: true,
         },
       };
-      const jsconfigJson = beautify(JSON.stringify(jsconfig));
-      const jsconfigFile = path.join(testsPath, 'jsconfig.json');
-      if (fileExists(jsconfigFile)) {
-        print(`jsconfig.json already exists at ${jsconfigFile}`);
+
+      const tsconfig = {
+        'ts-node': {
+          files: true,
+        },
+        compilerOptions: {
+          target: 'es2018',
+          lib: ['es2018', 'DOM'],
+          esModuleInterop: true,
+          module: 'commonjs',
+          strictNullChecks: false,
+          types: ['codeceptjs', 'node'],
+          declaration: true,
+          skipLibCheck: true,
+        },
+        exclude: ['node_modules'],
+      };
+
+      if (isTypeScript) {
+        const tsconfigJson = beautify(JSON.stringify(tsconfig));
+        const tsconfigFile = path.join(testsPath, 'tsconfig.json');
+        if (fileExists(tsconfigFile)) {
+          print(`tsconfig.json already exists at ${tsconfigFile}`);
+        } else {
+          fs.writeFileSync(tsconfigFile, tsconfigJson);
+        }
       } else {
-        fs.writeFileSync(jsconfigFile, jsconfigJson);
-        print(`Intellisense enabled in ${jsconfigFile}`);
+        const jsconfigJson = beautify(JSON.stringify(jsconfig));
+        const jsconfigFile = path.join(testsPath, 'jsconfig.json');
+        if (fileExists(jsconfigFile)) {
+          print(`jsconfig.json already exists at ${jsconfigFile}`);
+        } else {
+          fs.writeFileSync(jsconfigFile, jsconfigJson);
+          print(`Intellisense enabled in ${jsconfigFile}`);
+        }
       }
 
       const generateDefinitionsManually = colors.bold(`To get auto-completion support, please generate type definitions: ${colors.green('npx codeceptjs def')}`);
@@ -191,15 +246,6 @@ module.exports = function (initPath) {
       if (packages) {
         try {
           install(packages);
-
-          if (testsPath) {
-            print(generateDefinitionsManually);
-          } else {
-            const { code } = spawn.sync('npx', ['codeceptjs', 'def']);
-            if (code !== 0) {
-              print(generateDefinitionsManually);
-            }
-          }
         } catch (err) {
           print(colors.bold.red(err.toString()));
           print();
@@ -212,14 +258,15 @@ module.exports = function (initPath) {
           print(colors.bold.magenta('Find more information at https://codecept.io'));
           return;
         }
-      } else {
-        try {
-          generateDefinitions(testsPath, {});
-        } catch (err) {
-          print(colors.bold.red('Couldn\'t generate type definitions'));
-          print(colors.red(err.toString()));
-          print('Skipping type definitions...');
-        }
+      }
+
+      try {
+        generateDefinitions(testsPath, {});
+      } catch (err) {
+        print(colors.bold.red('Couldn\'t generate type definitions'));
+        print(colors.red(err.toString()));
+        print('Skipping type definitions...');
+        print(generateDefinitionsManually);
       }
 
       print('');

package/lib/config.js

@@ -5,6 +5,7 @@ const {
   isFile,
   deepMerge,
   deepClone,
+  requireWithFallback,
 } = require('./utils');
 
 const defaultConfig = {
@@ -143,6 +144,14 @@ module.exports = Config;
 function loadConfigFile(configFile) {
   const extensionName = path.extname(configFile);
 
+  if (extensionName === '.ts') {
+    try {
+      require('ts-node/register');
+    } catch (err) {
+      console.log('ts-node package is required to parse codecept.conf.ts config correctly');
+    }
+  }
+
   // .conf.js config file
   if (extensionName === '.js' || extensionName === '.ts' || extensionName === '.cjs') {
     return Config.create(require(configFile).config);

package/lib/helper/Playwright.js

@@ -44,6 +44,46 @@ const {
 } = require('./extras/PlaywrightRestartOpts');
 const { createValueEngine, createDisabledEngine } = require('./extras/PlaywrightPropEngine');
 
+/**
+ * ## Configuration
+ *
+ * This helper should be configured in codecept.conf.js
+ *
+ * @typedef PlaywrightConfig
+ * @type {object}
+ * @prop {string} url - base url of website to be tested
+ * @prop {string} browser - a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
+ * @prop {boolean} [show=false] - show browser window.
+ * @prop {string|boolean} [restart=false] - restart strategy between tests. Possible values:
+ *   * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
+ *   * 'browser' or **true** - closes browser and opens it again between tests.
+ *   * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default before CodeceptJS 3.1
+ * @prop {number} [timeout=1000] - -  [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) in ms of all Playwright actions .
+ * @prop {boolean} [disableScreenshots=false] - don't save screenshot on failure.
+ * @prop {any} [emulate] - browser in device emulation mode.
+ * @prop {boolean} [video=false] - enables video recording for failed tests; videos are saved into `output/videos` folder
+ * @prop {boolean} [trace=false] - record [tracing information](https://playwright.dev/docs/trace-viewer) with screenshots and snapshots.
+ * @prop {boolean} [fullPageScreenshots=false] - make full page screenshots on failure.
+ * @prop {boolean} [uniqueScreenshotNames=false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
+ * @prop {boolean} [keepBrowserState=false] - keep browser state between tests when `restart` is set to 'session'.
+ * @prop {boolean} [keepCookies=false] - keep cookies between tests when `restart` is set to 'session'.
+ * @prop {number} [waitForAction] - how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
+ * @prop {number} [waitForNavigation] - When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/main/docs/api.md#pagewaitfornavigationoptions).
+ * @prop {number} [pressKeyDelay=10] - Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
+ * @prop {number} [getPageTimeout] - config option to set maximum navigation time in milliseconds.
+ * @prop {number} [waitForTimeout] - default wait* timeout in ms. Default: 1000.
+ * @prop {object} [basicAuth] - the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
+ * @prop {string} [windowSize] - default window size. Set a dimension like `640x480`.
+ * @prop {string} [colorScheme] - default color scheme. Possible values: `dark` | `light` | `no-preference`.
+ * @prop {string} [userAgent] - user-agent string.
+ * @prop {string} [locale] - locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ...
+ * @prop {boolean} [manualStart] - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
+ * @prop {object} [chromium] - pass additional chromium options
+ * @prop {object} [electron] - (pass additional electron options
+ * @prop {any} [channel] - (While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge).
+ */
+const config = {};
+
 /**
  * Uses [Playwright](https://github.com/microsoft/playwright) library to run tests inside:
  *
@@ -65,46 +105,14 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  *
  * Using playwright-core package, will prevent the download of browser binaries and allow connecting to an existing browser installation or for connecting to a remote one.
  *
- * ## Configuration
  *
- * This helper should be configured in codecept.json or codecept.conf.js
- *
- * * `url`: base url of website to be tested
- * * `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
- * * `show`: (optional, default: false) - show browser window.
- * * `restart`: (optional, default: false) - restart strategy between tests. Possible values:
- *   * 'context' or **false** - restarts [browser context](https://playwright.dev/docs/api/class-browsercontext) but keeps running browser. Recommended by Playwright team to keep tests isolated.
- *   * 'browser' or **true** - closes browser and opens it again between tests.
- *   * 'session' or 'keep' - keeps browser context and session, but cleans up cookies and localStorage between tests. The fastest option when running tests in windowed mode. Works with `keepCookies` and `keepBrowserState` options. This behavior was default before CodeceptJS 3.1
- * * `timeout`: (optional, default: 1000) -  [timeout](https://playwright.dev/docs/api/class-page#page-set-default-timeout) in ms of all Playwright actions .
- * * `disableScreenshots`: (optional, default: false)  - don't save screenshot on failure.
- * * `emulate`: (optional, default: {}) launch browser in device emulation mode.
- * * `video`: (optional, default: false) enables video recording for failed tests; videos are saved into `output/videos` folder
- * * `trace`: (optional, default: false) record [tracing information](https://playwright.dev/docs/trace-viewer) with screenshots and snapshots.
- * * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
- * * `uniqueScreenshotNames`: (optional, default: false)  - option to prevent screenshot override if you have scenarios with the same name in different suites.
- * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to 'session'.
- * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to 'session'.
- * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
- * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle`. Choose one of those options is possible. See [Playwright API](https://github.com/microsoft/playwright/blob/main/docs/api.md#pagewaitfornavigationoptions).
- * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Playwrights page.type(...) in fillField/appendField
- * * `getPageTimeout` (optional, default: '0') config option to set maximum navigation time in milliseconds.
- * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
- * * `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
- * * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
- * * `colorScheme`: (optional) default color scheme. Possible values: `dark` | `light` | `no-preference`.
- * * `userAgent`: (optional) user-agent string.
- * * `locale`: (optional) locale string. Example: 'en-GB', 'de-DE', 'fr-FR', ...
- * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Playwright"]._startBrowser()`.
- * * `chromium`: (optional) pass additional chromium options
- * * `electron`: (optional) pass additional electron options
- * * `channel`: (optional) While Playwright can operate against the stock Google Chrome and Microsoft Edge browsers available on the machine. In particular, current Playwright version will support Stable and Beta channels of these browsers. See [Google Chrome & Microsoft Edge](https://playwright.dev/docs/browsers/#google-chrome--microsoft-edge).
+ * <!-- configuration -->
  *
  * #### Video Recording Customization
  *
  * By default, video is saved to `output/video` dir. You can customize this path by passing `dir` option to `recordVideo` option.
  *
- * * `video`: enables video recording for failed tests; videos are saved into `output/videos` folder
+ * `video`: enables video recording for failed tests; videos are saved into `output/videos` folder
  * * `keepVideoForPassedTests`: - save videos for passed tests
  * * `recordVideo`: [additional options for videos customization](https://playwright.dev/docs/next/api/class-browser#browser-new-context)
  *
@@ -257,8 +265,6 @@ const { createValueEngine, createDisabledEngine } = require('./extras/Playwright
  * const { browserContext } = this.helpers.Playwright;
  * await browserContext.cookies(); // get current browser context
  * ```
- *
- * ## Methods
  */
 class Playwright extends Helper {
   constructor(config) {

package/lib/helper/Puppeteer.js

@@ -39,6 +39,35 @@ let perfTiming;
 const popupStore = new Popup();
 const consoleLogStore = new Console();
 
+/**
+ * ## Configuration
+ *
+ * This helper should be configured in codecept.conf.js
+ *
+ * @typedef PuppeteerConfig
+ * @type {object}
+ * @prop {string} url - base url of website to be tested
+ * @prop {object} [basicAuth] (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
+ * @prop {boolean} [show] - show Google Chrome window for debug.
+ * @prop {boolean} [restart=true] - restart browser between tests.
+ * @prop {boolean} [disableScreenshots=false]  - don't save screenshot on failure.
+ * @prop {boolean} [fullPageScreenshots=false] - make full page screenshots on failure.
+ * @prop {boolean} [uniqueScreenshotNames=false]  - option to prevent screenshot override if you have scenarios with the same name in different suites.
+ * @prop {boolean} [keepBrowserState=false] - keep browser state between tests when `restart` is set to false.
+ * @prop {boolean} [keepCookies=false] - keep cookies between tests when `restart` is set to false.
+ * @prop {number} [waitForAction=100] - how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
+ * @prop {string} [waitForNavigation=load] - when to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions). Array values are accepted as well.
+ * @prop {number} [pressKeyDelay=10] - delay between key presses in ms. Used when calling Puppeteers page.type(...) in fillField/appendField
+ * @prop {number} [getPageTimeout=30000] - config option to set maximum navigation time in milliseconds. If the timeout is set to 0, then timeout will be disabled.
+ * @prop {number} [waitForTimeout=1000] - default wait* timeout in ms.
+ * @prop {string} [windowSize] - default window size. Set a dimension in format WIDTHxHEIGHT like `640x480`.
+ * @prop {string} [userAgent] - user-agent string.
+ * @prop {boolean} [manualStart=false] - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
+ * @prop {string} [browser=chrome] - can be changed to `firefox` when using [puppeteer-firefox](https://codecept.io/helpers/Puppeteer-firefox).
+ * @prop {object} [chrome] - pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
+*/
+const config = {};
+
 /**
  * Uses [Google Chrome's Puppeteer](https://github.com/GoogleChrome/puppeteer) library to run tests inside headless Chrome.
  * Browser control is executed via DevTools Protocol (instead of Selenium).
@@ -56,30 +85,7 @@ const consoleLogStore = new Console();
  *
  * > Experimental Firefox support [can be activated](https://codecept.io/helpers/Puppeteer-firefox).
  *
- * ## Configuration
- *
- * This helper should be configured in codecept.json or codecept.conf.js
- *
- * * `url`: base url of website to be tested
- * * `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
- * * `show`: (optional, default: false) - show Google Chrome window for debug.
- * * `restart`: (optional, default: true) - restart browser between tests.
- * * `disableScreenshots`: (optional, default: false)  - don't save screenshot on failure.
- * * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
- * * `uniqueScreenshotNames`: (optional, default: false)  - option to prevent screenshot override if you have scenarios with the same name in different suites.
- * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
- * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` is set to false.
- * * `waitForAction`: (optional) how long to wait after click, doubleClick or PressKey actions in ms. Default: 100.
- * * `waitForNavigation`: (optional, default: 'load'). When to consider navigation succeeded. Possible options: `load`, `domcontentloaded`, `networkidle0`, `networkidle2`. See [Puppeteer API](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagewaitfornavigationoptions). Array values are accepted as well.
- * * `pressKeyDelay`: (optional, default: '10'). Delay between key presses in ms. Used when calling Puppeteers page.type(...) in fillField/appendField
- * * `getPageTimeout` (optional, default: '30000') config option to set maximum navigation time in milliseconds. If the timeout is set to 0, then timeout will be disabled.
- * * `waitForTimeout`: (optional) default wait* timeout in ms. Default: 1000.
- * * `windowSize`: (optional) default window size. Set a dimension like `640x480`.
- * * `userAgent`: (optional) user-agent string.
- * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper with `this.helpers["Puppeteer"]._startBrowser()`.
- * * `browser`: (optional, default: chrome) - can be changed to `firefox` when using [puppeteer-firefox](https://codecept.io/helpers/Puppeteer-firefox).
- * * `chrome`: (optional) pass additional [Puppeteer run options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions).
- *
+ * <!-- configuration -->
  *
  * #### Example #1: Wait for 0 network connections.
  *
@@ -192,7 +198,6 @@ class Puppeteer extends Helper {
     super(config);
 
     puppeteer = requireWithFallback('puppeteer', 'puppeteer-core');
-
     // set defaults
     this.isRemoteBrowser = false;
     this.isRunning = false;
@@ -372,22 +377,22 @@ class Puppeteer extends Helper {
   }
 
   /**
-  * Use Puppeteer API inside a test.
-  *
-  * First argument is a description of an action.
-  * Second argument is async function that gets this helper as parameter.
-  *
-  * { [`page`](https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#class-page), [`browser`](https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#class-browser) } from Puppeteer API are available.
-  *
-  * ```js
-  * I.usePuppeteerTo('emulate offline mode', async ({ page }) {
-  *   await page.setOfflineMode(true);
-  * });
-  * ```
-  *
-  * @param {string} description used to show in logs.
-  * @param {function} fn async function that is executed with Puppeteer as argument
-  */
+   * Use Puppeteer API inside a test.
+   *
+   * First argument is a description of an action.
+   * Second argument is async function that gets this helper as parameter.
+   *
+   * { [`page`](https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#class-page), [`browser`](https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#class-browser) } from Puppeteer API are available.
+   *
+   * ```js
+   * I.usePuppeteerTo('emulate offline mode', async ({ page }) {
+   *   await page.setOfflineMode(true);
+   * });
+   * ```
+   *
+   * @param {string} description used to show in logs.
+   * @param {function} fn async function that is executed with Puppeteer as argument
+   */
   usePuppeteerTo(description, fn) {
     return this._useTo(...arguments);
   }
@@ -749,7 +754,8 @@ class Puppeteer extends Helper {
     if (locator) {
       const els = await this._locate(locator);
       assertElementExists(els, locator, 'Element');
-      await els[0]._scrollIntoViewIfNeeded();
+      const el = els[0];
+      await el.evaluate((el) => el.scrollIntoView());
       const elementCoordinates = await getClickablePoint(els[0]);
       await this.executeScript((x, y) => window.scrollBy(x, y), elementCoordinates.x + offsetX, elementCoordinates.y + offsetY);
     } else {
@@ -1069,7 +1075,12 @@ class Puppeteer extends Helper {
       fs.mkdirSync(downloadPath, '0777');
     }
     fsExtra.emptyDirSync(downloadPath);
-    return this.page._client.send('Page.setDownloadBehavior', { behavior: 'allow', downloadPath });
+
+    try {
+      return this.page._client.send('Page.setDownloadBehavior', { behavior: 'allow', downloadPath });
+    } catch (e) {
+      return this.page._client().send('Page.setDownloadBehavior', { behavior: 'allow', downloadPath });
+    }
   }
 
   /**

package/lib/helper/REST.js

@@ -4,18 +4,26 @@ const Secret = require('../secret');
 const Helper = require('../helper');
 const { beautify } = require('../utils');
 
+/**
+ * ## Configuration
+ *
+ * @typedef RESTConfig
+ * @type {object}
+ * @prop {string} endpoint - API base URL
+ * @prop {boolean} [prettyPrintJson=false] - pretty print json for response/request on console logs
+ * @prop {number} [timeout=1000] - timeout for requests in milliseconds. 10000ms by default
+ * @prop {object} [defaultHeaders] - a list of default headers
+ * @prop {function} [onRequest] - a async function which can update request object.
+ * @prop {function} [onResponse] - a async function which can update response object.
+ * @prop {number} [maxUploadFileSize] - set the max content file size in MB when performing api calls.
+ */
+const config = {};
+
 /**
  * REST helper allows to send additional requests to the REST API during acceptance tests.
  * [Axios](https://github.com/axios/axios) library is used to perform requests.
  *
- * ## Configuration
- *
- * * endpoint: API base URL
- * * prettyPrintJson: pretty print json for response/request on console logs
- * * timeout: timeout for requests in milliseconds. 10000ms by default
- * * defaultHeaders: a list of default headers
- * * onRequest: a async function which can update request object.
- * * maxUploadFileSize: set the max content file size in MB when performing api calls.
+ * <!-- configuration -->
  *
  * ## Example
  *
@@ -53,6 +61,8 @@ class REST extends Helper {
       defaultHeaders: {},
       endpoint: '',
       prettyPrintJson: false,
+      onRequest: null,
+      onResponse: null,
     };
 
     if (this.options.maxContentLength) {

package/lib/helper/WebDriver.js

@@ -32,37 +32,43 @@ const SHADOW = 'shadow';
 const webRoot = 'body';
 
 let version;
+
+/**
+ * ## Configuration
+ *
+ * This helper should be configured in codecept.conf.js
+ *
+ * @typedef WebDriverConfig
+ * @type {object}
+ * @prop {string} url - base url of website to be tested.
+ * @prop {string} browser browser in which to perform testing.
+ * @prop {string} [basicAuth] - (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
+ * @prop {string} [host=localhost] - WebDriver host to connect.
+ * @prop {string} [port=4444] - WebDriver port to connect.
+ * @prop {string} [protocol=http] - protocol for WebDriver server.
+ * @prop {string} [path=/wd/hub] - path to WebDriver server,
+ * @prop {boolean} [restart=true] - restart browser between tests.
+ * @prop {boolean} [smartWait=false] - **enables [SmartWait](http://codecept.io/acceptance/#smartwait)**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
+ * @prop {boolean} [disableScreenshots=false] - don't save screenshots on failure.
+ * @prop {boolean} [fullPageScreenshots=false] (optional - make full page screenshots on failure.
+ * @prop {boolean} [uniqueScreenshotNames=false] - option to prevent screenshot override if you have scenarios with the same name in different suites.
+ * @prop {boolean} [keepBrowserState=false] - keep browser state between tests when `restart` is set to false.
+ * @prop {boolean} [keepCookies=false] - keep cookies between tests when `restart` set to false.
+ * @prop {string} [windowSize=window] default window size. Set to `maximize` or a dimension in the format `640x480`.
+ * @prop {number} [waitForTimeout=1000] sets default wait time in *ms* for all `wait*` functions.
+ * @prop {object} [desiredCapabilities] Selenium's [desired capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
+ * @prop {boolean} [manualStart=false] - do not start browser before a test, start it manually inside a helper with `this.helpers["WebDriver"]._startBrowser()`.
+ * @prop {object} [timeouts] [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
+ */
+const config = {};
+
 /**
  * WebDriver helper which wraps [webdriverio](http://webdriver.io/) library to
  * manipulate browser using Selenium WebDriver or PhantomJS.
  *
  * WebDriver requires Selenium Server and ChromeDriver/GeckoDriver to be installed. Those tools can be easily installed via NPM. Please check [Testing with WebDriver](https://codecept.io/webdriver/#testing-with-webdriver) for more details.
  *
- * ### Configuration
- *
- * This helper should be configured in codecept.json or codecept.conf.js
- *
- * * `url`: base url of website to be tested.
- * * `basicAuth`: (optional) the basic authentication to pass to base url. Example: {username: 'username', password: 'password'}
- * * `browser`: browser in which to perform testing.
- * * `host`: (optional, default: localhost) - WebDriver host to connect.
- * * `port`: (optional, default: 4444) - WebDriver port to connect.
- * * `protocol`: (optional, default: http) - protocol for WebDriver server.
- * * `path`: (optional, default: /wd/hub) - path to WebDriver server,
- * * `restart`: (optional, default: true) - restart browser between tests.
- * * `smartWait`: (optional) **enables [SmartWait](http://codecept.io/acceptance/#smartwait)**; wait for additional milliseconds for element to appear. Enable for 5 secs: "smartWait": 5000.
- * * `disableScreenshots`: (optional, default: false) - don't save screenshots on failure.
- * * `fullPageScreenshots` (optional, default: false) - make full page screenshots on failure.
- * * `uniqueScreenshotNames`: (optional, default: false) - option to prevent screenshot override if you have scenarios with the same name in different suites.
- * * `keepBrowserState`: (optional, default: false) - keep browser state between tests when `restart` is set to false.
- * * `keepCookies`: (optional, default: false) - keep cookies between tests when `restart` set to false.
- * * `windowSize`: (optional) default window size. Set to `maximize` or a dimension in the format `640x480`.
- * * `waitForTimeout`: (optional, default: 1000) sets default wait time in *ms* for all `wait*` functions.
- * * `desiredCapabilities`: Selenium's [desired
- * capabilities](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
- * * `manualStart`: (optional, default: false) - do not start browser before a test, start it manually inside a helper
- * with `this.helpers["WebDriver"]._startBrowser()`.
- * * `timeouts`: [WebDriver timeouts](http://webdriver.io/docs/timeouts.html) defined as hash.
+ * <!-- configuration -->
  *
  * Example:
  *
@@ -567,6 +573,9 @@ class WebDriver extends Helper {
       });
     }
 
+    if (this.browser.capabilities && this.browser.capabilities.platformName) {
+      this.browser.capabilities.platformName = this.browser.capabilities.platformName.toLowerCase();
+    }
     return this.browser;
   }
 

package/lib/interfaces/gherkin.js

@@ -91,7 +91,7 @@ module.exports = (text, file) => {
             current[placeholder] = value;
             exampleSteps = exampleSteps.map((step) => {
               step = { ...step };
-              step.text = step.text.replace(`<${placeholder}>`, value);
+              step.text = step.text.split(`<${placeholder}>`).join(value);
               return step;
             });
           }