Versioning (#94)

* moved to pure versioning

Author: AlexGalichenko

docusaurus.config.js

@@ -40,6 +40,8 @@ const config = {
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
         docs: {
+          lastVersion: '2x',
+          includeCurrentVersion: false,
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
@@ -77,6 +79,11 @@ const config = {
             position: 'right',
             className: 'header-github-link',
             'aria-label': 'GitHub repository'
+          },
+          {
+            type: 'docsVersionDropdown',
+            position: 'left',
+            dropdownActiveClassDisabled: true,
           }
         ],
       },

docs/Formatters/_category_.json renamed to versioned_docs/version-1x/Formatters/_category_.json

@@ -5,7 +5,7 @@ sidebar_position: 2
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Page Object v1
+# Page Object
 Framework provides capability to call getElement method from po object that resolves plain-english selector and return element or array of elements.
 <Tabs>
   <TabItem value="js" label="JavaScript" default>

docs/Formatters/console-formatter.md renamed to versioned_docs/version-1x/Formatters/console-formatter.md

@@ -50,19 +50,19 @@ This extension contributes the following settings:
 ## How To Use
 
 ### Test Explorer
-![](../../static/img/test_explorer.png)
+![](../../../static/img/test_explorer.png)
 
 ### Page Object Explorer
 Click the copy icon to copy qavajs path
-![](../../static/img/po_explorer.png)
+![](../../../static/img/po_explorer.png)
 
 ### Page Object Autocomplete
 Type ?
-![](../../static/img/po_autocomplete.png)
+![](../../../static/img/po_autocomplete.png)
 
 ### Constants Autocomplete
 Type $
-![](../../static/img/memory_autocomplete.png)
+![](../../../static/img/memory_autocomplete.png)
 
 ## Known Issues and Limitation
 

docs/Formatters/html-formatter.md renamed to versioned_docs/version-1x/Formatters/html-formatter.md

@@ -10,6 +10,6 @@ First, install webstorm-adapter package
 Then create new run configuration template and repoint cucumberjs package to @qavajs/webstorm-adapter.
 Optionally, set additional qavajs arguments (like config, profile, etc)
 
-![img.png](../../static/img/webstorm.png)
+![img.png](../../../static/img/webstorm.png)
 
 In case you are using typescript to run, you need to change nodejs executable to ts-node installation

docs/Formatters/junit-formatter.md renamed to versioned_docs/version-1x/Formatters/junit-formatter.md

@@ -1,5 +1,5 @@
 {
-  "label": "Steps v1",
+  "label": "Steps",
   "position": 30,
   "link": {
     "type": "generated-index",

docs/Formatters/report-portal.md renamed to versioned_docs/version-1x/Formatters/report-portal.md

@@ -2,7 +2,7 @@
 sidebar_position: 7
 ---
 
-# @qavajs/steps-accessibility v1
+# @qavajs/steps-accessibility
 Steps to perform accessibility checks using axe library.
 Library can work on top of playwright and webdriverio drivers
 

docs/Formatters/xray-formatter.md renamed to versioned_docs/version-1x/Formatters/xray-formatter.md

@@ -2,7 +2,7 @@
 sidebar_position: 5
 ---
 
-# @qavajs/steps-files v1
+# @qavajs/steps-files
 Step library to work with file system
 
 ## Installation

docs/Guides/_category_.json renamed to versioned_docs/version-1x/Guides/_category_.json

@@ -2,7 +2,7 @@
 sidebar_position: 8
 ---
 
-# @qavajs/steps-gmail v1
+# @qavajs/steps-gmail
 Step library to test emails via gmail client
 
 ## Installation

docs/Guides/composing-steps.mdx renamed to versioned_docs/version-1x/Guides/composing-steps.mdx

@@ -2,7 +2,7 @@
 sidebar_position: 8
 ---
 
-# @qavajs/steps-lighthouse v1
+# @qavajs/steps-lighthouse
 Steps to perform lighthouse audit.
 Library can work on top of playwright and webdriverio drivers
 

docs/Guides/memory.md renamed to versioned_docs/version-1x/Guides/memory.md

@@ -2,8 +2,8 @@
 sidebar_position: 4
 ---
 
-# @qavajs/steps-memory v1
-Steps to work with memory module
+# @qavajs/steps-memory
+Steps to work with memory module and test data
 ## Installation
 ```
 npm install @qavajs/steps-memory@1

docs/Guides/page-object-v1.mdx renamed to versioned_docs/version-1x/Guides/page-object.mdx

@@ -2,10 +2,7 @@
 sidebar_position: 1
 ---
 
-# @qavajs/steps-playwright v1
-Step library to work with playwright using DSL page object
-
-It is docs for qavajs v2. If you are looking docs for v1 go to [(v2 docs)](../Steps/playwright-v2.md)
+# @qavajs/steps-playwright
 
 ## Installation
 ```
@@ -17,7 +14,7 @@ Playwright steps provide a couple of additional configuration properties
 | Name         | Type     | Description                                                                     | Default |
 |--------------|----------|---------------------------------------------------------------------------------|---------|
 | `browser`    | `object` | object describing playwright config                                             | `{}`    |
-| `pageObject` | `object` | instance of page object definitions  [(page object)](../Guides/page-object-v1.mdx) | `{}`    |
+| `pageObject` | `object` | instance of page object definitions  [(page object)](../../../docs/Guides/page-object-v1.mdx) | `{}`    |
 
 ```javascript
 const App = require('./page_object');

docs/Guides/parallel.md renamed to versioned_docs/version-1x/Guides/parallel.md

@@ -2,7 +2,7 @@
 sidebar_position: 6
 ---
 
-# @qavajs/steps-sql v1
+# @qavajs/steps-sql
 Step library to work with relational databases
 
 ## Installation

docs/Guides/typescript.md renamed to versioned_docs/version-1x/Guides/typescript.md

@@ -2,7 +2,7 @@
 sidebar_position: 10
 ---
 
-# @qavajs/steps-visual-testing v1
+# @qavajs/steps-visual-testing
 Step library to perform visual testing using pixelmatch library
 
 ## Installation

docs/Guides/validation.mdx renamed to versioned_docs/version-1x/Guides/validation.mdx

@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# @qavajs/steps-wdio v1
+# @qavajs/steps-wdio
 Step library to work with webdriverio using DSL page object
 ## Installation
 ```
@@ -14,7 +14,7 @@ wdio steps provide additional configuration properties
 | Name         | Type     | Description                                                                     | Default |
 |--------------|----------|---------------------------------------------------------------------------------|---------|
 | `browser`    | `object` | object describing wdio config                                                   | `{}`    |
-| `pageObject` | `object` | instance of page object definitions  [(page object)](../Guides/page-object-v1.mdx) | `{}`    |
+| `pageObject` | `object` | instance of page object definitions  [(page object)](../../../docs/Guides/page-object-v1.mdx) | `{}`    |
 
 ```javascript
 const App = require('./page_object');

docs/Guides/vscode.md renamed to versioned_docs/version-1x/Guides/vscode.md

@@ -0,0 +1,146 @@
+---
+sidebar_position: 1
+---
+
+# Getting Started
+
+The **qavajs** is a modular test automation framework designed to minimize setup time and streamline the development of test scripts. It incorporates the best test automation tools and practices into a single whole. The framework achieves efficiency through its built-in page object engine and ready-to-use sets of domain-agnostic step definitions suitable for both API and UI testing of the web and native mobile applications. Additionally, **qavajs** provides out of the box integration with ReportPortal, Mobitru, and the Xray and many more.
+
+Next, you will be shown how to build your own low-code test automation framework with the **qavajs**.
+
+### 📦 Installation from scratch
+Once you have set up a clear Node.js project, run the command 
+```bash
+npm init @qavajs
+``` 
+to launch the CLI application. This will configure qavajs and install the necessary modules for your testing purposes. After the process is completed, a config.ts (or config.js) file will be generated in the project's root directory, which will be used to configure test execution.
+
+### 👨‍💻 Test development
+As the **qavajs** based on the Cucumber the test scripts are written in [Gherkin](https://cucumber.io/docs/gherkin/reference/) language of both built-in steps and those you will create yourself.
+With years of experience across various domains, we have implemented [numerous packages](https://github.com/orgs/qavajs/repositories?q=steps&type=all) of step definitions that you can utilize.
+```gherkin
+Feature: Wikipedia
+
+  @wikipedia
+  Scenario Outline: Search in wikipedia (<term>)
+    Given I open '$wikipediaUrl' url
+    When I type '<term>' to 'Wikipedia > Search Input'
+    And I click 'Wikipedia > Search Button'
+    And I expect text of 'Wikipedia Article > Title' equals '<term>'
+    And I expect text of 'Wikipedia Article > Title' not to contain 'Python'
+    And I expect 'Wikipedia Article > Title' to be visible
+    And I expect 'Wikipedia Article > Title' to be visible
+
+    Examples:
+      | term       |
+      | JavaScript |
+      | Java       |
+```
+It is worth mentioning the expression **'$wikipediaUrl'** in the example above starting with '**\$**' interpreted as a **qavajs** memory variable whose value is taken from the Memory class instance in runtime. [More details](https://qavajs.github.io/docs/Guides/memory).  
+Another feature is a locator alias expression like **'Wikipedia > Search Input'** separated by the '**\>**' sign that describes hierarchic page structure. See how [to organize your page object](https://qavajs.github.io/docs/Guides/page-object-v2).
+
+### 🛠️ Configuration
+In addition to the default features of Cucumber [config file](https://github.com/cucumber/cucumber-js/blob/main/docs/configuration.md#options) the **qavajs** config implements following [capabilities](https://github.com/qavajs/core/blob/main/src/IQavajsConfig.ts) to provide the advanced flexibility.
+
+### 🔬 Test execution
+If you have the basic config `npx qavajs` will launch test execution.  
+To specify custom path to the config file use `npx qavajs run --config <config>`.  
+In case if your config exports an object with multiple properties, you can specify which property to read `npx qavajs run --profile <profile>`.
+
+### 🛠️ Override memory values
+In case if tests need to be run with updated memory value they can be passed via CLI (e.g run scenarios on some other url)
+It can be done by passing `--memory-values` parameter which is JSON with params that need to be overridden. 
+For instance, to override `$url` value:
+
+```bash
+npx qavajs run --config config.ts --memory-values '{"url": "https://github.com"}'
+```
+
+### 🛠️ Pass CLI params to workers
+All params that you passed to qavajs cli will be available in `CLI_ARGV` environment variable in all child workers.
+
+### 🛠️ Test Sharding
+qavajs provides ability to shard your tests between different machines. To do so pass `--shard x/y` parameter in CLI,
+where x - current shard, y - total number of shards.
+
+```
+npx qavajs run --config config.js --shard 1/2
+npx qavajs run --config config.js --shard 2/2
+```
+
+### 🛠️ Execute steps from other steps
+It is possible to implement complex logic using built-in qavajs steps via `executeStep` world method
+```typescript
+When('I do smth complex', async function() {
+    await this.executeStep(`I type 'username' to 'Username Input'`);
+    await this.executeStep(`I type 'password' to 'Password Input'`);
+    await this.executeStep(`I click 'Login Button'`);
+    await this.executeStep(`I fill following fields`, new DataTable([
+        [ 'Order', '123' ],
+        [ 'Delivery Location', 'New York' ]
+    ]))
+});
+```
+
+### 🛠️ Override step definition
+`Override` function provides capability to override step implementation and avoid ambiguous exception
+
+```typescript
+import { Override } from '@qavajs/core';
+
+When('I do test', async function () {});
+
+Override('I do test', async function () {
+    console.log('I am overridden');
+});
+```
+
+
+```gherkin
+Feature: feature with fixture
+
+  @pdp
+  Scenario: scenario with fixture
+    When I click 'qavajs T-shirt'
+    And I click 'cart icon'
+    Then I expect 'qavajs T-shirt cart item' to be visible
+```
+
+### 🛠️ Service
+Services is an entities that can execute logic before and after whole test run.
+
+```typescript
+import externalService from './externalService';
+
+export default {
+    service: [
+        {
+            options: {
+                data: 42
+            },
+            before() {
+                console.log(this.options.data);
+            },
+            after(result) {
+                if (!result.success) process.exitCode = 1;
+            }
+        },
+        {
+            options: {
+                data: 42
+            },
+            ...externalService
+        }
+    ]
+}
+```
+There is a one minute-long default timeout for a before and after test logic to prevent entire process from freezing.
+To set up a custom timeout in milliseconds use serviceTimeout property in the config file
+```typescript
+export default {
+    serviceTimeout: 1_200_000
+}
+```
+
+### 📘 Extra
+[Code Examples](https://github.com/qavajs/demo)

docs/Guides/wdio-adapter.md renamed to versioned_docs/version-1x/Guides/wdio-adapter.md

@@ -0,0 +1,8 @@
+{
+  "label": "Formatters",
+  "position": 50,
+  "link": {
+    "type": "generated-index",
+    "description": "Built-in formatters"
+  }
+}

docs/Guides/webstorm.md renamed to versioned_docs/version-1x/Guides/webstorm.md

@@ -0,0 +1,33 @@
+---
+sidebar_position: 2
+---
+
+# @qavajs/console-formatter
+
+Console formatter for cucumber framework
+
+## Installation
+```
+npm install @qavajs/console-formatter
+```
+
+## Configuration
+To use formatter just add formatter section in config file
+
+```javascript
+module.exports = {
+    default: {
+        format: ['@qavajs/console-formatter'],
+        formatOptions: {
+            console: {
+                showLogs: true, //show cucumber logs. Default - false
+                showProgress: true //show progress bar. Default - false
+            }
+        },
+    }
+}
+```
+
+or pass `--format @qavajs/console-formatter in cli`
+
+![](https://raw.githubusercontent.com/qavajs/console-formatter/master/assets/report_example.png)