HaxeFoundation.haxe/.vscode/schemas/define.schema.json

{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"type": "array",
	"items": {
		"type": "object",
		"additionalProperties": false,
		"properties": {
			"name": {
				"type": "string",
				"markdownDescription": "OCaml name of the define."
			},
			"define": {
				"type": "string",
				"markdownDescription": "Actual name of the define as it's used in `-D` on the CLI and in Haxe code."
			},
			"doc": {
				"type": "string",
				"markdownDescription": "Documentation for the define that is shown in `--help-defines`."
			},
			"platforms": {
				"type": "array",
				"markdownDescription": "Platforms on which this define has an effect.",
				"minItems": 1,
				"items": {
					"enum": [
						"js",
						"lua",
						"neko",
						"flash",
						"php",
						"cpp",
						"cs",
						"java",
						"jvm",
						"python",
						"hl",
						"eval"
					]
				}
			},
			"params": {
				"type": "array",
				"markdownDescription": "Parameters this define takes.",
				"minItems": 1,
				"items": {
					"type": "string"
				}
			},
			"devcomment": {
				"type": "string",
				"markdownDescription": "Internal comment that is not exposed."
			},
			"links": {
				"type": "array",
				"markdownDescription": "Relevant URLs.",
				"minItems": 1,
				"items": {
					"type": "string",
					"format": "uri"
				}
			},
			"reserved": {
				"type": "boolean",
				"markdownDescription": "Reserved defines may not be defined from the command line."
			},
			"deprecated": {
				"type": "string",
				"markdownDescription": "Reason for the define to be deprecated."
			},
			"default": {
				"type": "string",
				"markdownDescription": "Default value if not explicitly set."
			},
			"deprecatedDefine": {
				"type": "string",
				"markdownDescription": "Replace and deprecate the given definition name, which can still be used in -D."
			},
			"signatureNeutral": {
				"type": "boolean",
				"markdownDescription": "Does not affect compilation signature."
			}
		},
		"required": [
			"name",
			"define",
			"doc"
		]
	}
}