59 lines
2.4 KiB
JSON
59 lines
2.4 KiB
JSON
{
|
|
"name": "interface",
|
|
"factory": "./src/generators/interface/interface#interfaceGeneratorInternal",
|
|
"schema": {
|
|
"$schema": "http://json-schema.org/schema",
|
|
"$id": "NxNestInterfaceGenerator",
|
|
"title": "Nest Interface Options Schema",
|
|
"description": "Nest Interface Options Schema.",
|
|
"cli": "nx",
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"description": "The name of the interface.",
|
|
"type": "string",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What name would you like to use?"
|
|
},
|
|
"nameAndDirectoryFormat": {
|
|
"description": "Whether to generate the component 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`).",
|
|
"type": "string",
|
|
"enum": ["as-provided", "derived"]
|
|
},
|
|
"project": {
|
|
"description": "The Nest project to target.",
|
|
"type": "string",
|
|
"$default": { "$source": "projectName" },
|
|
"alias": "p",
|
|
"x-deprecated": "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 v18."
|
|
},
|
|
"directory": {
|
|
"description": "Directory where the generated files are placed. when `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. otherwise, it will be relative to the workspace root.",
|
|
"type": "string",
|
|
"aliases": ["dir", "path"]
|
|
},
|
|
"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 v18.",
|
|
"type": "boolean",
|
|
"default": true
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": ["name"],
|
|
"presets": []
|
|
},
|
|
"description": "Run the `interface` NestJS generator with Nx project support.",
|
|
"implementation": "/packages/nest/src/generators/interface/interface#interfaceGeneratorInternal.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/nest/src/generators/interface/schema.json",
|
|
"type": "generator"
|
|
}
|