added docs for custom steps (#103)

Author: AlexGalichenko

versioned_docs/version-2x/Formatters/report-portal.md

@@ -42,7 +42,7 @@ Option `enable` is set to `true` even if it is not defined explicitly in rpConfi
 ## Test Level Attributes
 Test level attributes can be added via cucumber logs e.g. in Before hook
 ```javascript
-const { Before } = require('@cucumber/cucumber');
+const { Before } = require('@qavajs/core');
 
 Before(function () {
     this.log('log from before'); //just log

versioned_docs/version-2x/Guides/composing-steps.mdx

@@ -7,14 +7,40 @@ import TabItem from '@theme/TabItem';
 
 # Composing Steps
 
-### executeStep
+## Custom Steps
+qavajs is based on `@cucumber/cucumber` package so you can use `Given`, `When`, `Then` functions
+enhanced by qavajs parameter types.
+
+<Tabs>
+  <TabItem value="js" label="JavaScript">
+    ```javascript
+    const { When } = require('@qavajs/core');
+
+    When('I select {value} option from {playwrightLocator}', async function(option, locator) {
+        await locator.selectOption(await option.value());
+    });
+    ```
+  </TabItem>
+  <TabItem value="ts" label="TypeScript" default default>
+    ```typescript
+    import { When } from '@qavajs/core';
+    import type { Locator } from '@playwright/test';
+
+    When('I select {value} option from {playwrightLocator}', async function(option: MemoryValue, locator: Locator) {
+        await locator.selectOption(await option.value());
+    });
+    ```
+  </TabItem>
+</Tabs>
+
+## executeStep
 Framework provides capability to implement complex logic via `executeStep` world method
 that allow to call gherkin definitions programmatically
 
 <Tabs>
-  <TabItem value="js" label="JavaScript" default>
+  <TabItem value="js" label="JavaScript">
     ```javascript
-    const { When, DataTable } = require('@cucumber/cucumber');
+    const { When, DataTable } = require('@qavajs/core');
 
     When('I do smth complex', async function() {
         await this.executeStep(`I type 'username' to 'Username Input'`);
@@ -23,14 +49,13 @@ that allow to call gherkin definitions programmatically
         await this.executeStep(`I fill following fields`, new DataTable([
             [ 'Order', '123' ],
             [ 'Delivery Location', 'New York' ]
-        ]))
+        ]));
     });
     ```
   </TabItem>
-  <TabItem value="ts" label="TypeScript">
+  <TabItem value="ts" label="TypeScript" default default>
     ```typescript
-    import { IQavajsWorld } from '@qavajs/core';
-    import { When, DataTable } from '@cucumber/cucumber';
+    import { IQavajsWorld, When, DataTable } from '@qavajs/core';
 
     When('I do smth complex', async function(this: IQavajsWorld) {
         await this.executeStep(`I type 'username' to 'Username Input'`);
@@ -39,13 +64,13 @@ that allow to call gherkin definitions programmatically
         await this.executeStep(`I fill following fields`, new DataTable([
             [ 'Order', '123' ],
             [ 'Delivery Location', 'New York' ]
-        ]))
+        ]));
     });
     ```
   </TabItem>
 </Tabs>
 
-### Template
+## Template
 `Template` provides a way to define step definition using Gherkin language
 
 ```typescript

versioned_docs/version-2x/Guides/memory.mdx

