Skip to content

Commit 5d960e4

Browse files
Neko-Box-CoderNeko-Box-Coder
committed
Updating script info yaml & removing descriptions from json schema
1 parent 2b065bc commit 5d960e4

File tree

3 files changed

+85
-184
lines changed

3 files changed

+85
-184
lines changed

‎DefaultYAMLs/DefaultScriptInfo.yaml‎

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,28 @@ RequiredProfiles:
1212

1313
# (Optional) Override the default compile flags
1414
OverrideCompileFlags:
15-
# Profile with the respective flags to override
16-
"g++":
17-
# Flags to be removed from the default compile flags, separated by space
18-
Remove: ""
19-
20-
# Additional flags to be appended to the default compile flags
21-
Append: ""
15+
# Applies to all platforms (Can be Linux, MacOS, Windows, Unix, etc.)
16+
All:
17+
# Profile with the respective flags to override
18+
"g++":
19+
# Flags to be removed from the default compile flags, separated by space
20+
Remove: ""
21+
22+
# Additional flags to be appended to the default compile flags
23+
Append: ""
24+
2225

2326
# (Optional) Override the default link flags
2427
OverrideLinkFlags:
25-
# Profile with the respective flags to override
26-
"g++":
27-
# Flags to be removed from the default compile flags, separated by space
28-
Remove: ""
29-
30-
# Additional flags to be appended to the default compile flags
31-
Append: ""
28+
# Applies to all platforms
29+
All:
30+
# Profile with the respective flags to override
31+
"g++":
32+
# Flags to be removed from the default compile flags, separated by space
33+
Remove: ""
34+
35+
# Additional flags to be appended to the default compile flags
36+
Append: ""
3237

3338
# (Optional) The list of dependencies needed by the script
3439
Dependencies:

‎DefaultYAMLs/ScriptInfoSchema.json‎

