@nx/nextSee schema

@nx/next:application

Create a Next.js Application for Nx.

Examples

Directory Flag Behavior Changes

The command below uses the as-provided directory flag behavior, which is the default in Nx 16.8.0. If you're on an earlier version of Nx or using the derived option, use --directory=nested. See the as-provided vs. derived documentation for more details.

❯

nx g app apps/nested/myapp

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

Show what will be generated without writing to disk:

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

Options

directory

dirRequired
string

The directory of the new application.

name

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

The name of the application.

appDir

boolean
Default: true

Enable the App Router for this project.

customServer

boolean
Default: false

Use a custom Express server for the Next.js application.

e2eTestRunner

string
Default: playwright
Accepted values: playwright, cypress, none

Test runner to use for end to end (E2E) tests.

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

linter

string
Default: eslint
Accepted values: eslint

The tool to use for running lint checks.

style

s
string
Default: css

The file extension to be used for style 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.

swc

boolean
Default: true

Enable the Rust-based compiler SWC to compile JS/TS files.

src

boolean
Default: true

Generate a src directory for the project.

tags

t
string

Add tags to the application (used for linting).

unitTestRunner

string
Default: jest
Accepted values: jest, none

Test runner to use for unit tests.

rootProject

InternalHidden
boolean
Default: false

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