@nx/plugin:migration

Create a Migration for an Nx Plugin.

Usage

nx generate migration ...

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

You can specify the collection explicitly as follows:

nx g @nx/plugin:migration ...
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

nx g migration ... --dry-run

Examples

Generate libs/my-plugin/src/migrations/my-migration:

nx g migration my-migration --project=my-plugin --version=1.0.0

Options

project

pRequired
string

The name of the project.

packageVersion

vRequired
string

Version to use for the migration.

name

string

Migration name.

description

string

Migration description.

packageJsonUpdates

p
boolean
Default: false

Whether or not to include package.json updates.

skipLintChecks

boolean
Default: false

Do not eslint configuration for plugin json files.