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>
47 lines
1.5 KiB
JSON
47 lines
1.5 KiB
JSON
{
|
|
"name": "interface",
|
|
"factory": "./src/generators/interface/interface",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"$id": "NxNestInterfaceGenerator",
|
|
"title": "Nest Interface Options Schema",
|
|
"description": "Nest Interface Options Schema.",
|
|
"cli": "nx",
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"description": "Path where the interface will be generated.",
|
|
"type": "string",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "Where should the interface be generated?"
|
|
},
|
|
"name": {
|
|
"description": "The name of the interface.",
|
|
"type": "string",
|
|
"x-prompt": "What name would you like to use?"
|
|
},
|
|
"skipFormat": {
|
|
"description": "Skip formatting files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
},
|
|
"flat": {
|
|
"description": "Flag to indicate if a directory is created.",
|
|
"x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v20.",
|
|
"type": "boolean",
|
|
"default": true
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": ["path"],
|
|
"presets": []
|
|
},
|
|
"description": "Run the `interface` NestJS generator with Nx project support.",
|
|
"implementation": "/packages/nest/src/generators/interface/interface.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/nest/src/generators/interface/schema.json",
|
|
"type": "generator"
|
|
}
|