Fixed regular expression, formatting and description (inluxc#53)

* testExecutionKey

* update

* fix

* make testExecution optional

* fix regexp

* text fix

* fix

---------

Co-authored-by: Daniil Sugonyaev <daniil.sugonyaev@yolo.com>

Author: coolswood

README.md

@@ -15,8 +15,6 @@ npm i -D playwright-xray
 
 Add reporter to your `playwright.config.ts` configuration file
 
-
-
 ### Cloud version
 
 Authenticate with `client_id` and `client_secret` key.
@@ -26,20 +24,25 @@ Authenticate with `client_id` and `client_secret` key.
 import { PlaywrightTestConfig } from '@playwright/test';
 
 const config: PlaywrightTestConfig = {
-  reporter: [['playwright-xray', { 
-    jira: {
-      url: 'https://your-jira-url',
-      type: 'cloud'
-    },
-    cloud: {
-      client_id: '',
-      client_secret: '',
-    },
-    projectKey: 'JIRA_CODE',
-    testPlan: 'JIRA_CODEXXXXX',
-    debug: false
-  }]],
-}
+  reporter: [
+    [
+      'playwright-xray',
+      {
+        jira: {
+          url: 'https://your-jira-url',
+          type: 'cloud',
+        },
+        cloud: {
+          client_id: '',
+          client_secret: '',
+        },
+        projectKey: 'JIRA_CODE',
+        testPlan: 'JIRA_CODEXXXXX',
+        debug: false,
+      },
+    ],
+  ],
+};
 ```
 
 ### Server version
@@ -51,25 +54,30 @@ Authenticate with `token` key.
 import { PlaywrightTestConfig } from '@playwright/test';
 
 const config: PlaywrightTestConfig = {
-  reporter: [['playwright-xray', { 
-    jira: {
-      url: 'https://your-jira-url',
-      type: 'server'
-    },
-    server: {
-      token: 'YOUR_SERVER_TOKEN'
-    },
-    projectKey: 'JIRA_CODE',
-    testPlan: 'JIRA_CODEXXXXX',
-    debug: false
-  }]],
-}
+  reporter: [
+    [
+      'playwright-xray',
+      {
+        jira: {
+          url: 'https://your-jira-url',
+          type: 'server',
+        },
+        server: {
+          token: 'YOUR_SERVER_TOKEN',
+        },
+        projectKey: 'JIRA_CODE',
+        testPlan: 'JIRA_CODEXXXXX',
+        debug: false,
+      },
+    ],
+  ],
+};
 ```
 
-Also, your playwright tests should include unique ID inside square brackets `[J79]` of your Xray test case:
+Also, your playwright tests should include unique ID `J79` of your Xray test case + `|`:
 
 ```typescript
-// Xray test case ID inside square brackets
+// Xray test case ID + |
 test('J79 | basic test', async ({ page }) => {
   await page.goto('https://playwright.dev/');
   const title = page.locator('.navbar__inner .navbar__title');
@@ -78,72 +86,87 @@ test('J79 | basic test', async ({ page }) => {
 ```
 
 ### Optional config
+
 Is it possible to add some optional values to the Test Execution ticket.
+
 ```typescript
 // playwright.config.ts
 import { PlaywrightTestConfig } from '@playwright/test';
 
 const config: PlaywrightTestConfig = {
-  reporter: [['playwright-xray', { 
-    jira: {
-      url: 'https://your-jira-url',
-      type: 'server'
-    },
-    cloud: {
-      client_id: '',
-      client_secret: '',
-    },
-    server: {
-      token: ''
-    },
-    projectKey: 'JIRA_CODE',
-    testPlan: 'JIRA_CODE-XXX',
-    debug: false,
-    // Optional
-    testExecution: 'JIRA_CODE-YYY',
-    version: 'v1.0',
-    revision: '12345',
-    description: 'This test was executed automatically',
-    testEnvironments: ['dev', 'test'],
-  }]],
-}
+  reporter: [
+    [
+      'playwright-xray',
+      {
+        jira: {
+          url: 'https://your-jira-url',
+          type: 'server',
+        },
+        cloud: {
+          client_id: '',
+          client_secret: '',
+        },
+        server: {
+          token: '',
+        },
+        projectKey: 'JIRA_CODE',
+        testPlan: 'JIRA_CODE-XXX',
+        debug: false,
+        // Optional
+        testExecution: 'JIRA_CODE-YYY',
+        version: 'v1.0',
+        revision: '12345',
+        description: 'This test was executed automatically',
+        testEnvironments: ['dev', 'test'],
+      },
+    ],
+  ],
+};
 ```
 
 ### Proxy
+
 If you use a proxy to access Jira, you need to configure the proxy. This proxy information will be used by Axios to send the results to Jira.
