2024-01-30 16:29:05 -05:00

70 lines
2.8 KiB
JSON

{
"name": "interceptor",
"factory": "./src/generators/interceptor/interceptor#interceptorGeneratorInternal",
"schema": {
"$schema": "https://json-schema.org/schema",
"$id": "NxNestInterceptorGenerator",
"title": "Nest Interceptor Options Schema",
"description": "Nest Interceptor Options Schema.",
"cli": "nx",
"type": "object",
"properties": {
"name": {
"description": "The name of the interceptor.",
"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 v19."
},
"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"
},
"unitTestRunner": {
"description": "Test runner to use for unit tests.",
"type": "string",
"enum": ["jest", "none"],
"default": "jest"
},
"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 v19.",
"type": "boolean",
"default": true
},
"language": {
"description": "Nest interceptor language.",
"type": "string",
"enum": ["js", "ts"]
}
},
"additionalProperties": false,
"required": ["name"],
"presets": []
},
"description": "Run the `interceptor` NestJS generator with Nx project support.",
"implementation": "/packages/nest/src/generators/interceptor/interceptor#interceptorGeneratorInternal.ts",
"aliases": [],
"hidden": false,
"path": "/packages/nest/src/generators/interceptor/schema.json",
"type": "generator"
}