@serenity-js/serenity-bdd 3.10.2 → 3.10.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.d.ts +29 -7
  3. package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.d.ts.map +1 -1
  4. package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.js +29 -7
  5. package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.js.map +1 -1
  6. package/package.json +5 -5
  7. package/src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts +29 -7
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.10.3](https://github.com/serenity-js/serenity-js/compare/v3.10.2...v3.10.3) (2023-09-15)
7
+
8
+ **Note:** Version bump only for package @serenity-js/serenity-bdd
9
+
10
+
11
+
12
+
13
+
6
14
  ## [3.10.2](https://github.com/serenity-js/serenity-js/compare/v3.10.1...v3.10.2) (2023-09-10)
7
15
 
8
16
 
package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.d.ts CHANGED
@@ -5,7 +5,7 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
5
5
  * to be parsed by [Serenity BDD CLI Reporter](https://github.com/serenity-bdd/serenity-cli)
6
6
  * to produce HTML reports and living documentation.
7
7
  *
8
- * ## Registering the reporter programmatically
8
+ * ## Registering Serenity BDD Reporter programmatically
9
9
  *
10
10
  * ```ts
11
11
  * import { ArtifactArchiver, configure } from '@serenity-js/core';
@@ -19,7 +19,29 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
19
19
  * })
20
20
  * ```
21
21
  *
22
- * ## Registering the reporter using WebdriverIO configuration
22
+ * ## Using Serenity BDD Reporter with Playwright Test
23
+ *
24
+ * ```ts
25
+ * // playwright.config.ts
26
+ * import { devices } from '@playwright/test';
27
+ * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test';
28
+ *
29
+ * const config: PlaywrightTestConfig = {
30
+ *
31
+ * reporter: [
32
+ * [ 'line' ],
33
+ * [ 'html', { open: 'never' } ],
34
+ * [ '@serenity-js/playwright-test', {
35
+ * crew: [
36
+ * '@serenity-js/serenity-bdd',
37
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
38
+ * ]
39
+ * }]
40
+ * ],
41
+ * }
42
+ * ```
43
+ *
44
+ * ## Using Serenity BDD Reporter with WebdriverIO
23
45
  *
24
46
  * ```ts
25
47
  * // wdio.conf.ts
@@ -33,8 +55,8 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
33
55
  *
34
56
  * serenity: {
35
57
  * crew: [
36
- * ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
37
- * new SerenityBDDReporter(),
58
+ * '@serenity-js/serenity-bdd',
59
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
38
60
  * ],
39
61
  * // other Serenity/JS config
40
62
  * },
@@ -42,7 +64,7 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
42
64
  * }
43
65
  * ```
44
66
  *
45
- * ## Registering the reporter using Protractor configuration
67
+ * ## Using Serenity BDD Reporter with Protractor
46
68
  *
47
69
  * ```js
48
70
  * // protractor.conf.js
@@ -56,8 +78,8 @@ import type { DomainEvent } from '@serenity-js/core/lib/events';
56
78
  *
57
79
  * serenity: {
58
80
  * crew: [
59
- * ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
60
- * new SerenityBDDReporter(),
81
+ * '@serenity-js/serenity-bdd',
82
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
61
83
  * ],
62
84
  * // other Serenity/JS config
63
85
  * },
package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"SerenityBDDReporter.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEhE,OAAO,KAAK,EAAE,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAM/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IAO3C,OAAO,CAAC,KAAK,CAAC;IAN1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA8B;IAEzD;;OAEG;gBACiB,KAAK,CAAC,EAAE,KAAK;IAGjC;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAKzC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IA2ClC,OAAO,CAAC,eAAe;CAG1B"}
1
+ {"version":3,"file":"SerenityBDDReporter.d.ts","sourceRoot":"","sources":["../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEhE,OAAO,KAAK,EAAE,WAAW,EAAC,MAAM,8BAA8B,CAAC;AAM/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IAO3C,OAAO,CAAC,KAAK,CAAC;IAN1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA8B;IAEzD;;OAEG;gBACiB,KAAK,CAAC,EAAE,KAAK;IAGjC;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe;IAKzC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IA2ClC,OAAO,CAAC,eAAe;CAG1B"}
package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.js CHANGED
@@ -10,7 +10,7 @@ const processors_1 = require("./processors");
10
10
  * to be parsed by [Serenity BDD CLI Reporter](https://github.com/serenity-bdd/serenity-cli)
11
11
  * to produce HTML reports and living documentation.
12
12
  *
13
- * ## Registering the reporter programmatically
13
+ * ## Registering Serenity BDD Reporter programmatically
14
14
  *
15
15
  * ```ts
16
16
  * import { ArtifactArchiver, configure } from '@serenity-js/core';
@@ -24,7 +24,29 @@ const processors_1 = require("./processors");
24
24
  * })
