updated docs for soft assertions and xray (#91)

Author: AlexGalichenko

docs/Formatters/xray-formatter.md

@@ -3,28 +3,25 @@ sidebar_position: 5
 ---
 
 # @qavajs/xray-formatter
+Xray formatter for cucumber framework
 
-Jira Xray formatter for cucumber framework
+### Installation
+To install formatter run
 
-## Installation
-```
-npm install @qavajs/xray-formatter
-```
-      
-## Configuration
-Add to format section in config file
+`npm install @qavajs/xray-formatter`
+
+add to formatter section in config file
 
 cloud configuration:
 ```javascript
 export default {
-    format: [
-        ['@qavajs/xray-formatter', 'report/xray.out']
-    ],
+    format: ['@qavajs/xray-formatter:report/xray.out'],
     formatOptions: {
         xray: {
             client_id: 'client_id', // generated client_id from xray cloud
             client_secret: 'client_secret', // generated client_id from xray client_secret
-            testExecutionKey: 'ABC-12' // test execution jira key to send result
+            testExecutionKey: 'ABC-12', // test execution jira key to send result
+            tagRegexp: 'TEST_(.+)' // optional, parse tag regexp. default /@(.+-\d+)/
         }
     }
 }
@@ -38,24 +35,24 @@ export default {
         xray: {
             endpoint: 'https://your.jira.instance/jira', //jira api endpoint
             client_secret: 'client_secret', // personal access key from jira instance
-            testExecutionKey: 'ABC-12' // test execution jira key to send result
+            testExecutionKey: 'ABC-12', // test execution jira key to send result
+            tagRegexp: 'TEST_(.+)' // optional, parse tag regexp
         }
     }
 }
 ```
 
-## How it works?
-Plugin reads all tags in jira key format (@ABCD-123) and update corresponding scenarios in provided test execution
+### How it works?
+Plugin reads all tags in jira key format (@ABCD-123) or ones that matches `tagRegexp` and update corresponding scenarios in provided test execution
 
-## F.A.Q
+### F.A.Q
 - Does it work with Jira Server?
 
   Yes
 
-- What multiple test automated cases mapped to one xray test case?
+- What if multiple tests are mapped to one xray test case?
 
   Test will get status from last result with corresponding tag
 
-- What multiple xray cases mapped to one test automation case?
-
-  All mapped test cases will get same status
+- What if multiple xray cases are mapped to one test?
+  

docs/Guides/page-object-v2.mdx

@@ -8,43 +8,6 @@ import TabItem from '@theme/TabItem';
 # Page Object v2
 qavajs provides flexible page object model that resolves plain-english selector and return element or array of elements.
 
-<Tabs>
-  <TabItem value="js" label="JavaScript" default>
-    ```javascript
-    const { When } = require('@cucumber/cucumber');
-
-    // playwright
-    When('click {playwrightLocator}'/, async function (locator) {
-        await locator.click();
-    });
-
-    // wdio
-    When('click {wdioLocator}'/, async function (locator) {
-        await locator().click();
-    });
-    ```
-  </TabItem>
-  <TabItem value="ts" label="TypeScript">
-    ```typescript
-    import { When } from '@cucumber/cucumber';
-
-    // playwright
-    When('click {playwrightLocator}'/, async function (locator) {
-        await locator.click();
-    });
-
-    // wdio
-    When('click {wdioLocator}'/, async function (locator) {
-        await locator().click();
-    });
-    ```
-  </TabItem>
-</Tabs>
-
-```gherkin
-When click 'Product > Add To Cart'
-```
-
 ## Create page object
 
 Entry point of page object is class defined as _pageObject_ property in config
@@ -170,3 +133,42 @@ Playwright example:
     ```
   </TabItem>
 </Tabs>
+
+## Using page object in custom steps
+It's possible to use page object in custom step definitions via built-in parameter types `playwrightLocator` and `wdioLocator`
+<Tabs>
+    <TabItem value="js" label="JavaScript" default>
+        ```javascript
+        const { When } = require('@cucumber/cucumber');
+
+        // playwright
+        When('click {playwrightLocator}'/, async function (locator) {
+            await locator.click();
+        });
+
+        // wdio
+        When('click {wdioLocator}'/, async function (locator) {
+            await locator().click();
+        });
+        ```
+    </TabItem>
+    <TabItem value="ts" label="TypeScript">
+        ```typescript
+        import { When } from '@cucumber/cucumber';
+
+        // playwright
+        When('click {playwrightLocator}'/, async function (locator) {
+            await locator.click();
+        });
+
+        // wdio
+        When('click {wdioLocator}'/, async function (locator) {
+            await locator().click();
+        });
+        ```
+    </TabItem>
+</Tabs>
+
+```gherkin
+When click 'Product > Add To Cart'
+```

docs/Modules/soft-assertion.md

@@ -6,21 +6,32 @@ sidebar_position: 2
 Module that allow to use soft asserts in qavajs tests
 
 ## Installation
-```shell
-npm install @qavajs/soft-assertion
-```
+`npm install @qavajs/soft-assertion`
 
 ## Usage
 
-Add module to requireModule and set activation tag (default is @softAssert).
-Soft assertion change behavior of Cucumber and Then steps will not cause test case failure.
+Add module to requireModule.
 ```javascript
 module.exports = {
     default: {
         requireModule: [
-            '@qavajs/soft-assertion'
-        ],
-        softAssertTag: '@yourTag' 
+            '@qavajs/soft-assertion/index.js'
+        ]
     }
 }
 ```
+
+Now you can use `softly` prefix before any expect.
+```gherkin
+Feature: Feature
+
+  Scenario: verify soft assert
+    # first step fails but other steps will not be skipped
+    Then I softly expect '2' to equal '1'
+    # pass
+    And I expect '1' to equal '1'
+    # fail
+    And I expect '2' to equal '1'
+    # skip
+    And I expect '1' to equal '1'
+```

docs/writing-tests.md

@@ -22,8 +22,8 @@ Feature: Wikipedia
 
 In this scenario:
 
-- `Search Input`, `Search Button`, and `Title` are aliases for corresponding [(page objects)](./Guides/page-object-v2.mdx).
-- `$wikipedia` is an alias for a [(constant)](./Guides/memory.md) URL.
+- `Search Input`, `Search Button`, and `Title` are aliases for corresponding [page objects](./Guides/page-object-v2.mdx).
+- `$wikipedia` is an alias for a [constant](./Guides/memory.md) URL.
 
 ## Page Objects
 Define the page objects in the page_object folder: