Skip to content

Commit e8c685a

Browse files
DannyBenDannyBen
authored
Merge pull request #382 from DannyBen/feature/add-custom-strings-schema
Feature: add schema for strings.yml
2 parents e83be44 + d862fc0 commit e8c685a

File tree

1 file changed

+205
-0
lines changed

1 file changed

+205
-0
lines changed

‎schemas/strings.json‎

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-07/schema",
3+
"title": "strings",
4+
"description": "Strings of the current application",
5+
"type": "object",
6+
"properties": {
7+
"usage": {
8+
"title": "usage",
9+
"description": "A usage caption of the current script",
10+
"type": "string",
11+
"minLength": 1,
12+
"default": "Usage:"
13+
},
14+
"options": {
15+
"title": "options",
16+
"description": "An option caption of the current script",
17+
"type": "string",
18+
"minLength": 1,
19+
"default": "Options:"
20+
},
21+
"arguments": {
22+
"title": "arguments",
23+
"description": "An argument caption of the current script",
24+
"type": "string",
25+
"minLength": 1,
26+
"default": "Arguments:"
27+
},
28+
"commands": {
29+
"title": "commands",
30+
"description": "A command caption of the current script",
31+
"type": "string",
32+
"minLength": 1,
33+
"default": "Commands:"
34+
},
35+
"examples": {
36+
"title": "examples",
37+
"description": "An example caption of the current script",
38+
"type": "string",
39+
"minLength": 1,
40+
"default": "Examples:"
41+
},
42+
"environment_variables": {
43+
"title": "environment variables",
44+
"description": "An environment variable caption of the current script",
45+
"type": "string",
46+
"minLength": 1,
47+
"default": "Environment Variables:"
48+
},
49+
"group": {
50+
"title": "group",
51+
"description": "A group caption of the current script",
52+
"type": "string",
53+
"minLength": 1,
54+
"default": "%{group} Commands:"
55+
},
56+
"command_alias": {
57+
"title": "command alias",
58+
"description": "An alias helper of the current script",
59+
"type": "string",
60+
"minLength": 1,
61+
"default": "Alias: %{alias}"
62+
},
63+
"default_command_summary": {
64+
"title": "default command summary",
65+
"description": "A default command summary helper of the current script",
66+
"type": "string",
67+
"minLength": 1,
68+
"default": "%{summary} (default)"
69+
},
70+
"required": {
71+
"title": "required",
72+
"description": "A required helper of the current script",
73+
"type": "string",
74+
"minLength": 1,
75+
"default": "(required)"
76+
},
77+
"repeatable": {
78+
"title": "repeatable",
79+
"description": "A repeatable helper of the current script",
80+
"type": "string",
81+
"minLength": 1,
82+
"default": "(repeatable)"
83+
},
84+
"default": {
85+
"title": "default",
86+
"description": "A default helper of the current script",
87+
"type": "string",
88+
"minLength": 1,
89+
"default": "Default: %{value}"
90+
},
91+
"allowed": {
92+
"title": "allowed",
93+
"description": "An allowed helper of the current script",
94+
"type": "string",
95+
"minLength": 1,
96+
"default": "Allowed: %{values}"
97+
},
98+
"help_flag_text": {
99+
"title": "help flag text",
100+
"description": "A help flag of the current script",
101+
"type": "string",
102+
"minLength": 1,
103+
"default": "Show this help"
104+
},
105+
"version_flag_text": {
106+
"title": "version flag text",
107+
"description": "A version flag of the current script",
108+
"type": "string",
109+
"minLength": 1,
110+
"default": "Show version number"
111+
},
112+
"flag_requires_an_argument": {
113+
"title": "flag requires an argument",
114+
"description": "A missing flag argument error of the current script",
115+
"type": "string",
116+
"minLength": 1,
117+
"default": "%{name} requires an argument: %{usage}"
118+
},
119+
"invalid_argument": {
120+
"title": "invalid argument",
121+
"description": "An invalid argument error of the current script",
122+
"type": "string",
123+
"minLength": 1,
124+
"default": "invalid argument: %s"
125+
},
126+
"invalid_flag": {
127+
"title": "invalid flag",
128+
"description": "An invalid option error of the current script",
129+
"type": "string",
130+
"minLength": 1,
131+
"default": "invalid option: %s"
132+
},
133+
"invalid_command": {
134+
"title": "invalid command",
135+
"description": "An invalid command error of the current script",
136+
"type": "string",
137+
"minLength": 1,
138+
"default": "invalid command: %s"
139+
},
140+
"conflicting_flags": {
141+
"title": "conflicting flags",
142+
"description": "A conflicting options error of the current script",
143+
"type": "string",
144+
"minLength": 1,
145+
"default": "conflicting options: %s cannot be used with %s"
146+
},
147+
"missing_required_argument": {
148+
"title": "missing required argument",
149+
"description": "A missing required argument error of the current script",
150+
"type": "string",
151+
"minLength": 1,
152+
"default": "missing required argument: %{arg}\\nusage: %{usage}"
153+
},
154+
"missing_required_flag": {
155+
"title": "missing required flag",
156+
"description": "A missing required flag error of the current script",
157+
"type": "string",
158+
"minLength": 1,
159+
"default": "missing required flag: %{usage}"
160+
},
161+
"missing_required_environment_variable": {
162+
"title": "missing required environment variable",
163+
"description": "A missing required environment variable error of the current script",
164+
"type": "string",
165+
"minLength": 1,
166+
"default": "missing required environment variable: %{var}"
167+
},
168+
"missing_dependency": {
169+
"title": "missing dependency",
170+
"description": "A missing dependency error of the current script",
171+
"type": "string",
172+
"minLength": 1,
173+
"default": "missing dependency: %{dependency}"
174+
},
175+
"disallowed_flag": {
176+
"title": "disallowed flag",
177+
"description": "A forbidden flag error of the current script",
178+
"type": "string",
179+
"minLength": 1,
180+
"default": "%{name} must be one of: %{allowed}"
181+
},
182+
"disallowed_argument": {
183+
"title": "disallowed argument",
184+
"description": "A forbidden argument error of the current script",
185+
"type": "string",
186+
"minLength": 1,
187+
"default": "%{name} must be one of: %{allowed}"
188+
},
189+
"unsupported_bash_version": {
190+
"title": "unsupported bash version",
191+
"description": "An unsupported Bash version error of the current script",
192+
"type": "string",
193+
"minLength": 1,
194+
"default": "bash version 4 or higher is required"
195+
},
196+
"validation_error": {
197+
"title": "validation error",
198+
"description": "A validation error of the current script",
199+
"type": "string",
200+
"minLength": 1,
201+
"default": "validation error in %s:\\n%s"
202+
}
203+
},
204+
"additionalProperties": false
205+
}

0 commit comments

Comments
 (0)