bgotink / ngx-playwright

Tools to run playwright e2e tests in an angular workspace

@ngx-playwright

Utilities for using playwright to test angular applications.

This repository contains multiple packages in the packages/ folder. Every package has its own README detailing what it does and how to use it.

Development

This repository is set up using yarn 3 and snuggery.

To install dependencies, run the following command:

yarn

To build a package, run this in the folder of the package, or run it in the repository root folder to build all packages:

yarn build
# or
yarn sn build
# or, if you have @snuggery/global installed globally
sn build

Alternatively, you could use the @angular/cli by passing the project to build:

yarn ng build @ngx-playwright/test
# or to build all projects
yarn ng build all

The package will be built in <package folder>/dist, e.g. packages/test/dist. You can test your build by referring to that folder in a package.json, e.g.

// in dependencies, or via resolutions
{
  "@ngx-playwright/test": "file:///path/to/ngx-playwright/packages/test/dist"
}

To run the integration tests, run

yarn test
# or
yarn sn test
# or, if you have @snuggery/global installed globally
sn test
# or, using the @angular/cli
yarn ng test

Before opening a pull request, mark the packages that need to be released afterwards using

yarn version check --interactive

To publish, run

yarn sn deploy
# or, if @snuggery/global is installed globally
sn deploy
# or, using the @angular/cli
yarn ng deploy

License

See LICENSE.md