28c53f942b
<!-- 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 --> Artifact generators don't handle consistently receiving a file extension in the `path` option. ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> Artifact generators should handle receiving a file extension in the `path` option. If the file extension is passed, the file path will be treated as "complete" and used fully as provided. If the `path` provided doesn't contain a file extension, the default extension will be appended to it (or the one provided in a related option, e.g. `--language`, `--js`, etc) together with the suffix for generators that use it. ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
71 lines
2.9 KiB
JSON
71 lines
2.9 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": [
|
|
{
|
|
"description": "Generate a migration exported with the name matching the file name, which will be triggered when migrating to version 1.0.0 or above from a previous version. It results in the migration `foo` at `mylib/src/migrations/foo.ts`",
|
|
"command": "nx g @nx/plugin:migration mylib/src/migrations/foo.ts -v=1.0.0"
|
|
},
|
|
{
|
|
"description": "Generate a migration without providing the file extension, which will be triggered when migrating to version 1.0.0 or above from a previous version. It results in the migration `foo` at `mylib/src/migrations/foo.ts`",
|
|
"command": "nx g @nx/plugin:migration mylib/src/migrations/foo -v=1.0.0"
|
|
},
|
|
{
|
|
"description": "Generate a migration exported with a different name from the file name, which will be triggered when migrating to version 1.0.0 or above from a previous version. It results in the migration `custom` at `mylib/src/migrations/foo.ts`",
|
|
"command": "nx g @nx/plugin:migration mylib/src/migrations/foo --name=custom -v=1.0.0"
|
|
}
|
|
],
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "The file path to the migration without the file extension. Relative to the current working directory.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What is the migration file path?",
|
|
"x-priority": "important"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The migration name to export in the plugin migrations collection."
|
|
},
|
|
"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"
|
|
}
|