@nx/nodeSee schema

@nx/node:application

Nx Application Options Schema.

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/node:application ... 2

Show what will be generated without writing to disk:

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

Options

directory

Required
string

The directory of the new application.

bundler

string
Default: esbuild
Accepted values: esbuild, webpack

Bundler which is used to package the application

e2eTestRunner

string
Default: none
Accepted values: jest, none

Test runner to use for end-to-end tests

frontendProject

string

Frontend project that needs to access this application. This sets up proxy configuration.

framework

string
Default: none
Accepted values: express, fastify, koa, nest, none

Generate the node application using a framework

linter

string
Default: none
Accepted values: eslint, none

The tool to use for running lint checks.

name

string
Pattern: (?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$

The name of the application.

unitTestRunner

string
Default: none
Accepted values: jest, none

Test runner to use for unit tests.

docker

boolean

Add a docker build target

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

port

number
Default: 3000

The port which the server will be run on

swcJest

boolean

Use @swc/jest instead ts-jest for faster test compilation.

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.

skipDockerPlugin

boolean
Default: false

Skip the @nx/docker plugin and use the legacy docker build target instead.

tags

string

Add tags to the application (used for linting).

useProjectJson

boolean

Use a project.json configuration file instead of inlining the Nx configuration in the package.json file.

rootProject

InternalHidden
boolean
Default: false

Create node 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.

babelJest

Deprecated
boolean
Default: false

Use babel instead ts-jest.

Use --swcJest instead for faster compilation

standaloneConfig

Deprecated
boolean
Default: true

Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json.

Nx only supports standaloneConfig