codeceptjs 3.0.6 → 3.0.7

package/docs/build/WebDriver.js

@@ -396,6 +396,7 @@ class WebDriver extends Helper {
     this.isRunning = false;
     this.sessionWindows = {};
     this.activeSessionName = '';
+    this.customLocatorStrategies = config.customLocatorStrategies;
 
     this._setConfig(config);
 
@@ -503,6 +504,33 @@ class WebDriver extends Helper {
     }
   }
 
+  _lookupCustomLocator(customStrategy) {
+    if (typeof (this.customLocatorStrategies) !== 'object') {
+      return null;
+    }
+    const strategy = this.customLocatorStrategies[customStrategy];
+    return typeof (strategy) === 'function' ? strategy : null;
+  }
+
+  _isCustomLocator(locator) {
+    const locatorObj = new Locator(locator);
+    if (locatorObj.isCustom()) {
+      const customLocator = this._lookupCustomLocator(locatorObj.type);
+      if (customLocator) {
+        return true;
+      }
+      throw new Error('Please define "customLocatorStrategies" as an Object and the Locator Strategy as a "function".');
+    }
+    return false;
+  }
+
+  async _res(locator) {
+    const res = (this._isShadowLocator(locator) || this._isCustomLocator(locator))
+      ? await this._locate(locator)
+      : await this.$$(withStrictLocator(locator));
+    return res;
+  }
+
   async _startBrowser() {
     try {
       if (this.options.multiremote) {
@@ -530,9 +558,22 @@ class WebDriver extends Helper {
     await this._resizeWindowIfNeeded(this.browser, this.options.windowSize);
 
     this.$$ = this.browser.$$.bind(this.browser);
+
+    if (this._isCustomLocatorStrategyDefined()) {
+      Object.keys(this.customLocatorStrategies).forEach(async (customLocator) => {
+        this.debugSection('Weddriver', `adding custom locator strategy: ${customLocator}`);
+        const locatorFunction = this._lookupCustomLocator(customLocator);
+        this.browser.addLocatorStrategy(customLocator, locatorFunction);
+      });
+    }
+
     return this.browser;
   }
 
+  _isCustomLocatorStrategyDefined() {
+    return this.customLocatorStrategies && Object.keys(this.customLocatorStrategies).length;
+  }
+
   async _stopBrowser() {
     if (this.browser && this.isRunning) await this.browser.deleteSession();
   }
@@ -755,17 +796,34 @@ class WebDriver extends Helper {
     }
 
     if (!this.options.smartWait || !smartWait) {
+      if (this._isCustomLocator(locator)) {
+        const locatorObj = new Locator(locator);
+        return this.browser.custom$$(locatorObj.type, locatorObj.value);
+      }
+
       const els = await this.$$(withStrictLocator(locator));
       return els;
     }
 
     await this._smartWait(locator);
 
+    if (this._isCustomLocator(locator)) {
+      const locatorObj = new Locator(locator);
+      return this.browser.custom$$(locatorObj.type, locatorObj.value);
+    }
+
     const els = await this.$$(withStrictLocator(locator));
     await this.defineTimeout({ implicit: 0 });
     return els;
   }
 
+  _grabCustomLocator(locator) {
+    if (typeof locator === 'string') {
+      locator = new Locator(locator);
+    }
+    return locator.value ? locator.value : locator.custom;
+  }
+
   /**
    * Find a checkbox by providing human readable text:
    *
@@ -1079,6 +1137,7 @@ class WebDriver extends Helper {
    * @param {CodeceptJS.StringOrSecret} value text value to fill.
    * 
    * {{ react }}
+   * {{ custom }}
    *
    */
   async fillField(field, value) {
@@ -1723,7 +1782,7 @@ class WebDriver extends Helper {
    *
    */
   async seeElementInDOM(locator) {
-    const res = await this.$$(withStrictLocator(locator));
+    const res = await this._res(locator);
     return empty('elements').negate(res);
   }
 
@@ -1738,7 +1797,7 @@ class WebDriver extends Helper {
    *
    */
   async dontSeeElementInDOM(locator) {
-    const res = await this.$$(withStrictLocator(locator));
+    const res = await this._res(locator);
     return empty('elements').assert(res);
   }
 
@@ -2787,7 +2846,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${new Locator(locator)}) still not enabled after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) {
         return false;
       }
@@ -2823,7 +2882,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${locator}) still not present on page after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       return res && res.length;
     }, { timeout: aSec * 1000, timeoutMsg: `element (${locator}) still not present on page after ${aSec} sec` });
   }
