@nx/plugin:migration
Create a Migration for an Nx Plugin.
Usage
1nx generate migration ...
2By default, Nx will search for migration in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
1nx g @nx/plugin:migration ...
2Show what will be generated without writing to disk:
1nx g migration ... --dry-run
2Examples
Adds a new migration to the project my-plugin, which will be triggered when migrating to version 1.0.0 or above from a previous version.:
1nx g migration my-migration --project=my-plugin --version=1.0.0
2Options
packageVersion
vRequired
string
Version to use for the migration.
name
string
Migration name.
directory
string
The directory at which to create the migration file. When --nameAndDirectoryFormat=as-provided, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.
description
string
Migration description.
nameAndDirectoryFormat
string
Accepted values:
as-provided, derivedWhether to generate the migration in the directory as provided, relative to the current working directory and ignoring the project (as-provided) or generate it using the project and directory relative to the workspace root (derived).
packageJsonUpdates
p
boolean
Default:
falseWhether or not to include package.json updates.
skipLintChecks
boolean
Default:
falseDo not eslint configuration for plugin json files.
project
pDeprecated
string
The name of the project.
Provide the directory option instead and use the as-provided format. The project will be determined from the directory provided. It will be removed in Nx v20.