Skip to content

Commit ec22431

Browse files
EmilySeville7cfgEmilySeville7cfg
authored andcommitted
feat(strings): add doc refs
1 parent 1632c2a commit ec22431

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

schemas/strings.json

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,201 +1,201 @@
11
{
22
"$schema": "http://json-schema.org/draft-07/schema",
33
"title": "strings",
4-
"description": "Strings of the current application",
4+
"description": "Strings of the current application\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
55
"type": "object",
66
"properties": {
77
"usage": {
88
"title": "usage",
9-
"description": "A usage caption of the current script",
9+
"description": "A usage caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
1010
"type": "string",
1111
"minLength": 1,
1212
"default": "Usage:"
1313
},
1414
"options": {
1515
"title": "options",
16-
"description": "An option caption of the current script",
16+
"description": "An option caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
1717
"type": "string",
1818
"minLength": 1,
1919
"default": "Options:"
2020
},
2121
"arguments": {
2222
"title": "arguments",
23-
"description": "An argument caption of the current script",
23+
"description": "An argument caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
2424
"type": "string",
2525
"minLength": 1,
2626
"default": "Arguments:"
2727
},
2828
"commands": {
2929
"title": "commands",
30-
"description": "A command caption of the current script",
30+
"description": "A command caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
3131
"type": "string",
3232
"minLength": 1,
3333
"default": "Commands:"
3434
},
3535
"examples": {
3636
"title": "examples",
37-
"description": "An example caption of the current script",
37+
"description": "An example caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
3838
"type": "string",
3939
"minLength": 1,
4040
"default": "Examples:"
4141
},
4242
"environment_variables": {
4343
"title": "environment variables",
44-
"description": "An environment variable caption of the current script",
44+
"description": "An environment variable caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
4545
"type": "string",
4646
"minLength": 1,
4747
"default": "Environment Variables:"
4848
},
4949
"group": {
5050
"title": "group",
51-
"description": "A group caption of the current script",
51+
"description": "A group caption of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
5252
"type": "string",
5353
"minLength": 1,
5454
"default": "%{group} Commands:"
5555
},
5656
"command_alias": {
5757
"title": "command alias",
58-
"description": "An alias helper of the current script",
58+
"description": "An alias helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
5959
"type": "string",
6060
"minLength": 1,
6161
"default": "Alias: %{alias}"
6262
},
6363
"default_command_summary": {
6464
"title": "default command summary",
65-
"description": "A default command summary helper of the current script",
65+
"description": "A default command summary helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
6666
"type": "string",
6767
"minLength": 1,
6868
"default": "%{summary} (default)"
6969
},
7070
"required": {
7171
"title": "required",
72-
"description": "A required helper of the current script",
72+
"description": "A required helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
7373
"type": "string",
7474
"minLength": 1,
7575
"default": "(required)"
7676
},
7777
"repeatable": {
7878
"title": "repeatable",
79-
"description": "A repeatable helper of the current script",
79+
"description": "A repeatable helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
8080
"type": "string",
8181
"minLength": 1,
8282
"default": "(repeatable)"
8383
},
8484
"default": {
8585
"title": "default",
86-
"description": "A default helper of the current script",
86+
"description": "A default helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
8787
"type": "string",
8888
"minLength": 1,
8989
"default": "Default: %{value}"
9090
},
9191
"allowed": {
9292
"title": "allowed",
93-
"description": "An allowed helper of the current script",
93+
"description": "An allowed helper of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
9494
"type": "string",
9595
"minLength": 1,
9696
"default": "Allowed: %{values}"
9797
},
9898
"help_flag_text": {
9999
"title": "help flag text",
100-
"description": "A help flag of the current script",
100+
"description": "A help flag of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
101101
"type": "string",
102102
"minLength": 1,
103103
"default": "Show this help"
104104
},
105105
"version_flag_text": {
106106
"title": "version flag text",
107-
"description": "A version flag of the current script",
107+
"description": "A version flag of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
108108
"type": "string",
109109
"minLength": 1,
110110
"default": "Show version number"
111111
},
112112
"flag_requires_an_argument": {
113113
"title": "flag requires an argument",
114-
"description": "A missing flag argument error of the current script",
114+
"description": "A missing flag argument error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
115115
"type": "string",
116116
"minLength": 1,
117117
"default": "%{name} requires an argument: %{usage}"
118118
},
119119
"invalid_argument": {
120120
"title": "invalid argument",
121-
"description": "An invalid argument error of the current script",
121+
"description": "An invalid argument error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
122122
"type": "string",
123123
"minLength": 1,
124124
"default": "invalid argument: %s"
125125
},
126126
"invalid_flag": {
127127
"title": "invalid flag",
128-
"description": "An invalid option error of the current script",
128+
"description": "An invalid option error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
129129
"type": "string",
130130
"minLength": 1,
131131
"default": "invalid option: %s"
132132
},
133133
"invalid_command": {
134134
"title": "invalid command",
135-
"description": "An invalid command error of the current script",
135+
"description": "An invalid command error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
136136
"type": "string",
137137
"minLength": 1,
138138
"default": "invalid command: %s"
139139
},
140140
"conflicting_flags": {
141141
"title": "conflicting flags",
142-
"description": "A conflicting options error of the current script",
142+
"description": "A conflicting options error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
143143
"type": "string",
144144
"minLength": 1,
145145
"default": "conflicting options: %s cannot be used with %s"
146146
},
147147
"missing_required_argument": {
148148
"title": "missing required argument",
149-
"description": "A missing required argument error of the current script",
149+
"description": "A missing required argument error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
150150
"type": "string",
151151
"minLength": 1,
152152
"default": "missing required argument: %{arg}\\nusage: %{usage}"
153153
},
154154
"missing_required_flag": {
155155
"title": "missing required flag",
156-
"description": "A missing required flag error of the current script",
156+
"description": "A missing required flag error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
157157
"type": "string",
158158
"minLength": 1,
159159
"default": "missing required flag: %{usage}"
160160
},
161161
"missing_required_environment_variable": {
162162
"title": "missing required environment variable",
163-
"description": "A missing required environment variable error of the current script",
163+
"description": "A missing required environment variable error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
164164
"type": "string",
165165
"minLength": 1,
166166
"default": "missing required environment variable: %{var}"
167167
},
168168
"missing_dependency": {
169169
"title": "missing dependency",
170-
"description": "A missing dependency error of the current script",
170+
"description": "A missing dependency error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
171171
"type": "string",
172172
"minLength": 1,
173173
"default": "missing dependency: %{dependency}"
174174
},
175175
"disallowed_flag": {
176176
"title": "disallowed flag",
177-
"description": "A forbidden flag error of the current script",
177+
"description": "A forbidden flag error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
178178
"type": "string",
179179
"minLength": 1,
180180
"default": "%{name} must be one of: %{allowed}"
181181
},
182182
"disallowed_argument": {
183183
"title": "disallowed argument",
184-
"description": "A forbidden argument error of the current script",
184+
"description": "A forbidden argument error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
185185
"type": "string",
186186
"minLength": 1,
187187
"default": "%{name} must be one of: %{allowed}"
188188
},
189189
"unsupported_bash_version": {
190190
"title": "unsupported bash version",
191-
"description": "An unsupported Bash version error of the current script",
191+
"description": "An unsupported Bash version error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
192192
"type": "string",
193193
"minLength": 1,
194194
"default": "bash version 4 or higher is required"
195195
},
196196
"validation_error": {
197197
"title": "validation error",
198-
"description": "A validation error of the current script",
198+
"description": "A validation error of the current script\nhttps://bashly.dannyb.co/advanced/strings/#custom-strings",
199199
"type": "string",
200200
"minLength": 1,
201201
"default": "validation error in %s:\\n%s"

0 commit comments

Comments
 (0)