Schema for internal use only

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

@nx/workspace:new

Create an empty workspace.

Usage

nx generate new ...

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

You can specify the collection explicitly as follows:

nx g @nx/workspace:new ...

Show what will be generated without writing to disk:

nx g new ... --dry-run

Options

appName

string

Application name.

defaultBase

string

Default base branch for affected.

e2eTestRunner

string

Accepted values: playwright, cypress, jest, detox, none

The tool to use for running e2e tests.

framework

string

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

The framework which the application is using

formatter

string

Default: none

Accepted values: none, prettier

The tool to use for code formatting.

linter

string

Default: eslint

Accepted values: eslint, none

The tool to use for running lint checks.

name

string

The name of the workspace.

nextAppDir

boolean

Default: true

Enable the App Router for this project.

nextSrcDir

boolean

Default: true

Generate a src directory for this project.

preset

string

What to create in the new workspace.

packageManager

string

Accepted values: npm, yarn, pnpm, bun

The package manager used to install dependencies.

prefix

string

The prefix to use for Angular component and directive selectors.

routing

boolean

Default: true

Add routing to the generated application.

style

string

Default: css

The file extension to be used for style files.

standaloneApi

boolean

Default: false

Use Standalone Components if generating an Angular application.

skipInstall

boolean

Default: false

Skip installing dependency packages.

ssr

boolean

Default: false

Enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering) for the Angular application.

serverRouting

boolean

Use the Angular Server Routing and App Engine APIs (Developer Preview).

workspaces

boolean

Default: false

Whether to use package manager workspaces.

Additional Properties

anything

Extra properties of any type may be provided to this object.