[](https://github.com/marksandspencer/nx-plugins/blob/main/LICENSE.md)  [ !Build  
An Nx plugin that adds Playwright end-to-end testing using a native runner to your NX workspace.
> Note Don't forget to replace the placeholder
``sh`
pnpm add --dev @mands/nx-playwright
pnpm playwright install --with-deps
> Warning If you have an existing e2e test app, please remove it first pnpm nx generate remove
`sh`
pnpm nx generate @mands/nx-playwright:project
Optionally the --includeAxe flag can be included to generate axe-playwright accessibility tests.
`sh`
pnpm nx e2e
`sh`
pnpm nx e2e
nx-playwright has some flags that you can utilize at execution time
- --browser=BROWSER_TYPE: allowed browser types being chromium, firefox or webkit (or an all type to execute against all 3 types)--testProject
- : playwright project name to run (NOTE: this is --project option in playwright itself, but it conflicts with nx's option)--config
- : configuration file. Defaults to playwright.config.ts
- : this allows values such as json or html
- : launches the browser in non-headless mode--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), use only when running NX directly, not required when running via package manager (e.g. pnpm nx run your-app-e2e:e2e)--path
- : path to run tests at. Defaults to src
- : skips the execution of a devServer--timeout=
- : adds a timeout for your tests in milliseconds--grep=
- : filter to only run tests with a title matching one of the patterns--grepInvert=
- : filter to only run tests with a title not matching one of the patterns--ui
- : launches the browser in ui mode to explore, run and debug tests (preview)
> Note These flags can also be used in project.json or nx.json
These flags align with the standard playwright flags, as well as the nx-cypress ones.
Create a new Nx workspace containing one application. Then run, in the root of this repo:
`sh`
./local-test.sh -w path/to/workspace -a app-name
⚠️ The flag -C can optionally be used to reverse any changes made to the workspace during the test run.
However, this is a potentially destructive operation that performs a stash save before the run and
a stash pop at the end of the run.
`bash
git clone git@github.com:marksandspencer/nx-plugins.git
pnpm create nx-workspace --name=test-nx --appName=test-app --style=@emotion/styled --preset=next --nxCloud=false --interactive=false
pushd test-nx
pnpm nx generate remove test-app-e2e
git commit -am "Remove test-app-e2e"
popd