@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 inside my-plugin, which will be triggered when migrating to version 1.0.0 or above from a previous version.:
1nx g migration my-plugin/my-migration --version=1.0.0
2Options
path
Required
string
The file path to the migration without the file extension (e.g. my-plugin/src/migrations/my-migration generates the file my-plugin/src/migrations/my-migration.ts). Relative to the current working directory.
packageVersion
vRequired
string
Version to use for the migration.
description
string
Migration description.
name
string
The migration name to export in the plugin migrations collection.
packageJsonUpdates
p
boolean
Default:
falseWhether or not to include package.json updates.
skipLintChecks
boolean
Default:
falseDo not eslint configuration for plugin json files.