@serenity-js/core - npm Package Compare versions

Comparing version 3.7.0 to 3.7.1

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+## [3.7.1](https://github.com/serenity-js/serenity-js/compare/v3.7.0...v3.7.1) (2023-07-22)
+
+**Note:** Version bump only for package @serenity-js/core
+
+
+
+
+
 # [3.7.0](https://github.com/serenity-js/serenity-js/compare/v3.6.1...v3.7.0) (2023-07-20)
@@ -8,0 +16,0 @@

lib/instance.d.ts

@@ -144,15 +144,13 @@ import type { SerenityConfig } from './config';
  *
- * ## Usage with Mocha
+ * ## Usage with Cucumber
  *
  * ```typescript
- *   import { describe, it } from 'mocha';
- *   import { actorCalled } from '@serenity-js/core';
+ * import { actorCalled } from '@serenity-js/core';
+ * import { Given } from '@cucumber/cucumber';
  *
- *   describe('Feature', () => {
- *
- *      it('should have some behaviour', () =>
- *          actorCalled('James').attemptsTo(
- *              // ... activities
- *          ))
- *   })
+ * Given(/(.*?) is a registered user/, async (name: string) => {
+ *   await actorCalled(name).attemptsTo(
+ *     // ... activities
+ *   )
+ * })
  * ```
@@ -163,26 +161,51 @@ *
  * ```typescript
- *   import 'jasmine';
- *   import { actorCalled } from '@serenity-js/core';
+ * import 'jasmine';
+ * import { actorCalled } from '@serenity-js/core';
  *
- *   describe('Feature', () => {
+ * describe('Feature', () => {
  *
- *      it('should have some behaviour', () =>
- *          actorCalled('James').attemptsTo(
- *              // ... activities
- *          ))
- *   })
+ *     it('should have some behaviour', async () {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
  * ```
  *
- * ## Usage with Cucumber
+ * ## Usage with Mocha
  *
  * ```typescript
+ * import { describe, it } from 'mocha';
  * import { actorCalled } from '@serenity-js/core';
- * import { Given } from '@cucumber/cucumber';
  *
- * Given(/(.*?) is a registered user/, (name: string) =>
- *   actorCalled(name).attemptsTo(
- *     // ... activities
- *   ))
+ * describe('Feature', () => {
+ *
+ *     it('should have some behaviour', async () => {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
  * ```
  *
