@nx/playwrightSee schema

@nx/playwright:configuration

Add a Playwright configuration.

Usage

1nx generate configuration ... 2

By default, Nx will search for configuration in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/playwright:configuration ... 2

Show what will be generated without writing to disk:

1nx g configuration ... --dry-run 2

Options

project

Required
string

The project to add a Playwright configuration to.

directory

string
Default: e2e

A directory where the project is placed relative from the project root.

linter

string
Accepted values: none, eslint

The tool to use for running lint checks.

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

setParserOptionsProject

boolean
Default: false

Whether or not to configure the ESLint parserOptions.project option. We do not do this by default for lint performance reasons.

skipInstall

boolean
Default: false

Skip running playwright install. This is to ensure that playwright browsers are installed.

webServerCommand

string

The command to start the web server.

webServerAddress

string

The address of the web server.

rootProject

InternalHidden
boolean
Default: false

Create a application at the root of the workspace

skipFormat

Internal
boolean
Default: false

Skip formatting files.

skipPackageJson

Internal
boolean
Default: false

Do not add dependencies to package.json.