@mands/nx-playwright - npm Package Compare versions

Comparing version 0.1.15 to 0.1.16

package.json

 {
   "name": "@mands/nx-playwright",
-  "version": "0.1.15",
+  "version": "0.1.16",
   "license": "MIT",
@@ -15,3 +15,6 @@ "publishConfig": {
   "executors": "./executors.json",
+  "peerDependencies": {
+    "@playwright/test": "^1.25.0"
+  },
   "typings": "./index.d.ts"
 }

README.md

@@ -5,14 +5,26 @@ # @mands/nx-playwright
 
-An [Nx plugin](https://nx.dev/packages/nx-plugin) to add support to an Nx monorepo for
-Playwright testing using a native runner.
+An [Nx plugin](https://nx.dev/packages/nx-plugin) that adds [Playwright](https://playwright.dev/) end-to-end testing using a native runner to your NX workspace.
 
-## Usage
+## Setup
 
-Replacing the placeholders `<PATH-TO-NX-WORKSPACE>` and `<APP-NAME>`:
+> **Note** Don't forget to replace the placeholder `<APP-NAME>`
 
+
+### Installation
+
 ```sh
-cd <PATH-TO-NX-WORKSPACE>
 yarn add --dev @mands/nx-playwright
+yarn playwright install --with-deps
+```
+
+### Generatre e2e test app
+
+> **Warning** If you have an existing e2e test app, please remove it first `yarn nx generate remove <APP-NAME>-e2e`
+```sh
 yarn nx generate @mands/nx-playwright:project <APP-NAME>-e2e --project <APP-NAME>
-yarn playwright install --with-deps
+```
+
+### Running tests
+
+```sh
 yarn nx e2e <APP-NAME>-e2e
@@ -29,6 +41,10 @@ ```
 - `--debug`: runs tests in a browser plus another interactive debugger window that you can pause/play tests
-- `--packageRunner`: package runner to use for running playwright (`npx`, `pnpm`, or `yarn`). Defaults to `yarn`.
+- `--packageRunner`: package runner to use for running playwright (`npx`, `pnpm`, or `yarn`). Defaults to `yarn`
 - `--skipServe`: skips the execution of a devServer
-- `--timeout=TIMEOUT_IN_MS`: adds a timeout for your tests
+- `--timeout=<number>`: adds a timeout for your tests in milliseconds
+- `--grep=<RegExp|Array<RegExp>>`: filter to only run tests with a title matching one of the patterns
+- `--grep-invert=<RegExp|Array<RegExp>>`: filter to only run tests with a title not matching one of the patterns
 
+> **Note** These flags can also be used in `project.json` or `nx.json`
+
 These flags align with the standard [playwright flags](https://playwright.dev/docs/test-cli#reference), as well as the [nx-cypress](https://nx.dev/packages/cypress/executors/cypress#options) ones.
@@ -35,0 +51,0 @@

No alert changes

Improved metrics

Total package byte prevSize

45895

increased by1.24%

Number of lines in readme file

79

increased by25.4%

Worsened metrics

Dependency count

1

increased byInfinity%

No dependency changes