Schema for internal use only

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

@nrwl/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 @nrwl/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: 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

linter

string
Default: eslint
Accepted values: eslint

The tool to use for running lint checks.

name

string

The name of the workspace.

npmScope

string

Npm scope for importing libs.

nxCloud

boolean
Default: false

Connect the workspace to the free tier of the distributed cache provided by Nx Cloud.

nextAppDir

boolean
Default: false

Enable experimental app directory for the project

preset

string

What to create in the new workspace.

packageManager

string
Accepted values: npm, yarn, pnpm

The package manager used to install dependencies.

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.

Additional Properties

anything

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