@schematics/angular/enum/schema.json

Schematics specific to Angular

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "SchematicsAngularEnum",
  "title": "Angular Enum Options Schema",
  "type": "object",
  "description": "Creates a new enum in your project. Enums (enumerations) are a way to define a set of named constants, making your code more readable and maintainable. This schematic generates a new enum with the specified name and type.",
  "additionalProperties": false,
  "properties": {
    "name": {
      "type": "string",
      "description": "The name for the new enum. This will be used to create the enum file (e.g., `my-enum.enum.ts`).",
      "$default": {
        "$source": "argv",
        "index": 0
      },
      "x-prompt": "What name would you like to use for the enum?"
    },
    "path": {
      "type": "string",
      "format": "path",
      "$default": {
        "$source": "workingDirectory"
      },
      "description": "The path where the enum file should be created, relative to the current workspace. If not specified, the enum will be created in the current directory.",
      "visible": false
    },
    "project": {
      "type": "string",
      "description": "The name of the project where the enum should be created. If not specified, the CLI will determine the project from the current directory.",
      "$default": {
        "$source": "projectName"
      }
    },
    "type": {
      "type": "string",
      "description": "Adds a custom type to the filename, allowing you to create more descriptive enum names. For example, if you set the type to `status`, the filename will be `my-enum.status.ts`."
    }
  },
  "required": ["name", "project"]
}