@nx/nest
Version:
89 lines (88 loc) • 2.49 kB
JSON
{
"$schema": "https://json-schema.org/schema",
"$id": "NxNestResourceGenerator",
"title": "Nest Resource Options Schema",
"description": "Nest Resource Options Schema.",
"cli": "nx",
"type": "object",
"examples": [
{
"description": "Generate `myapp/src/app/entities/foo.entity.ts`, `myapp/src/app/dto/create-foo.dto.ts`, `myapp/src/app/dto/update-foo.dto.ts`, `myapp/src/app/foo.service.ts`, `myapp/src/app/foo.controller.ts`, and `myapp/src/app/foo.module.ts`",
"command": "nx g @nx/nest:resource myapp/src/app/foo"
}
],
"properties": {
"path": {
"type": "string",
"description": "The file path to the resource. Relative to the current working directory.",
"$default": {
"$source": "argv",
"index": 0
},
"x-prompt": "What is the resource file 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"
},
"type": {
"type": "string",
"description": "The transport layer.",
"default": "rest",
"enum": [
"rest",
"graphql-code-first",
"graphql-schema-first",
"microservice",
"ws"
],
"x-prompt": {
"message": "What transport layer do you use?",
"type": "list",
"items": [
{ "value": "rest", "label": "REST API" },
{
"value": "graphql-code-first",
"label": "GraphQL (code first)"
},
{
"value": "graphql-schema-first",
"label": "GraphQL (schema first)"
},
{
"value": "microservice",
"label": "Microservice (non-HTTP)"
},
{
"value": "ws",
"label": "WebSockets"
}
]
}
},
"skipImport": {
"type": "boolean",
"description": "Flag to skip the module import.",
"default": false
},
"crud": {
"type": "boolean",
"description": "When true, CRUD entry points are generated.",
"default": true,
"x-prompt": {
"message": "Would you like to generate CRUD entry points?",
"type": "confirmation"
}
}
},
"additionalProperties": false,
"required": ["path"]
}