@nestjs/schematics/dist/lib/resource/schema.json

Nest - modern, fast, powerful node.js web framework (@schematics)

{
  "$schema": "http://json-schema.org/schema",
  "$id": "SchematicsNestResource",
  "title": "Nest Resource Options Schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the resource.",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What name would you like to use for this resource (plural, e.g., \"users\")?"
    },
    "path": {
      "type": "string",
      "format": "path",
      "description": "The path to create the resource."
    },
    "sourceRoot": {
      "type": "string",
      "description": "Nest resource source root directory."
    },
    "language": {
      "type": "string",
      "description": "Application language (ts/js)."
    },
    "flat": {
      "type": "boolean",
      "default": false,
      "description": "Flag to indicate if a directory is created."
    },
    "spec": {
      "type": "boolean",
      "default": true,
      "description": "Specifies if specs file are generated."
    },
    "specFileSuffix": {
      "type": "string",
      "default": "spec",
      "description": "Specifies the file suffix of spec files."
    },
    "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"
      }
    }
  },
  "required": ["name"]
}