25
25
  * ```
26
26
  *
27
- * ## Registering the reporter using WebdriverIO configuration
27
+ * ## Using Serenity BDD Reporter with Playwright Test
28
+ *
29
+ * ```ts
30
+ * // playwright.config.ts
31
+ * import { devices } from '@playwright/test';
32
+ * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test';
33
+ *
34
+ * const config: PlaywrightTestConfig = {
35
+ *
36
+ * reporter: [
37
+ * [ 'line' ],
38
+ * [ 'html', { open: 'never' } ],
39
+ * [ '@serenity-js/playwright-test', {
40
+ * crew: [
41
+ * '@serenity-js/serenity-bdd',
42
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
43
+ * ]
44
+ * }]
45
+ * ],
46
+ * }
47
+ * ```
48
+ *
49
+ * ## Using Serenity BDD Reporter with WebdriverIO
28
50
  *
29
51
  * ```ts
30
52
  * // wdio.conf.ts
@@ -38,8 +60,8 @@ const processors_1 = require("./processors");
38
60
  *
39
61
  * serenity: {
40
62
  * crew: [
41
- * ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
42
- * new SerenityBDDReporter(),
63
+ * '@serenity-js/serenity-bdd',
64
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
43
65
  * ],
44
66
  * // other Serenity/JS config
45
67
  * },
@@ -47,7 +69,7 @@ const processors_1 = require("./processors");
47
69
  * }
48
70
  * ```
49
71
  *
50
- * ## Registering the reporter using Protractor configuration
72
+ * ## Using Serenity BDD Reporter with Protractor
51
73
  *
52
74
  * ```js
53
75
  * // protractor.conf.js
@@ -61,8 +83,8 @@ const processors_1 = require("./processors");
61
83
  *
62
84
  * serenity: {
63
85
  * crew: [
64
- * ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
65
- * new SerenityBDDReporter(),
86
+ * '@serenity-js/serenity-bdd',
87
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
66
88
  * ],
67
89
  * // other Serenity/JS config
68
90
  * },
package/lib/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"SerenityBDDReporter.js","sourceRoot":"","sources":["../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts"],"names":[],"mappings":";;;AACA,4CAAsD;AAEtD,yDAA0J;AAC1J,uDAA+E;AAE/E,6CAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,MAAa,mBAAmB;IAI5B;;OAEG;IACH,YAAoB,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;QANhB,gBAAW,GAAG,IAAI,wBAAiB,EAAE,CAAC;QACtC,eAAU,GAAG,IAAI,iCAAoB,EAAE,CAAC;IAMzD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAAY;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAkB;QAEvB,IAAI,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE;YAC7B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACnC;aAEI,IAAI,KAAK,YAAY,wBAAe,EAAE;YACvC,MAAM,EAAE,GAAG,qBAAa,CAAC,MAAM,EAAE,CAAC;YAElC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,IAAI,YAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAC/B,IAAI,mBAAW,CAAC,yCAAyC,CAAC,EAC1D,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;YAEH,IAAI;gBACA,IAAI,CAAC,UAAU;qBACV,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;qBACzB,OAAO,CAAC,MAAM,CAAC,EAAE;oBACd,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,0BAAiB,CACrC,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,QAAQ,EACf,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC;gBAEP,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;aACN;YACD,OAAO,KAAK,EAAE;gBACV,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,6BAAoB,CACxC,KAAK,EACL,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;aACN;SACJ;IACL,CAAC;IAEO,eAAe,CAAC,KAAkB;QACtC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAClE,CAAC;CACJ;AAnED,kDAmEC"}
1
+ {"version":3,"file":"SerenityBDDReporter.js","sourceRoot":"","sources":["../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts"],"names":[],"mappings":";;;AACA,4CAAsD;AAEtD,yDAA0J;AAC1J,uDAA+E;AAE/E,6CAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyFG;AACH,MAAa,mBAAmB;IAI5B;;OAEG;IACH,YAAoB,KAAa;QAAb,UAAK,GAAL,KAAK,CAAQ;QANhB,gBAAW,GAAG,IAAI,wBAAiB,EAAE,CAAC;QACtC,eAAU,GAAG,IAAI,iCAAoB,EAAE,CAAC;IAMzD,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAAY;QACnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,KAAkB;QAEvB,IAAI,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE;YAC7B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACnC;aAEI,IAAI,KAAK,YAAY,wBAAe,EAAE;YACvC,MAAM,EAAE,GAAG,qBAAa,CAAC,MAAM,EAAE,CAAC;YAElC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,IAAI,YAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAC/B,IAAI,mBAAW,CAAC,yCAAyC,CAAC,EAC1D,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;YAEH,IAAI;gBACA,IAAI,CAAC,UAAU;qBACV,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC;qBACzB,OAAO,CAAC,MAAM,CAAC,EAAE;oBACd,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,0BAAiB,CACrC,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,QAAQ,EACf,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC;gBAEP,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,gCAAuB,CAC3C,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;aACN;YACD,OAAO,KAAK,EAAE;gBACV,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,6BAAoB,CACxC,KAAK,EACL,EAAE,EACF,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAC3B,CAAC,CAAC;aACN;SACJ;IACL,CAAC;IAEO,eAAe,CAAC,KAAkB;QACtC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAClE,CAAC;CACJ;AAnED,kDAmEC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@serenity-js/serenity-bdd",
3
- "version": "3.10.2",
3
+ "version": "3.10.3",
4
4
  "description": "Serenity BDD reporter for Serenity/JS",
5
5
  "author": {
6
6
  "name": "Jan Molak",
@@ -45,9 +45,9 @@
45
45
  "node": "^16.13 || ^18.12 || ^20"
46
46
  },
47
47
  "dependencies": {
48
- "@serenity-js/assertions": "3.10.2",
49
- "@serenity-js/core": "3.10.2",
50
- "@serenity-js/rest": "3.10.2",
48
+ "@serenity-js/assertions": "3.10.3",
49
+ "@serenity-js/core": "3.10.3",
50
+ "@serenity-js/rest": "3.10.3",
51
51
  "ansi-regex": "^5.0.1",
52
52
  "axios": "^1.5.0",
53
53
  "chalk": "^4.1.2",
@@ -71,5 +71,5 @@
71
71
  "ts-node": "^10.9.1",
72
72
  "typescript": "5.1.6"
73
73
  },
74
- "gitHead": "6834827fffe5dd8dd3d2f39d2fea2c4039ab1d3d"
74
+ "gitHead": "064edb63e8d4dee447feaab63cf61cbcf6414fdf"
75
75
  }
