kire/schema.json at main · drysius/kire · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"title": "Kire Configuration",
	"description": "Configuration file for Kire directives to provide IntelliSense in editors.",
	"type": "object",
	"required": ["package"],
	"properties": {
		"package": {
			"type": "string",
			"description": "Name of the package providing these directives."
		},
		"version": {
			"type": "string"
		},
		"author": {
			"type": "string"
		},
		"repository": {
			"type": ["string", "object"],
			"properties": {
				"type": { "type": "string" },
				"url": { "type": "string" }
			}
		},
		"directives": {
			"type": "array",
			"description": "A list of directive definitions.",
			"items": { "$ref": "#/definitions/directive" }
		},
		"elements": {
			"type": "array",
			"description": "A list of elements/attributes tree nodes.",
			"items": { "$ref": "#/definitions/node" }
		},
		"globals": {
			"type": "array",
			"description": "A list of global/context tree nodes.",
			"items": { "$ref": "#/definitions/node" }
		}
	},
	"definitions": {
		"directive": {
			"type": "object",
			"required": ["name"],
			"properties": {
				"name": {
					"type": "string",
					"description": "The name of the directive (without the '@')."
				},
				"params": {
					"type": "array",
					"items": { "type": "string" }
				},
				"children": {
					"description": "Does this directive accept a block ending with @end?",
					"oneOf": [
						{ "type": "boolean" },
						{ "type": "string", "enum": ["auto"] }
					]
				},
				"childrenRaw": {
					"type": "boolean"
				},
				"parents": {
					"type": "array",
					"items": { "$ref": "#/definitions/directive" }
				},
				"description": {
					"type": "string"
				},
				"comment": {
					"type": "string"
				},
				"example": {
					"type": "string"
				},
				"type": {
					"type": "string",
					"enum": ["css", "js", "html"]
				}
			}
		},
		"node": {
			"type": "object",
			"required": ["variable"],
			"properties": {
				"variable": {
					"type": "string",
					"description": "The key/name of the variable or element part."
				},
				"separator": {
					"type": "string",
					"description": "The separator used between this node and its children (e.g. ':' or '.')."
				},
				"description": {
					"type": "string"
				},
				"comment": {
					"type": "string"
				},
				"example": {
					"type": "string"
				},
				"type": {
					"description": "The TypeScript type or special feature type (e.g. filepath).",
					"oneOf": [
						{ "type": "string" },
						{ "type": "array", "items": { "type": "string" } }
					]
				},
				"extends": {
					"type": "array",
					"items": { "$ref": "#/definitions/node" }
				}
			}
		}
	}
}