+
 ```typescript
 // playwright.config.ts
 import { PlaywrightTestConfig } from '@playwright/test';
 
 const config: PlaywrightTestConfig = {
-  reporter: [['playwright-xray', { 
-    jira: {
-      url: 'https://your-jira-url',
-      type: 'server'
-    },
-    cloud: {
-      client_id: '',
-      client_secret: '',
-    },
-    server: {
-      token: ''
-    },
-    projectKey: 'JIRA_CODE',
-    testPlan: 'JIRA_CODE-XXX',
-    debug: false,
-    // Optional
-    proxy: {
-      protocol: 'http',
-      host: '0.0.0.0',
-      port: 80,
-      auth: {
-        username: 'USER',
-        password: 'p@$$w0Rd'
-      }
-    }
-  }]],
-}
+  reporter: [
+    [
+      'playwright-xray',
+      {
+        jira: {
+          url: 'https://your-jira-url',
+          type: 'server',
+        },
+        cloud: {
+          client_id: '',
+          client_secret: '',
+        },
+        server: {
+          token: '',
+        },
+        projectKey: 'JIRA_CODE',
+        testPlan: 'JIRA_CODE-XXX',
+        debug: false,
+        // Optional
+        proxy: {
+          protocol: 'http',
+          host: '0.0.0.0',
+          port: 80,
+          auth: {
+            username: 'USER',
+            password: 'p@$$w0Rd',
+          },
+        },
+      },
+    ],
+  ],
+};
 ```
+
 > If your proxy server doesn't need authentication, just omit the `auth` part.
 >
 > If no proxy is configured, Axios is forced to doesn't use proxy.
@@ -154,93 +177,95 @@ Then run your tests with `npx playwright test` command and you'll see the result
 
 ```sh
 -------------------------------------
- 
+
 ⏺  Starting the run with 6 tests
- 
+
 ✅ Chrome | XRAYISSUE-2 | another test
 ✅ Chrome | XRAYISSUE-1 | basic test
 ✅ Firefox | XRAYISSUE-1 | basic test
 ⛔ Chrome | XRAYISSUE-3 | another test
 ⛔ Firefox | XRAYISSUE-2 | another test
 ⛔ Firefox | XRAYISSUE-3 | another test
- 
+
 -------------------------------------
- 
+
 😀 Successfully sending test results to Jira
- 
+
 ⏺  Description:       Tests executed with playwright-xray plugin
 ⏺  Test environments: dev,test
 ⏺  Version:           3.5.2
 ⏺  Revision:          12345
 ⏺  Browsers:          Chrome, Firefox
 ⏺  Test plan:         XRAYISSUE-123
 ⏺  Test execution:    XRAYISSUE-324
-⏺  Test Duration:     25s 
+⏺  Test Duration:     25s
 ⏺  Tests ran:         6
 ⏺  Tests passed:      3
 ⏺  Tests failed:      3
- 
+
 -------------------------------------
- 
+
 ⏺  Test cycle XRAYISSUE-324 has been updated
 👇 Check out the test result
 🔗 https://jira.com/XRAYISSUE-324
- 
+
 -------------------------------------
 ```
 
 And you'll see the result in the Xray:
 
 ![alt text](./assets/xray-result.png)
 
-
 ## Multiple Test Plans
 
 If you need to send report for more than one test plan, you need to create a config file for each test plan.
 Create a folder (e.g. configs) in your project and for each test plan, create a new playwright config file in this folder.
 
-``` ts
+```ts
 // configs/TCK-87.config.ts
 
-import { PlaywrightTestConfig } from "@playwright/test";
-import base from "../playwright.config";
+import { PlaywrightTestConfig } from '@playwright/test';
+import base from '../playwright.config';
 
 const config: PlaywrightTestConfig = {
-	...base,
-	testDir: "../tests",
-	use: {
-		...base.use,
-		headless: true,
-	},
-	reporter: [
-		[
-			"playwright-xray",
-			{
-				jira: {
+  ...base,
+  testDir: '../tests',
+  use: {
+    ...base.use,
+    headless: true,
+  },
+  reporter: [
+    [
+      'playwright-xray',
+      {
+        jira: {
           url: 'https://your-jira-url',
-          type: 'server'
-				},
-				server: {
-					token: 'YOUR_SERVER_TOKEN',
-				},
+          type: 'server',
+        },
+        server: {
+          token: 'YOUR_SERVER_TOKEN',
+        },
         projectKey: 'TCK',
-        testPlan: 'TCK-87'
-			},
-		],
-	],
+        testPlan: 'TCK-87',
+      },
+    ],
+  ],
 };
 export default config;
 ```
+
 Now you can choose which config file you want to use executing the tests, using the command below:
+
 ```
 npx playwright test --config=configs/TCK-87.config.ts
 ```
+
 If no config file is chosen, the default config file "playwright.config.ts" will be used.
 
 ## Notes
 
 - To have the steps imported you have to create then in the test issue itself.
-The steps will be imported by order of execution and inserted into the test.
+  The steps will be imported by order of execution and inserted into the test.
 
 ## License