Lines changed: 42 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema#",
33
"title": "Script dependencies",
4-
"description": "Script dependencies setup",
54
"type": "object",
65
"properties":
76
{
8-
"Language":
9-
{
10-
"type": "string",
11-
"description": "(Optional) Language of the script"
12-
},
7+
"Language": { "type": "string" },
138
"RequiredProfiles":
149
{
1510
"type": "object",
@@ -18,13 +13,9 @@
1813
"^.*$":
1914
{
2015
"type": "array",
21-
"items":
22-
{
23-
"type":"string"
24-
}
16+
"items": { "type":"string" }
2517
}
2618
},
27-
"description": "(Optional) Preferred compiler/linker profiles for the script",
2819
"additionalProperties": false
2920
},
3021
"OverrideCompileFlags":
@@ -35,26 +26,24 @@
3526
"^.*$":
3627
{
3728
"type": "object",
38-
"properties":
29+
"patternProperties":
3930
{
40-
"Remove":
31+
"^.*$":
4132
{
42-
"type": "string",
43-
"description": "Flags to be removed from the default compile flags, separated by space"
44-
},
45-
"Append":
46-
{
47-
"type": "string",
48-
"description": "Additional flags to be appended to the default compile flags"
33+
"type": "object",
34+
"properties":
35+
{
36+
"Remove": { "type": "string" },
37+
"Append": { "type": "string" }
38+
},
39+
"additionalProperties": false,
40+
"required": ["Remove", "Append"]
4941
}
5042
},
51-
"additionalProperties": false,
52-
"description": "Profile with the respective flags to override",
53-
"required": ["Remove", "Append"]
43+
"additionalProperties": false
5444
}
5545
},
56-
"additionalProperties": false,
57-
"description": "(Optional) Override the default compile flags"
46+
"additionalProperties": false
5847
},
5948
"OverrideLinkFlags":
6049
{
@@ -64,46 +53,38 @@
6453
"^.*$":
6554
{
6655
"type": "object",
67-
"properties":
56+
"patternProperties":
6857
{
69-
"Remove":
70-
{
71-
"type": "string",
72-
"description": "Flags to be removed from the default compile flags, separated by space"
73-
},
74-
"Append":
58+
"^.*$":
7559
{
76-
"type": "string",
77-
"description": "Additional flags to be appended to the default compile flags"
60+
"type": "object",
61+
"properties":
62+
{
63+
"Remove": { "type": "string" },
64+
"Append": { "type": "string" }
65+
},
66+
"additionalProperties": false,
67+
"required": ["Remove", "Append"]
7868
}
79-
},
80-
"additionalProperties": false,
81-
"description": "Profile with the respective flags to override",
82-
"required": ["Remove", "Append"]
83-
}
69+
}
70+
},
71+
"additionalProperties": false
8472
},
85-
"additionalProperties": false,
86-
"description": "(Optional) Override the default link flags"
73+
"additionalProperties": false
8774
},
8875
"Dependencies":
8976
{
9077
"type": "array",
91-
"description": "(Optional) The list of dependencies needed by the script",
9278
"items":
9379
{
9480
"type": "object",
9581
"properties":
9682
{
97-
"Name":
98-
{
99-
"type": "string",
100-
"description": "Dependency name"
101-
},
83+
"Name": { "type": "string" },
10284
"Platforms":
10385
{
10486
"type": "array",
105-
"items": { "type":"string" },
106-
"description": "Supported platforms of the dependency"
87+
"items": { "type":"string" }
10788
},
10889
"Source":
10990
{
@@ -113,29 +94,21 @@
11394
"Type":
11495
{
11596
"type": "string",
116-
"enum": ["Git", "Local"],
117-
"description": "The type of the dependency (Git/Local)"
97+
"enum": ["Git", "Local"]
11898
},
119-
"Value":
120-
{
121-
"type": "string",
122-
"description": "The location of the dependency (git repository location, local directory)"
123-
}
99+
"Value": { "type": "string" }
124100
},
125-
"required": ["Type", "Value"],
126-
"description": "The source of getting the dependency"
101+
"required": ["Type", "Value"]
127102
},
128103
"LibraryType":
129104
{
130105
"type": "string",
131-
"enum": ["Static", "Object", "Shared", "Header"],
132-
"description": "Library Type (Static, Object, Shared, Header)"
106+
"enum": ["Static", "Object", "Shared", "Header"]
133107
},
134108
"IncludePaths":
135109
{
136110
"type": "array",
137-
"items": { "type":"string" },
138-
"description": "Paths to be added to include paths"
111+
"items": { "type":"string" }
139112
},
140113
"LinkProperties":
141114
{
@@ -150,8 +123,7 @@
150123
"SearchLibraryNames":
151124
{
152125
"type": "array",
153-
"items": { "type":"string" },
154-
"description": "The library name to be searched for when linking against the script"
126+
"items": { "type":"string" }
155127
},
156128
"ExcludeLibraryNames":
157129
{
@@ -161,8 +133,7 @@
161133
"SearchDirectories":
162134
{
163135
"type": "array",
164-
"items": { "type":"string" },
165-
"description": "The path to be searched for the dependency. {BuildType} will be replaced accordingly"
136+
"items": { "type":"string" }
166137
},
167138
"AdditionalLinkOptions":
168139
{
@@ -178,12 +149,10 @@
178149
}
179150
},
180151
"required": ["SearchLibraryNames", "SearchDirectories"],
181-
"additionalProperties": false,
182-
"description": "Properties for searching the library binary for the profile"
152+
"additionalProperties": false
183153
}
184154
},
185-
"additionalProperties": false,
186-
"description": "Searchable properties of the dependency"
155+
"additionalProperties": false
187156
},
188157
"Setup":
189158
{
@@ -198,16 +167,13 @@
198167
"^.*$":
199168
{
200169
"type": "array",
201-
"items": { "type":"string" },
202-
"description": "Setup commands for the specified profile. {BuildType} will be replaced accordingly"
170+
"items": { "type":"string" }
203171
}
204172
},
205-
"additionalProperties": false,
206-
"description": "Setup commands for the specified platform"
173+
"additionalProperties": false
207174
}
208175
},
209-
"additionalProperties": false,
210-
"description": "(Optional) List of setup commands for the supported platforms"
176+
"additionalProperties": false
211177
}
212178
},
213179
"additionalProperties": false,

0 commit comments

Comments
 (0)