package/src/stage/crew/serenity-bdd-reporter/SerenityBDDReporter.ts CHANGED
@@ -11,7 +11,7 @@ import { EventQueueProcessors } from './processors';
11
11
  * to be parsed by [Serenity BDD CLI Reporter](https://github.com/serenity-bdd/serenity-cli)
12
12
  * to produce HTML reports and living documentation.
13
13
  *
14
- * ## Registering the reporter programmatically
14
+ * ## Registering Serenity BDD Reporter programmatically
15
15
  *
16
16
  * ```ts
17
17
  * import { ArtifactArchiver, configure } from '@serenity-js/core';
@@ -25,7 +25,29 @@ import { EventQueueProcessors } from './processors';
25
25
  * })
26
26
  * ```
27
27
  *
28
- * ## Registering the reporter using WebdriverIO configuration
28
+ * ## Using Serenity BDD Reporter with Playwright Test
29
+ *
30
+ * ```ts
31
+ * // playwright.config.ts
32
+ * import { devices } from '@playwright/test';
33
+ * import type { PlaywrightTestConfig } from '@serenity-js/playwright-test';
34
+ *
35
+ * const config: PlaywrightTestConfig = {
36
+ *
37
+ * reporter: [
38
+ * [ 'line' ],
39
+ * [ 'html', { open: 'never' } ],
40
+ * [ '@serenity-js/playwright-test', {
41
+ * crew: [
42
+ * '@serenity-js/serenity-bdd',
43
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
44
+ * ]
45
+ * }]
46
+ * ],
47
+ * }
48
+ * ```
49
+ *
50
+ * ## Using Serenity BDD Reporter with WebdriverIO
29
51
  *
30
52
  * ```ts
31
53
  * // wdio.conf.ts
@@ -39,8 +61,8 @@ import { EventQueueProcessors } from './processors';
39
61
  *
40
62
  * serenity: {
41
63
  * crew: [
42
- * ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
43
- * new SerenityBDDReporter(),
64
+ * '@serenity-js/serenity-bdd',
65
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
44
66
  * ],
45
67
  * // other Serenity/JS config
46
68
  * },
@@ -48,7 +70,7 @@ import { EventQueueProcessors } from './processors';
48
70
  * }
49
71
  * ```
50
72
  *
51
- * ## Registering the reporter using Protractor configuration
73
+ * ## Using Serenity BDD Reporter with Protractor
52
74
  *
53
75
  * ```js
54
76
  * // protractor.conf.js
@@ -62,8 +84,8 @@ import { EventQueueProcessors } from './processors';
62
84
  *
63
85
  * serenity: {
64
86
  * crew: [
65
- * ArtifactArchiver.storingArtifactsAt('./target/site/serenity'),
66
- * new SerenityBDDReporter(),
87
+ * '@serenity-js/serenity-bdd',
88
+ * [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
67
89
  * ],
68
90
  * // other Serenity/JS config
69
91
  * },