bc8b71ac6c
<!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> Currently, when we use generator's via the CLI passing the `name` arg has more than one responsibility: 1. it can be used as a path 2. it can be used as the generator's name (e.g. Component name) This is not intuitive as if we use via Nx Console because it creates some ambiguity around the `--name` property which is normally described as only 2.  ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> What is expected is that the `name` property should only have the responsibility of determining the name of the generated module (Component, Directive etc...). The new property `path` replaces the `directory` property but fulfils the same purpose as determining where the module should be created. ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes # --------- Co-authored-by: Jack Hsu <jack.hsu@gmail.com>
64 lines
2.1 KiB
JSON
64 lines
2.1 KiB
JSON
{
|
|
"name": "migration",
|
|
"factory": "./src/generators/migration/migration",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"cli": "nx",
|
|
"$id": "NxPluginMigration",
|
|
"title": "Create a Migration for an Nx Plugin",
|
|
"description": "Create a Migration for an Nx Plugin.",
|
|
"type": "object",
|
|
"examples": [
|
|
{
|
|
"command": "nx g migration my-plugin/my-migration --version=1.0.0",
|
|
"description": "Adds a new migration inside `my-plugin`, which will be triggered when migrating to version 1.0.0 or above from a previous version."
|
|
}
|
|
],
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "Path where the migration will be generated.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "Where should the migration be generated?",
|
|
"x-priority": "important"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Migration name.",
|
|
"x-priority": "important"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Migration description."
|
|
},
|
|
"packageVersion": {
|
|
"type": "string",
|
|
"description": "Version to use for the migration.",
|
|
"alias": "v",
|
|
"x-prompt": "What version would you like to use for the migration?",
|
|
"x-priority": "important"
|
|
},
|
|
"packageJsonUpdates": {
|
|
"type": "boolean",
|
|
"description": "Whether or not to include `package.json` updates.",
|
|
"alias": "p",
|
|
"default": false
|
|
},
|
|
"skipLintChecks": {
|
|
"type": "boolean",
|
|
"default": false,
|
|
"description": "Do not eslint configuration for plugin json files."
|
|
}
|
|
},
|
|
"required": ["packageVersion", "path"],
|
|
"additionalProperties": false,
|
|
"presets": []
|
|
},
|
|
"description": "Create a migration for an Nx Plugin.",
|
|
"implementation": "/packages/plugin/src/generators/migration/migration.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/plugin/src/generators/migration/schema.json",
|
|
"type": "generator"
|
|
}
|