@@ -3046,9 +3105,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${new Locator(locator)}) still not visible after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = (this._isShadowLocator(locator))
-        ? await this._locate(withStrictLocator(locator))
-        : await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) return false;
       const selected = await forEachAsync(res, async el => el.isDisplayed());
       if (Array.isArray(selected)) {
@@ -3083,7 +3140,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `The number of elements (${new Locator(locator)}) is not ${num} after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) return false;
       let selected = await forEachAsync(res, async el => el.isDisplayed());
 
@@ -3115,7 +3172,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${new Locator(locator)}) still visible after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) return true;
       const selected = await forEachAsync(res, async el => el.isDisplayed());
       return !selected.length;
@@ -3152,7 +3209,7 @@ class WebDriver extends Helper {
     const aSec = sec || this.options.waitForTimeout;
     if (isWebDriver5()) {
       return this.browser.waitUntil(async () => {
-        const res = await this.$$(withStrictLocator(locator));
+        const res = await this._res(locator);
         if (!res || res.length === 0) {
           return true;
         }
@@ -3160,7 +3217,7 @@ class WebDriver extends Helper {
       }, aSec * 1000, `element (${new Locator(locator)}) still on page after ${aSec} sec`);
     }
     return this.browser.waitUntil(async () => {
-      const res = await this.$$(withStrictLocator(locator));
+      const res = await this._res(locator);
       if (!res || res.length === 0) {
         return true;
       }
@@ -3563,12 +3620,9 @@ async function proceedSee(assertType, text, context, strict = false) {
   }
 
   const smartWaitEnabled = assertType === 'assert';
-
   const res = await this._locate(withStrictLocator(context), smartWaitEnabled);
   assertElementExists(res, context);
-
   const selected = await forEachAsync(res, async el => this.browser.getElementText(getElementId(el)));
-
   if (strict) {
     if (Array.isArray(selected) && selected.length !== 0) {
       return selected.map(elText => equals(description)[assertType](text, elText));
@@ -3636,6 +3690,11 @@ async function filterAsync(array, callback) {
 
 async function findClickable(locator, locateFn) {
   locator = new Locator(locator);
+
+  if (this._isCustomLocator(locator)) {
+    return locateFn(locator.value);
+  }
+
   if (locator.isAccessibilityId() && !this.isWeb) return locateFn(locator, true);
   if (!locator.isFuzzy()) return locateFn(locator, true);
 
@@ -3657,6 +3716,10 @@ async function findClickable(locator, locateFn) {
 async function findFields(locator) {
   locator = new Locator(locator);
 
+  if (this._isCustomLocator(locator)) {
+    return this._locate(locator);
+  }
+
   if (locator.isAccessibilityId() && !this.isWeb) return this._locate(locator, true);
   if (!locator.isFuzzy()) return this._locate(locator, true);
 
@@ -3762,6 +3825,10 @@ async function findCheckable(locator, locateFn) {
   let els;
   locator = new Locator(locator);
 
+  if (this._isCustomLocator(locator)) {
+    return locateFn(locator.value);
+  }
+
   if (locator.isAccessibilityId() && !this.isWeb) return locateFn(locator, true);
   if (!locator.isFuzzy()) return locateFn(locator, true);
 
@@ -3807,6 +3874,7 @@ function getElementId(el) {
   if (el.ELEMENT) {
     return el.ELEMENT;
   }
+
   return null;
 }
 

package/docs/changelog.md

@@ -7,13 +7,39 @@ layout: Section
 
 # Releases
 
+## 3.0.7
+
+Documentation fixes:
+* Remove broken link from `Nightmare helper`. See [#2860](https://github.com/codeceptjs/CodeceptJS/issues/2860) by **[Arhell](https://github.com/Arhell)**
+* Fixed broken links in `playwright.md`. See [#2848](https://github.com/codeceptjs/CodeceptJS/issues/2848) by **[johnhoodjr](https://github.com/johnhoodjr)**
+* Fix mocha-multi config example. See [#2881](https://github.com/codeceptjs/CodeceptJS/issues/2881) by **[rimesc](https://github.com/rimesc)**
+* Fix small errors in email documentation file. See [#2884](https://github.com/codeceptjs/CodeceptJS/issues/2884) by **[mkrtchian](https://github.com/mkrtchian)**
+* Improve documentation for `Sharing Data Between Workers` section. See [#2891](https://github.com/codeceptjs/CodeceptJS/issues/2891) by **[ngraf](https://github.com/ngraf)**
+
+Features:
+* **[WebDriver]** Shadow DOM Support for `Webdriver`. See [#2741](https://github.com/codeceptjs/CodeceptJS/issues/2741) by **[gkushang](https://github.com/gkushang)**
+* [Release management] Introduce the versioning automatically, it follows the semantics versioning. See [#2883](https://github.com/codeceptjs/CodeceptJS/issues/2883) by **[PeterNgTr](https://github.com/PeterNgTr)**
+* Adding opts into `Scenario.skip` that it would be useful for building reports. See [#2867](https://github.com/codeceptjs/CodeceptJS/issues/2867) by **[AlexKo4](https://github.com/AlexKo4)**
+* Added support for attaching screenshots to [cucumberJsonReporter](https://github.com/ktryniszewski-mdsol/codeceptjs-cucumber-json-reporter) See [#2888](https://github.com/codeceptjs/CodeceptJS/issues/2888) by **[fijijavis](https://github.com/fijijavis)**
+* Supported config file for `codeceptjs shell` command. See [#2895](https://github.com/codeceptjs/CodeceptJS/issues/2895) by **[PeterNgTr](https://github.com/PeterNgTr)**:
+
+```
+npx codeceptjs shell -c foo.conf.js
+```
+
+Bug fixes:
+* **[GraphQL]** Use a helper-specific instance of Axios to avoid contaminating global defaults. See [#2868](https://github.com/codeceptjs/CodeceptJS/issues/2868) by **[vanvoljg](https://github.com/vanvoljg)**
+* A default system color is used when passing non supported system color when using I.say(). See [#2874](https://github.com/codeceptjs/CodeceptJS/issues/2874) by **[PeterNgTr](https://github.com/PeterNgTr)**
+* **[Playwright]** Avoid the timout due to calling the click on invisible elements. See [#2875](https://github.com/codeceptjs/CodeceptJS/issues/2875) by cbayer97
+
+
 ## 3.0.6
 
-* **[Playwright]** Added `electron` as a browser to config. See [#2834](https://github.com/codeceptjs/CodeceptJS/issues/2834) by **[cbayer97](https://github.com/cbayer97)**  
+* **[Playwright]** Added `electron` as a browser to config. See [#2834](https://github.com/codeceptjs/CodeceptJS/issues/2834) by **[cbayer97](https://github.com/cbayer97)**
 * **[Playwright]** Implemented `launchPersistentContext` to be able to launch persistent remote browsers. See [#2817](https://github.com/codeceptjs/CodeceptJS/issues/2817) by **[brunoqueiros](https://github.com/brunoqueiros)**. Fixes [#2376](https://github.com/codeceptjs/CodeceptJS/issues/2376).
 * Fixed printing logs and stack traces for `run-workers`. See [#2857](https://github.com/codeceptjs/CodeceptJS/issues/2857) by **[haveac1gar](https://github.com/haveac1gar)**. Fixes [#2621](https://github.com/codeceptjs/CodeceptJS/issues/2621), [#2852](https://github.com/codeceptjs/CodeceptJS/issues/2852)
-* Emit custom messages from worker to the main thread. See [#2824](https://github.com/codeceptjs/CodeceptJS/issues/2824) by **[jccguimaraes](https://github.com/jccguimaraes)** 
-* Improved workers processes output. See [#2804](https://github.com/codeceptjs/CodeceptJS/issues/2804) by **[drfiresign](https://github.com/drfiresign)** 
+* Emit custom messages from worker to the main thread. See [#2824](https://github.com/codeceptjs/CodeceptJS/issues/2824) by **[jccguimaraes](https://github.com/jccguimaraes)**
+* Improved workers processes output. See [#2804](https://github.com/codeceptjs/CodeceptJS/issues/2804) by **[drfiresign](https://github.com/drfiresign)**
 * BDD. Added ability to use an array of feature files inside config in `gherkin.features`. See [#2814](https://github.com/codeceptjs/CodeceptJS/issues/2814) by **[jbergeronjr](https://github.com/jbergeronjr)**
 
 ```js
@@ -22,8 +48,8 @@ layout: Section
   "./features/api_features/*.feature"
 ],
 ```
-* Added `getQueueId` to reporter to rerun a specific promise. See [#2837](https://github.com/codeceptjs/CodeceptJS/issues/2837) by **[jonatask](https://github.com/jonatask)** 
-* **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See [#2854](https://github.com/codeceptjs/CodeceptJS/issues/2854) by **[adrielcodeco](https://github.com/adrielcodeco)** 
+* Added `getQueueId` to reporter to rerun a specific promise. See [#2837](https://github.com/codeceptjs/CodeceptJS/issues/2837) by **[jonatask](https://github.com/jonatask)**
+* **Added `fakerTransform` plugin** to use faker data in Gherkin scenarios. See [#2854](https://github.com/codeceptjs/CodeceptJS/issues/2854) by **[adrielcodeco](https://github.com/adrielcodeco)**
 
 ```feature
 Scenario Outline: ...
