-
Notifications
You must be signed in to change notification settings - Fork 41
/
schema.json
160 lines (159 loc) · 5.28 KB
/
schema.json
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
{
"$id": "https://arkit.pro/schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"ComponentNameFormat": {
"description": "Component name formats",
"enum": [
"base",
"complete",
"full"
],
"type": "string"
},
"ComponentSchema": {
"description": "Component definition",
"properties": {
"excludePatterns": {
"description": "File patterns to exclude, e.g. [\"**\\/*.test.ts\"]",
"items": {
"type": "string"
},
"type": "array"
},
"format": {
"$ref": "https://arkit.pro/schema.json#/definitions/ComponentNameFormat",
"default": "base",
"description": "Filename format, e.g. \"base\", \"full\""
},
"patterns": {
"description": "File patterns to include, e.g. [\"**\\/*.model.ts\"]",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Component type, e.g. \"Model\"",
"type": "string"
}
},
"required": [
"patterns",
"type"
],
"type": "object"
},
"GroupSchema": {
"description": "Group of components",
"properties": {
"components": {
"description": "List of components, e.g. [\"Service\", \"Model\"]",
"items": {
"type": "string"
},
"type": "array"
},
"first": {
"default": false,
"description": "First group",
"type": "boolean"
},
"last": {
"default": false,
"description": "Last group",
"type": "boolean"
},
"patterns": {
"description": "File patterns, e.g. [\"services\\/*.ts\", \"**\\/*.model.ts\"]",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Component type, e.g. \"Data-related\"",
"type": "string"
}
},
"type": "object"
},
"OutputDirection": {
"enum": [
"horizontal",
"vertical"
],
"type": "string"
},
"OutputSchema": {
"properties": {
"direction": {
"$ref": "https://arkit.pro/schema.json#/definitions/OutputDirection",
"default": "vertical",
"description": "Direction, e.g. \"horizontal\", \"vertical\""
},
"groups": {
"description": "Optional groups of components",
"items": {
"$ref": "https://arkit.pro/schema.json#/definitions/GroupSchema"
},
"type": "array"
},
"path": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "string"
}
],
"description": "Output path or paths, e.g. [\"architecture.puml\", \"architecture.svg\"]"
}
},
"type": "object"
}
},
"description": "Configuration",
"properties": {
"components": {
"anyOf": [
{
"$ref": "https://arkit.pro/schema.json#/definitions/ComponentSchema"
},
{
"items": {
"$ref": "https://arkit.pro/schema.json#/definitions/ComponentSchema"
},
"type": "array"
}
],
"description": "Required list of component definitions"
},
"excludePatterns": {
"description": "File patterns to exclude, e.g. [\"node_modules/**\"]",
"items": {
"type": "string"
},
"type": "array"
},
"output": {
"anyOf": [
{
"$ref": "https://arkit.pro/schema.json#/definitions/OutputSchema"
},
{
"items": {
"$ref": "https://arkit.pro/schema.json#/definitions/OutputSchema"
},
"type": "array"
}
],
"description": "Optional output configurations"
}
},
"type": "object"
}