+ * ## Usage with Playwright Test
+ *
+ * When using [Serenity/JS with Playwright Test](/api/playwright-test/), you should use either
+ * the default [`actor`](/api/playwright-test/interface/SerenityFixtures/#actorCalled) fixture
+ * or the injected [`actorCalled`](/api/playwright-test/interface/SerenityFixtures/#actorCalled) function
+ * instead of importing it from `@serenity-js/core`.
+ *
+ * ```typescript
+ * import { describe, it } from '@serenity-js/playwright-test';
+ *
+ * describe('Feature', () => {
+ *
+ *     it('should have some behaviour', async ({ actorCalled }) => {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
+ * ```
+ *
  * ## Learn more
@@ -189,0 +212,0 @@ *

lib/instance.js

@@ -152,15 +152,13 @@ "use strict";
  *
- * ## Usage with Mocha
+ * ## Usage with Cucumber
  *
  * ```typescript
- *   import { describe, it } from 'mocha';
- *   import { actorCalled } from '@serenity-js/core';
+ * import { actorCalled } from '@serenity-js/core';
+ * import { Given } from '@cucumber/cucumber';
  *
- *   describe('Feature', () => {
- *
- *      it('should have some behaviour', () =>
- *          actorCalled('James').attemptsTo(
- *              // ... activities
- *          ))
- *   })
+ * Given(/(.*?) is a registered user/, async (name: string) => {
+ *   await actorCalled(name).attemptsTo(
+ *     // ... activities
+ *   )
+ * })
  * ```
@@ -171,26 +169,51 @@ *
  * ```typescript
- *   import 'jasmine';
- *   import { actorCalled } from '@serenity-js/core';
+ * import 'jasmine';
+ * import { actorCalled } from '@serenity-js/core';
  *
- *   describe('Feature', () => {
+ * describe('Feature', () => {
  *
- *      it('should have some behaviour', () =>
- *          actorCalled('James').attemptsTo(
- *              // ... activities
- *          ))
- *   })
+ *     it('should have some behaviour', async () {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
  * ```
  *
- * ## Usage with Cucumber
+ * ## Usage with Mocha
  *
  * ```typescript
+ * import { describe, it } from 'mocha';
  * import { actorCalled } from '@serenity-js/core';
- * import { Given } from '@cucumber/cucumber';
  *
- * Given(/(.*?) is a registered user/, (name: string) =>
- *   actorCalled(name).attemptsTo(
- *     // ... activities
- *   ))
+ * describe('Feature', () => {
+ *
+ *     it('should have some behaviour', async () => {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
  * ```
  *
+ * ## Usage with Playwright Test
+ *
+ * When using [Serenity/JS with Playwright Test](/api/playwright-test/), you should use either
+ * the default [`actor`](/api/playwright-test/interface/SerenityFixtures/#actorCalled) fixture
+ * or the injected [`actorCalled`](/api/playwright-test/interface/SerenityFixtures/#actorCalled) function
+ * instead of importing it from `@serenity-js/core`.
+ *
+ * ```typescript
+ * import { describe, it } from '@serenity-js/playwright-test';
+ *
+ * describe('Feature', () => {
+ *
+ *     it('should have some behaviour', async ({ actorCalled }) => {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
+ * ```
+ *
  * ## Learn more
@@ -197,0 +220,0 @@ *

package.json

 {
   "name": "@serenity-js/core",
-  "version": "3.7.0",
+  "version": "3.7.1",
   "description": "Serenity/JS Screenplay, reporting engine and core interfaces.",
@@ -74,3 +74,3 @@ "author": {
   },
-  "gitHead": "9a4da7e6080c3628e69bbf01f0efb3cd4e7b0720"
+  "gitHead": "6a67f2edc2872be27b849402a1109f0944e019bb"
 }

src/instance.ts

@@ -155,15 +155,13 @@ import type { SerenityConfig } from './config';
  *
- * ## Usage with Mocha
+ * ## Usage with Cucumber
  *
  * ```typescript
- *   import { describe, it } from 'mocha';
- *   import { actorCalled } from '@serenity-js/core';
+ * import { actorCalled } from '@serenity-js/core';
+ * import { Given } from '@cucumber/cucumber';
  *
- *   describe('Feature', () => {
- *
- *      it('should have some behaviour', () =>
- *          actorCalled('James').attemptsTo(
- *              // ... activities
- *          ))
- *   })
+ * Given(/(.*?) is a registered user/, async (name: string) => {
+ *   await actorCalled(name).attemptsTo(
+ *     // ... activities
+ *   )
+ * })
  * ```
@@ -174,26 +172,51 @@ *
  * ```typescript
- *   import 'jasmine';
- *   import { actorCalled } from '@serenity-js/core';
+ * import 'jasmine';
+ * import { actorCalled } from '@serenity-js/core';
  *
- *   describe('Feature', () => {
+ * describe('Feature', () => {
  *
- *      it('should have some behaviour', () =>
- *          actorCalled('James').attemptsTo(
- *              // ... activities
- *          ))
- *   })
+ *     it('should have some behaviour', async () {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
  * ```
  *
- * ## Usage with Cucumber
+ * ## Usage with Mocha
  *
  * ```typescript
+ * import { describe, it } from 'mocha';
  * import { actorCalled } from '@serenity-js/core';
- * import { Given } from '@cucumber/cucumber';
  *
- * Given(/(.*?) is a registered user/, (name: string) =>
- *   actorCalled(name).attemptsTo(
- *     // ... activities
- *   ))
+ * describe('Feature', () => {
+ *
+ *     it('should have some behaviour', async () => {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
  * ```
  *
+ * ## Usage with Playwright Test
+ *
+ * When using [Serenity/JS with Playwright Test](/api/playwright-test/), you should use either
+ * the default [`actor`](/api/playwright-test/interface/SerenityFixtures/#actorCalled) fixture
+ * or the injected [`actorCalled`](/api/playwright-test/interface/SerenityFixtures/#actorCalled) function
+ * instead of importing it from `@serenity-js/core`.
+ *
+ * ```typescript
+ * import { describe, it } from '@serenity-js/playwright-test';
+ *
+ * describe('Feature', () => {
+ *
+ *     it('should have some behaviour', async ({ actorCalled }) => {
+ *         await actorCalled('James').attemptsTo(
+ *             // ... activities
+ *         )
+ *     })
+ * })
+ * ```
+ *
  * ## Learn more
@@ -200,0 +223,0 @@ *

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1325350

increased by0.18%

Lines of code

26343

increased by0.26%

No dependency changes