@@ -35,7 +61,7 @@ Scenario Outline: ...
   | productName          | customer              | email              | anythingMore |
   | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData   |
 ```
-* **[REST]** Use class instance of axios, not the global instance, to avoid contaminating global configuration. [#2846](https://github.com/codeceptjs/CodeceptJS/issues/2846) by **[vanvoljg](https://github.com/vanvoljg)** 
+* **[REST]** Use class instance of axios, not the global instance, to avoid contaminating global configuration. [#2846](https://github.com/codeceptjs/CodeceptJS/issues/2846) by **[vanvoljg](https://github.com/vanvoljg)**
 * **[Appium]** Added `tunnelIdentifier` config option to provide tunnel for SauceLabs. See [#2832](https://github.com/codeceptjs/CodeceptJS/issues/2832) by **[gurjeetbains](https://github.com/gurjeetbains)**
 
 ## 3.0.5
@@ -43,9 +69,9 @@ Scenario Outline: ...
 
 Features:
 
-* **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks **[VikentyShevyrin](https://github.com/VikentyShevyrin)**  
+* **[Official Docker image for CodeceptJS v3](https://hub.docker.com/r/codeceptjs/codeceptjs)**. New Docker image is based on official Playwright image and supports Playwright, Puppeteer, WebDriver engines. Thanks **[VikentyShevyrin](https://github.com/VikentyShevyrin)**
 * Better support for Typescript `codecept.conf.ts` configuration files. See [#2750](https://github.com/codeceptjs/CodeceptJS/issues/2750) by **[elaichenkov](https://github.com/elaichenkov)**
-* Propagate more events for custom parallel script. See [#2796](https://github.com/codeceptjs/CodeceptJS/issues/2796) by **[jccguimaraes](https://github.com/jccguimaraes)** 
+* Propagate more events for custom parallel script. See [#2796](https://github.com/codeceptjs/CodeceptJS/issues/2796) by **[jccguimaraes](https://github.com/jccguimaraes)**
 * [mocha-junit-reporter] Now supports attachments, see documentation for details. See [#2675](https://github.com/codeceptjs/CodeceptJS/issues/2675) by **[Shard](https://github.com/Shard)**
 * CustomLocators interface for TypeScript to extend from LocatorOrString. See [#2798](https://github.com/codeceptjs/CodeceptJS/issues/2798) by **[danielrentz](https://github.com/danielrentz)**
 * **[REST]** Mask sensitive data from log messages.
@@ -144,7 +170,7 @@ Scenario('title', (I, loginPage) => {});
 Scenario('title', ({ I, loginPage }) => {});
 ```
 
