@serenity-js/playwright 3.10.1 → 3.10.2

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.10.2](https://github.com/serenity-js/serenity-js/compare/v3.10.1...v3.10.2) (2023-09-10)
+
+
+### Bug Fixes
+
+* **core:** updated installation instruction in the README ([ec3f277](https://github.com/serenity-js/serenity-js/commit/ec3f2778334abbd7324497ceaa2df9f0560a103e)), closes [#1915](https://github.com/serenity-js/serenity-js/issues/1915)
+
+
+
+
+
 ## [3.10.1](https://github.com/serenity-js/serenity-js/compare/v3.10.0...v3.10.1) (2023-09-01)
 
 **Note:** Version bump only for package @serenity-js/playwright

package/README.md

@@ -9,9 +9,10 @@
 of complex software systems faster, more collaborative and easier to scale.
 
 ⭐️ Get started with Serenity/JS!
-- [Serenity/JS Handbook](https://serenity-js.org/handbook) and [tutorial](https://serenity-js.org/handbook/web-testing/your-first-web-scenario),
-- [API documentation](https://serenity-js.org/api/core),
-- [Serenity/JS project templates on GitHub](https://serenity-js.org/handbook/getting-started#serenityjs-project-templates).
+- [Serenity/JS web testing tutorial](https://serenity-js.org/handbook/web-testing/your-first-web-scenario)
+- [Serenity/JS Handbook](https://serenity-js.org/handbook) and [Getting Started guides](https://serenity-js.org/handbook/getting-started/)
+- [API documentation](https://serenity-js.org/api/core)
+- [Serenity/JS Project Templates on GitHub](https://serenity-js.org/handbook/getting-started#serenityjs-project-templates)
 
 👋 Join the Serenity/JS Community!
 - Meet other Serenity/JS developers and maintainers on the [Serenity/JS Community chat channel](https://matrix.to/#/#serenity-js:gitter.im),
@@ -29,27 +30,38 @@ for [Playwright](https://playwright.dev/), that helps with testing Web-based app
 To install this module, run the following command in your [Playwright project directory](https://playwright.dev/docs/intro):
 
 ```bash
-npm install --save-dev @serenity-js/{assertions,console-reporter,core,serenity-bdd,web,playwright}
+npm install --save-dev @serenity-js/assertions @serenity-js/console-reporter @serenity-js/core @serenity-js/serenity-bdd @serenity-js/web @serenity-js/playwright
 ```
 
+To learn more about Serenity/JS and how to use it on your project, follow the [Serenity/JS Getting Started guide](https://serenity-js.org/handbook/getting-started/).
+
+## Usage with `@playwright/test`
+
+Follow the [Serenity/JS Getting Started guide for Playwright Test](https://serenity-js.org/handbook/getting-started/serenity-js-with-playwright-test/).
+
+## Usage with Cucumber
+
+Follow the [Serenity/JS configuration guide for Cucumber](https://serenity-js.org/handbook/test-runners/cucumber/)
+and review the [Serenity/JS Cucumber and Playwright Project Template](https://github.com/serenity-js/serenity-js-cucumber-playwright-template).
+
 ### Usage with Mocha
 
 ```typescript
-import { Ensure, equals } from '@serenity-js/assertions';
-import { actorCalled, Actor, ArtifactArchiver, Cast, configure, Duration } from '@serenity-js/core';
-import { ConsoleReporter } from '@serenity-js/console-reporter';
-import { BrowseTheWebWithPlaywright, PlaywrightOptions } from '@serenity-js/playwright';
-import { SerenityBDDReporter } from '@serenity-js/serenity-bdd';
-import { By, Navigate, PageElement, Photographer, TakePhotosOfFailures, Text } from '@serenity-js/web';
+import { Ensure, equals } from '@serenity-js/assertions'
+import { actorCalled, Actor, ArtifactArchiver, Cast, configure, Duration } from '@serenity-js/core'
+import { ConsoleReporter } from '@serenity-js/console-reporter'
+import { BrowseTheWebWithPlaywright, PlaywrightOptions } from '@serenity-js/playwright'
+import { SerenityBDDReporter } from '@serenity-js/serenity-bdd'
+import { By, Navigate, PageElement, Photographer, TakePhotosOfFailures, Text } from '@serenity-js/web'
 
-import { describe, it, beforeAll, afterAll } from 'mocha';
-import * as playwright from 'playwright';
+import { describe, it, beforeAll, afterAll } from 'mocha'
+import * as playwright from 'playwright'
 
 // example Lean Page Object describing a widget we interact with in the test
 class SerenityJSWebsite {                   
     static header = () => 
         PageElement.located(By.css('h1'))   // selector to identify the interactable element
-            .describedAs('header');         // description to be used in reports
+            .describedAs('header')          // description to be used in reports
 }
 
 // example Actors class, confgures Serenity/JS actors to use Playwright
@@ -64,13 +76,13 @@ class Actors implements Cast {
         return actor.whoCan(
             BrowseTheWebWithPlaywright.using(this.browser, this.options),
             // ... add other abilities as needed, like CallAnApi or TakeNotes
-        );
+        )
     }
 }
 
 describe('Serenity/JS', () => {
 
-    let browser: playwright.Browser;
+    let browser: playwright.Browser
     
     beforeAll(async () => {
         // Start a single browser before all the tests,
@@ -78,7 +90,7 @@ describe('Serenity/JS', () => {
         // and manage Playwright browser context as needed  
         browser = await playwright.chromium.launch({
             headless: true
-        });
+        })
 
         // Configure Serenity/JS providing your Actors
         // and required "stage crew memebers" (a.k.a. reporting services)
@@ -94,8 +106,8 @@ describe('Serenity/JS', () => {
                 new SerenityBDDReporter(),
                 ConsoleReporter.forDarkTerminals(),
             ]
-        });
-    });
+        })
+    })
     
     it('supports Playwright', async () => {
         // actorCalled(name) instantiates or retrieves an existing actor identified by name
@@ -115,8 +127,8 @@ describe('Serenity/JS', () => {
         if (browser) {
             await browser.close()
         }
-    });
-});
+    })
+})
 ```
 
 Next steps:
@@ -124,16 +136,6 @@ Next steps:
 - Learn about the [Screenplay Pattern](https://serenity-js.org/handbook/design/screenplay-pattern.html)
 - Explore [`@serenity-js/web`](https://serenity-js.org/api/web) and [`@serenity-js/assertions`](https://serenity-js.org/api/assertions) APIs
 
-## Usage with `@playwright/test`
-
-See [@serenity-js/playwright-test](https://serenity-js.org/api/playwright-test).
-
-## Usage with Cucumber
-
-Tutorial coming soon! 
-
-Follow [@SerenityJS on Twitter](https://twitter.com/@SerenityJS) to get notified about new tutorials.
-
 ## 📣 Stay up to date
 
 New features, tutorials, and demos are coming soon!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/playwright",
-  "version": "3.10.1",
+  "version": "3.10.2",
   "description": "Serenity/JS Screenplay Pattern library for Playwright",
   "author": {
     "name": "Jan Molak",
@@ -43,14 +43,14 @@
     "node": "^16.13 || ^18.12 || ^20"
   },
   "dependencies": {
-    "@serenity-js/core": "3.10.1",
-    "@serenity-js/web": "3.10.1",
+    "@serenity-js/core": "3.10.2",
+    "@serenity-js/web": "3.10.2",
     "playwright-core": "^1.37.1",
     "tiny-types": "^1.20.0"
   },
   "devDependencies": {
     "@integration/testing-tools": "3.0.0",
-    "@types/chai": "^4.3.5",
+    "@types/chai": "^4.3.6",
     "@types/mocha": "^10.0.1",
     "c8": "8.0.1",
     "mocha": "^10.2.0",
@@ -58,5 +58,5 @@
     "ts-node": "^10.9.1",
     "typescript": "5.1.6"
   },
-  "gitHead": "7ab90f30b17ed745cad713363a27edfd7cdce08a"
+  "gitHead": "6834827fffe5dd8dd3d2f39d2fea2c4039ab1d3d"
 }