@nrwl/next:application

Create a Next.js Application for Nx.

Examples

nx g app myapp --directory

Usage

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

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

You can specify the collection explicitly as follows:

nx g @nrwl/next:application ...

Show what will be generated without writing to disk:

nx g application ... --dry-run

Options

directory

d
string

The directory of the new application.

name

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

The name of the application.

customServer

boolean
Default: false

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

e2eTestRunner

string
Default: cypress
Accepted values: 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.

server

string

The server script path to be used with next.

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.

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.

skipFormat

boolean
Default: false

Skip formatting files.

skipWorkspaceJson

boolean
Default: false

Skip updating workspace.json with default options based on values provided to this app (e.g. babel, style).

standaloneConfig

Deprecated
boolean
Default: true

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

Nx only supports standaloneConfig