@nx/detox:application

Create Detox Configuration for the workspace.

Usage

1nx generate application ... 2
1nx g app ... #same 2

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

You can specify the collection explicitly as follows:

1nx g @nx/detox:application ... 2
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

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

Options

appProject

Required
string

Name of the frontend project to be tested.

e2eName

Required
string
Pattern: ^[a-zA-Z][^:]*$

Name of the E2E Project.

framework

Required
string
Accepted values: react-native, expo

App framework to test

appName

string

Name of the app to be tested if different from appProject

appDisplayName

string

Display name of the app to be tested if different from appProject

e2eDirectory

string

A directory where the project is placed relative to apps directory.

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

linter

string
Default: eslint
Accepted values: eslint, none

The tool to use for running lint checks.

projectNameAndRootFormat

string
Accepted values: as-provided, derived

Whether to generate the project name and root directory as provided (as-provided) or generate them composing their values and taking the configured layout into account (derived).

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.

skipFormat

boolean
Default: false

Skip formatting files.