@serenity-js/playwright-test 3.10.0 → 3.10.2

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 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-test
+
+
+
+
+
 # [3.10.0](https://github.com/serenity-js/serenity-js/compare/v3.9.1...v3.10.0) (2023-08-23)
 
 **Note:** Version bump only for package @serenity-js/playwright-test

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),
@@ -26,18 +27,20 @@ and fixtures that integrate [Playwright Test](https://playwright.dev/docs/intro)
 
 ### Installation
 
-To install this module, use an existing [Playwright project](https://playwright.dev/docs/intro) or generate a new one by running:
+To install this module, use an existing [Playwright Test project](https://playwright.dev/docs/intro) or generate a new one by running:
 
-```bash
+```sh
 npm init playwright@latest
 ```
 
-Next, run the following command in your Playwright project directory:
+Install the below Serenity/JS modules in your Playwright Test project directory:
 
-```bash
-npm install --save-dev @serenity-js/{assertions,console-reporter,core,serenity-bdd,web,playwright,playwright-test}
+```sh
+npm install --save-dev @serenity-js/assertions @serenity-js/console-reporter @serenity-js/core @serenity-js/serenity-bdd @serenity-js/web @serenity-js/playwright @serenity-js/playwright-test
 ```
 
+To learn more about Serenity/JS and how to use it on your project, follow the [Serenity/JS Getting Started guide for Playwright Test](https://serenity-js.org/handbook/getting-started/serenity-js-with-playwright-test/).
+
 ### Serenity/JS Playwright Fixtures
 
 To use Serenity/JS Screenplay Pattern APIs and benefit from the in-depth reporting capabilities,
@@ -241,14 +244,14 @@ To get started with component testing:
 
 + const { test, expect } = useBase(componentTest)
 
-import App from './App';
+import App from './App'
 
-test.use({ viewport: { width: 500, height: 500 } });
+test.use({ viewport: { width: 500, height: 500 } })
 
 test('should work', async ({ mount }) => {
-  const component = await mount(<App />);
-  await expect(component).toContainText('Learn React');
-});
+  const component = await mount(<App />)
+  await expect(component).toContainText('Learn React')
+})
 ```
 
 #### Using Serenity/JS Screenplay Pattern Actors for Component Testing
@@ -267,7 +270,7 @@ import { Ensure, contain } from '@serenity-js/assertions'
 import { useBase } from '@serenity-js/playwright-test'
 import { Enter, PageElement, CssClasses } from '@serenity-js/web'
 
-import EmailInput from './EmailInput';
+import EmailInput from './EmailInput'
 
 const { it, describe } = useBase(componentTest).useFixtures<{ emailAddress: string }>({
     emailAddress: ({ actor }, use) => {
@@ -278,9 +281,9 @@ const { it, describe } = useBase(componentTest).useFixtures<{ emailAddress: stri
 describe('EmailInput', () => {
 
     it('allows valid email addresses', async ({ actor, mount, emailAddress }) => {
-        const nativeComponent = await mount(<EmailInput/>);
+        const nativeComponent = await mount(<EmailInput/>)
 
-        const component = PageElement.from(nativeComponent);
+        const component = PageElement.from(nativeComponent)
 
         await actor.attemptsTo(
             Enter.theValue(emailAddress).into(component),
@@ -298,7 +301,7 @@ To use Serenity/JS reporting capabilities, register the `@serenity-js/playwright
 For example, to enable Serenity/JS Console Reporter and Serenity BDD reporter, install the relevant modules:
 
 ```bash
-npm install --save-dev @serenity-js/{console-reporter,serenity-bdd}
+npm install --save-dev @serenity-js/console-reporter @serenity-js/serenity-bdd
 ```
 
 Next, configure your Playwright project as follows:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serenity-js/playwright-test",
-  "version": "3.10.0",
+  "version": "3.10.2",
   "description": "Serenity/JS reporter and test APIs for Playwright Test",
   "author": {
     "name": "Jan Molak",
@@ -45,21 +45,21 @@
   },
   "dependencies": {
     "@playwright/test": "^1.37.1",
-    "@serenity-js/core": "3.10.0",
-    "@serenity-js/playwright": "3.10.0",
-    "@serenity-js/web": "3.10.0",
+    "@serenity-js/core": "3.10.2",
+    "@serenity-js/playwright": "3.10.2",
+    "@serenity-js/web": "3.10.2",
     "deepmerge": "^4.3.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",
     "mocha-multi": "^1.1.7",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "typescript": "5.1.6"
   },
-  "gitHead": "06ae5d8a702be0be2890e989c120715c32f6578a"
+  "gitHead": "6834827fffe5dd8dd3d2f39d2fea2c4039ab1d3d"
 }