@@ -48,7 +48,7 @@ When('Set memory {value} as {string}', async function(memoryKey, value) {
 You can also access the memory object directly in your step definitions:
 
 <Tabs>
-  <TabItem value="js" label="JavaScript" default>
+  <TabItem value="js" label="JavaScript">
     ```javascript
     const memory = require('@qavajs/memory');
 
@@ -62,7 +62,7 @@ You can also access the memory object directly in your step definitions:
     });
     ```
   </TabItem>
-  <TabItem value="ts" label="TypeScript">
+  <TabItem value="ts" label="TypeScript" default>
     ```typescript
     import memory from '@qavajs/memory';
 
@@ -93,7 +93,7 @@ And I expect text of 'Result Field' to equal '$myNumber'
 You can define constant values and computed functions that can be referenced in your feature files:
 
 <Tabs>
-  <TabItem value="js" label="JavaScript" default>
+  <TabItem value="js" label="JavaScript">
     ```javascript
     // memory.js
     module.exports = {
@@ -111,7 +111,7 @@ You can define constant values and computed functions that can be referenced in
     };
     ```
   </TabItem>
-  <TabItem value="ts" label="TypeScript">
+  <TabItem value="ts" label="TypeScript" default>
     ```typescript
     // memory.ts
     export default {
@@ -181,7 +181,7 @@ When I expect the price to be '\\$42.99'
 For parallel test execution, you can assign unique values for each Cucumber thread using the `parallel` function:
 
 <Tabs>
-  <TabItem value="js" label="JavaScript" default>
+  <TabItem value="js" label="JavaScript">
     ```javascript
     const { parallel } = require('@qavajs/memory/utils');
 
@@ -200,7 +200,7 @@ For parallel test execution, you can assign unique values for each Cucumber thre
     module.exports = Memory;
     ```
   </TabItem>
-  <TabItem value="ts" label="TypeScript">
+  <TabItem value="ts" label="TypeScript" default>
     ```typescript
     import { parallel } from '@qavajs/memory/utils';
 

versioned_docs/version-2x/Guides/page-object.mdx

@@ -506,7 +506,7 @@ You can use page objects in your custom step definitions for more advanced inter
 <Tabs>
   <TabItem value='js' label='JavaScript' default>
     ```javascript
-    const { When, Then } = require('@cucumber/cucumber');
+    const { When, Then } = require('@qavajs/core');
     const { memory } = require('@qavajs/memory');
 
     // For Playwright
@@ -534,7 +534,7 @@ You can use page objects in your custom step definitions for more advanced inter
   </TabItem>
   <TabItem value='ts' label='TypeScript'>
     ```typescript
-    import { When, Then } from '@cucumber/cucumber';
+    import { When, Then } from '@qavajs/core';
     import { memory } from '@qavajs/memory';
     import { Locator } from '@playwright/test';
     import { ChainablePromiseElement } from 'webdriverio';

versioned_docs/version-2x/Guides/validation.mdx

@@ -98,23 +98,33 @@ Then I expect '$object' to match schema '$schema'
 You can also use validations in custom steps
 
 <Tabs>
-  <TabItem value="js" label="JavaScript" default>
+  <TabItem value="js" label="JavaScript">
     ```javascript
-    const { Then } = require('@cucumber/cucumber');
+    const { Then } = require('@qavajs/core');
     const { getValidation } = require('@qavajs/validation');
 
+    Then('I expect the answer {validation} {string}', async function(validate, expected) {
+        const answer = '42';
+        validate(answer, expected);
+    });
+
     Then('I expect the answer {} {string}', async function(validationType, expected) {
         const answer = '42';
         const validate = getValidation(validationType);
         validate(answer, expected);
     });
     ```
   </TabItem>
-  <TabItem value="ts" label="TypeScript">
+  <TabItem value="ts" label="TypeScript" default>
     ```typescript
-    import { Then } from '@cucumber/cucumber';
+    import { Then } from '@qavajs/core';
     import { getValidation } from '@qavajs/validation';
 
+    Then('I expect the answer {validation} {string}', async function(validate: Validation, expected: string) {
+        const answer = '42';
+        validate(answer, expected);
+    });
+
     Then('I expect the answer {} {string}', async function(validationType: string, expected: string) {
         const answer = '42';
         const validate = getValidation(validationType);
@@ -128,23 +138,33 @@ You can also use validations in custom steps
 Validation with auto-retries
 
 <Tabs>
-  <TabItem value="js" label="JavaScript" default>
+  <TabItem value="js" label="JavaScript">
     ```javascript
-    const { Then } = require('@cucumber/cucumber');
+    const { Then } = require('@qavajs/core');
     const { getPollValidation } = require('@qavajs/validation');
 
+    Then('I expect the answer {validation} {string}', async function(validate, expected) {
+        const answer = getAnswer();
+        await validate.poll(answer, expected, { timeout: 2000, interval: 500 });
+    });
+
     Then('I expect the answer {} {string}', async function(validationType, expected) {
         const answer = getAnswer();
         const validate = getPollValidation(validationType);
         await validate(getAnswer, expected, { timeout: 2000, interval: 500 });
     });
     ```
   </TabItem>
-  <TabItem value="ts" label="TypeScript">
+  <TabItem value="ts" label="TypeScript" default>
     ```typescript
-    import { Then } from '@cucumber/cucumber';
+    import { Then } from '@qavajs/core';
     import { getPollValidation } from '@qavajs/validation';
 
+    Then('I expect the answer {validation} {string}', async function(validate: Validation, expected: string) {
+        const answer = getAnswer();
+        await validate.poll(answer, expected);
+    });
+
     Then('I expect the answer {} {string}', async function(validationType: string, expected: string) {
         const answer = getAnswer();
         const validate = getPollValidation(validationType);

versioned_docs/version-2x/StandaloneSolutions/playwright.md

@@ -11,7 +11,7 @@ npm init playwright
 ```              
 
 ```shell
-npm install @cucumber/cucumber @qavajs/playwright @qavajs/playwright-runner-adapter @qavajs/memory
+npm install @qavajs/core @qavajs/playwright @qavajs/playwright-runner-adapter @qavajs/memory
 ```
 
 ## Configuration