Schema for internal use only

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

@nx/plugin:preset

Initializes a workspace with an nx-plugin inside of it. Use as: create-nx-plugin or create-nx-workspace --preset @nx/nx-plugin.

Usage

1nx generate preset ... 2

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

You can specify the collection explicitly as follows:

1nx g @nx/plugin:preset ... 2
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

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

Examples

Creates a new Nx workspace containing an Nx plugin.:

1npx create-nx-plugin 2

Creates a new Nx workspace containing an Nx plugin.:

1npx create-nx-workspace --preset @nx/plugin 2
Nx 15 and lower use @nrwl/ instead of @nx/

Options

pluginName

Required
string

Plugin name

createPackageName

string

Name of package which creates a workspace