-* **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrde guide](https://bit.ly/codecept3Up).
+* **BREAKING** Replaced bootstrap/teardown scripts to accept only functions or async functions. Async function with callback (with done parameter) should be replaced with async/await. [See our upgrade guide](https://bit.ly/codecept3Up).
 * **[TypeScript guide](/typescript)** and [boilerplate project](https://github.com/codeceptjs/typescript-boilerplate)
 * [tryTo](/plugins/#tryto) and [pauseOnFail](/plugins/#pauseOnFail) plugins installed by default
 * Introduced one-line installer:

package/docs/email.md

@@ -6,10 +6,10 @@ title: Email Testing
 # Email Testing
 
 In End 2 End testing we need to interact with emails.
-Email delivery can't tested locally or mocked while testing.
-That's why for an end to end test you need to use a real emails to be sent and real email address to receive that emails.
+Email delivery can't be tested locally or mocked while testing.
+That's why for an end to end test you need real emails to be sent and real email address to receive that emails.
 
-Setting up an email server can be hard. So we recommend to use a [MailSlurp](https://mailslurp.com/) - a service designed for testing emails. It creates disposable mailboxes and provides you an access to those mailboxes via REST API.
+Setting up an email server can be hard. So we recommend to use [MailSlurp](https://mailslurp.com/) - a service designed for testing emails. It creates disposable mailboxes and provides you an access to those mailboxes via REST API.
 
 > You no longer need to open your gmail account in a browser to check for an email!
 
@@ -41,7 +41,7 @@ npx codeceptjs def
 
 ## Creating Mailbox
 
-MailSlurp allows you to create disposable mailboxes. It means that an email address is created for a one test only and is deleted afterwards. So you can be confident that no other emails are received at that address.
+MailSlurp allows you to create disposable mailboxes. It means that an email address is created for one test only and is deleted afterwards. So you can be confident that no other emails are received at that address.
 
 To create a mailbox use `I.haveNewMailbox()` command:
 
@@ -57,7 +57,7 @@ mailbox object contains:
 
 > See [MailSlurp's guide](https://www.mailslurp.com/guides/getting-started/#create-email-addresses) for details.
 
-Mailbox is opened on creation. If you need more than one mailboxes and you want to switch between them use `openMailbox` method:
+Mailbox is opened on creation. If you need more than one mailbox and you want to switch between them use `openMailbox` method:
 
 ```js
 const mailbox1 = await I.haveNewMailbox();
@@ -71,7 +71,7 @@ I.openMailbox(mailbox1);
 
 A last created mailbox will be activated. It means that it will be used by default to check for emails.
 
-After an action that triggers sending an email is performed on a website you should wait for this email to be received.
+After an action that triggers sending an email is performed on a website, you should wait for this email to be received.
 A timeout for waiting an email can be set globally for a helper or for a one call.
 
 Use `waitForLatestEmail` function to return the first email from a mailbox:
@@ -109,7 +109,7 @@ const email = await I.waitForLatestEmail();
 ```
 > Please note, that we use `await` to assign email. This should be declared inside async function
 
-An `email` object contains following fields:
+An `email` object contains the following fields:
 
 * `subject`
 * `for`
@@ -130,7 +130,7 @@ I.amOnPage(url);
 
 ## Assertions
 
-Assertions are performed on the currently opened email.Email is opened on `waitFor` email call, however, you can open an exact email by using `openEmail` function.
+Assertions are performed on the currently opened email. Email is opened on `waitFor` email call, however, you can open an exact email by using `openEmail` function.
 
 ```js
 const email1 = await I.waitForLatestEmail();

package/docs/examples.md

@@ -8,9 +8,9 @@ editLink: false
 
 # Examples
 > Add your own examples to our [Wiki Page](https://github.com/codeceptjs/CodeceptJS/wiki/Examples)
-## [TodoMVC Examples](https://github.com/codeceptjs/examples)
+## [TodoMVC Examples](https://github.com/codecept-js/examples)
 
-![](https://github.com/codeceptjs/examples/raw/master/todo.png)
+![](https://github.com/codecept-js/examples/raw/master/todo.png)
 
 Playground repository where you can run tests in different helpers on a basic single-page website.
 
@@ -155,4 +155,4 @@ Suggestions and improvements are welcome , please raise a ticket in Issue tab.
 * Step by step setup in README
 * Two helpers are added. UI - Puppeteer , API - REST and chai-codeceptJS for assetion
 * ESLint for code check
-* Upcoming : API generic functions , Adaptor design pattern , More utilities
+* Upcoming : API generic functions , Adaptor design pattern , More utilities

package/docs/helpers/MockRequest.md

@@ -56,7 +56,7 @@ helpers: {
    Puppeteer: {
      // regular Puppeteer config here
    },
-   MockRequest: {
+   MockRequestHelper: {
      require: '@codeceptjs/mock-request',
    }
 }
@@ -67,7 +67,7 @@ helpers: {
 ```js
 // sample options
 helpers: {
-  MockRequest: {
+  MockRequestHelper: {
      require: '@codeceptjs/mock-request',
      mode: record,
      recordIfMissing: true,
@@ -115,7 +115,7 @@ helpers: {
    WebDriver: {
      // regular WebDriver config here
    },
-   MockRequest: {
+   MockRequestHelper: {
      require: '@codeceptjs/mock-request',
    }
 }

package/docs/helpers/Playwright.md

@@ -28,7 +28,7 @@ Requires `playwright` package version ^1 to be installed:
 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`. Default: chromium.
+-   `browser`: a browser to test on, either: `chromium`, `firefox`, `webkit`, `electron`. Default: chromium.
 -   `show`:  - show browser window.
 -   `restart`:  - restart browser between tests.
 -   `disableScreenshots`:   - don't save screenshot on failure.
@@ -47,6 +47,7 @@ This helper should be configured in codecept.json or codecept.conf.js
 -   `userAgent`: (optional) user-agent string.
 -   `manualStart`:  - 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
 
 #### Example #1: Wait for 0 network connections.
 
@@ -175,6 +176,14 @@ Add the 'dialog' event listener to a page
 
 -   `page`  
 
+### _contextLocator
+
+Grab Locator if called within Context
+
+#### Parameters
+
+-   `locator` **any** 
+
 ### _getPageUrl
 
 Gets page URL including hash.

package/docs/helpers/WebDriver.md

@@ -873,6 +873,7 @@ I.fillField({css: 'form#login input[name=username]'}, 'John');
 
 This action supports [React locators](https://codecept.io/react#locators)
 
+    {{ custom }}
 
 ### forceClick
 

package/docs/locators.md

@@ -297,8 +297,35 @@ codeceptjs.locator.addFilter((providedLocator, locatorObj) => {
 ```
 New locator strategy is ready to use:
 
+
 ```js
 I.click('=Login');
 ```
 
+#### Custom Strategy Locators
+
+CodeceptJS provides the option to specify custom locators that uses Custom Locator Strategies defined in the WebDriver configuration. It uses the WebDriverIO's [custom$](https://webdriver.io/docs/api/browser/custom$.html) locators internally to locate the elements on page.
+To use the defined Custom Locator Strategy add your custom strategy to your configuration.
+
+```js
+// in codecept.conf.js
+
+const myStrat = (selector) => {
+  return document.querySelectorAll(selector)
+}
+
+// under WebDriver Helpers Configuration
+WebDriver: {
+  ...
+  customLocatorStrategies: {
+    custom: myStrat
+  }
+}
+```
+
+```js
+I.click({custom: 'my-shadow-element-unique-css'})
+```
+
+
 > For more details on locator object see [Locator](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/locator.js) class implementation.

package/docs/nightmare.md

@@ -221,8 +221,3 @@ I.seeAttributeContains('#main img', 'src', '/cat.jpg');
 This sample assertion used `_locate` helper method which searched for elements
 by CSS/XPath or a strict locator. Then `browser.evaluate` method was called to
 use locate found elements on a page and return attribute from the first of them.
-
-## Additional Links
-
-* [Nightmare Tutorial](http://codenroll.it/acceptance-testing-with-codecept-js/) by jploskonka.
-

package/docs/parallel.md

@@ -26,7 +26,7 @@ This command is similar to `run`, however, steps output can't be shown in worker
 
 Each worker spins an instance of CodeceptJS, executes a group of tests, and sends back report to the main process.
 
-By default the tests are assigned one by one to the avaible workers this may lead to multiple execution of `BeforeSuite()`. Use the option `--suites` to assigne the suites one by one to the workers.
+By default the tests are assigned one by one to the available workers this may lead to multiple execution of `BeforeSuite()`. Use the option `--suites` to assigne the suites one by one to the workers.
 
 ```sh
 npx codeceptjs run-workers --suites 2
@@ -196,22 +196,23 @@ workers.on(event.all.result, (status, completedTests, workerStats) => {
 
 ## Sharing Data Between Workers
 
-NodeJS Workers can communicate between each other via messaging system. It may happen that you want to pass some data from one of workers to other. For instance, you may want to share user credentials accross all tests. Data will be appended to a container.
+NodeJS Workers can communicate between each other via messaging system. It may happen that you want to pass some data from one of the workers to other. For instance, you may want to share user credentials accross all tests. Data will be appended to a container.
 
-However, you can't access uninitialized data from a container, so to start, you need to initialized data first. Inside `bootstrap` function of the config we execute the `share` function with `local: true` to initialize value locally:
+However, you can't access uninitialized data from a container, so to start, you need to initialize data first. Inside `bootstrap` function of the config we execute the `share` to initialize value:
 
 
 ```js
 // inside codecept.conf.js
 exports.config = {
   bootstrap() {
-    // append empty userData to container for current worker
-    share({ userData: false }, { local: true });
+    // append empty userData to container
+    share({ userData: false });
   }
 }
 ```
+
 Now each worker has `userData` inside a container. However, it is empty.
-When you obtain real data in one of tests you can this data accross tests. Use `inject` function to access data inside a container:
+When you obtain real data in one of the tests you can now `share` this data accross tests. Use `inject` function to access data inside a container:
 
 ```js
 // get current value of userData
@@ -220,6 +221,12 @@ let { userData } = inject();
 if (!userData) {
   userData = { name: 'user', password: '123456' };
   // now new userData will be shared accross all workers
-  share(userData);
+  share({userData : userData});
 }
 ```
+
+If you want to share data only within same worker, and not across all workers, you need to add option `local: true` every time you run `share` 
+
+```js
+share({ userData: false }, {local: true });
+```

package/docs/playwright.md

@@ -7,7 +7,7 @@ title: Testing with Playwright
 
 Playwright is a Node library to automate the [Chromium](https://www.chromium.org/Home), [WebKit](https://webkit.org/) and [Firefox](https://www.mozilla.org/en-US/firefox/new/) browsers as well as [Electron](https://www.electronjs.org/) apps with a single API. It enables **cross-browser** web automation that is **ever-green**, **capable**, **reliable** and **fast**.
 
-Playwright was built similarly to [Puppeteer](https://github.com/puppeteer/puppeteer), using its API and so is very different in usage. However, Playwright has cross browser support with better design for test automaiton.
+Playwright was built similarly to [Puppeteer](https://github.com/puppeteer/puppeteer), using its API and so is very different in usage. However, Playwright has cross browser support with better design for test automation.
 
 Take a look at a sample test:
 
@@ -270,7 +270,7 @@ Playwright can emulate browsers of mobile devices. Instead of paying for expensi
 
 Device emulation can be enabled in CodeceptJS globally in a config or per session.
 
-Playwright contains a [list of predefined devices](https://github.com/Microsoft/playwright/blob/master/src/deviceDescriptors.ts) to emulate, for instance this is how you can enable iPhone 6 emulation for all tests:
+Playwright contains a [list of predefined devices](https://github.com/microsoft/playwright/blob/master/src/server/deviceDescriptors.js) to emulate, for instance this is how you can enable iPhone 6 emulation for all tests:
 
 ```js
 const { devices } = require('playwright');
@@ -282,7 +282,7 @@ helpers: {
   }
 }
 ```
-To adjust browser settings you can pass [custom options](https://github.com/microsoft/playwright/blob/master/docs/api.md#browsernewcontextoptions)
+To adjust browser settings you can pass [custom options](https://github.com/microsoft/playwright/blob/master/docs/src/api/class-browsercontext.md)
 
 ```js
 helpers: {
@@ -322,7 +322,7 @@ Playwright can be added to GitHub Actions using [official action](https://github
 
 ## Accessing Playwright API
 
-To get [Playwright API](https://github.com/microsoft/playwright/blob/master/docs/api.md) inside a test use `I.usePlaywrightTo` method with a callback.
+To get [Playwright API](https://github.com/microsoft/playwright/tree/master/docs/src/api) inside a test use `I.usePlaywrightTo` method with a callback.
 To keep test readable provide a description of a callback inside the first parameter.
 
 ```js
@@ -385,6 +385,6 @@ async setPermissions() {
 }
 ```
 
-> [▶ Learn more about BrowserContext](https://github.com/microsoft/playwright/blob/master/docs/api.md#class-browsercontext)
+> [▶ Learn more about BrowserContext](https://github.com/microsoft/playwright/blob/master/docs/src/api/class-browsercontext.md)
 
-> [▶ Learn more about Helpers](http://codecept.io/helpers/)
+> [▶ Learn more about Helpers](https://codecept.io/helpers/)

package/docs/reports.md

@@ -352,10 +352,11 @@ Configure mocha-multi with reports that you want:
         }
       },
       "mochawesome": {
-       "stdout": "./output/console.log",
-       "options": {
-         "reportDir": "./output",
-         "reportFilename": "report"
+        "stdout": "./output/console.log",
+        "options": {
+          "reportDir": "./output",
+          "reportFilename": "report"
+        }
       },
       "mocha-junit-reporter": {
         "stdout": "./output/console.log",

package/lib/command/interactive.js

@@ -8,9 +8,11 @@ module.exports = async function (path, options) {
   // Backward compatibility for --profile
   process.profile = options.profile;
   process.env.profile = options.profile;
+  const configFile = options.config;
+
+  const config = getConfig(configFile);
+  const testsPath = getTestRoot(configFile);
 
-  const testsPath = getTestRoot(path);
-  const config = getConfig(testsPath);
   const codecept = new Codecept(config, options);
   codecept.init(testsPath);