Schema for internal use only

Please do not extend this schema as it is part of Nx internal usage.

@nx/jest:jest-project

Add Jest Configuration to a project.

Usage

nx generate jest-project ...

By default, Nx will search for jest-project in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

nx g @nx/jest:jest-project ...
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

nx g jest-project ... --dry-run

Options

project

string

The name of the project.

setupFile

string
Default: none
Accepted values: none, angular, web-components

The setup file to be generated.

supportTsx

boolean
Default: false

Setup tsx support.

testEnvironment

string
Default: jsdom
Accepted values: jsdom, node, none

The test environment for jest.

compiler

string
Default: tsc
Accepted values: tsc, babel, swc

The compiler to use for source and tests.

js

boolean
Default: false

Use JavaScript instead of TypeScript for config files

skipSerializers

boolean
Default: false

Skips the serializers required to snapshot angular templates.

skipFormat

boolean
Default: false

Skip formatting files

skipPackageJson

boolean
Default: false

Do not add dependencies to package.json.

babelJest

babel-jestDeprecated
boolean
Default: false

Use babel-jest instead of ts-jest.

Use --compiler=babel instead.

skipSetupFile

Deprecated
boolean
Default: false

Skips the setup file required for angular.

Use --setup-file instead.