Skip to content

Commit 72b03d8

Browse files
DannyBenDannyBen
committed
update settings schema descriptions
1 parent 30189c4 commit 72b03d8

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

‎schemas/settings.json

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,35 +40,35 @@
4040
"properties": {
4141
"source_dir": {
4242
"title": "source dir",
43-
"description": "A directory with source files of the current script\nhttps://bashly.dannyb.co/usage/settings/#source_dir",
43+
"description": "The path containing the bashly source files\nhttps://bashly.dannyb.co/usage/settings/#source_dir",
4444
"type": "string",
4545
"minLength": 1,
4646
"default": "src"
4747
},
4848
"config_path": {
4949
"title": "config path",
50-
"description": "A path to bashly.yml of the current script\nhttps://bashly.dannyb.co/usage/settings/#config_path",
50+
"description": "The path to bashly.yml\nhttps://bashly.dannyb.co/usage/settings/#config_path",
5151
"type": "string",
5252
"minLength": 1,
5353
"default": "%{source_dir}/bashly.yml"
5454
},
5555
"target_dir": {
5656
"title": "target dir",
57-
"description": "A directory of the current script\nhttps://bashly.dannyb.co/usage/settings/#target_dir",
57+
"description": "The path to use for creating the bash script\nhttps://bashly.dannyb.co/usage/settings/#target_dir",
5858
"type": "string",
5959
"minLength": 1,
6060
"default": "."
6161
},
6262
"lib_dir": {
6363
"title": "lib dir",
64-
"description": "A directory to common library files of the current script\nhttps://bashly.dannyb.co/usage/settings/#lib_dir",
64+
"description": "The path to use for common library files, relative to source_dir\nhttps://bashly.dannyb.co/usage/settings/#lib_dir",
6565
"type": "string",
6666
"minLength": 1,
6767
"default": "lib"
6868
},
6969
"commands_dir": {
7070
"title": "commands dir",
71-
"description": "A directory to nested command files of the current script\nhttps://bashly.dannyb.co/usage/settings/#commands_dir",
71+
"description": "The path to use for command files, relative to source_dir\nhttps://bashly.dannyb.co/usage/settings/#commands_dir",
7272
"oneOf": [
7373
{
7474
"type": "string",
@@ -81,7 +81,7 @@
8181
},
8282
"strict": {
8383
"title": "strict",
84-
"description": "Bash initialization options of the current script\nhttps://bashly.dannyb.co/usage/settings/#strict",
84+
"description": "Configure the bash options that will be added to the initialize function\nhttps://bashly.dannyb.co/usage/settings/#strict",
8585
"oneOf": [
8686
{
8787
"type": "boolean"
@@ -97,7 +97,7 @@
9797
},
9898
"tab_indent": {
9999
"title": "tab indent",
100-
"description": "Whether to use tabs in the the current script\nhttps://bashly.dannyb.co/usage/settings/#tab_indent",
100+
"description": "Whether to use tabs or spaces in the the generated script\nhttps://bashly.dannyb.co/usage/settings/#tab_indent",
101101
"type": "boolean",
102102
"default": false
103103
},
@@ -115,7 +115,7 @@
115115
},
116116
"env": {
117117
"title": "env",
118-
"description": "Whether to include development related comments in the current script\nhttps://bashly.dannyb.co/usage/settings/#env",
118+
"description": "Whether to include development related comments in the generated script\nhttps://bashly.dannyb.co/usage/settings/#env",
119119
"type": "string",
120120
"enum": [
121121
"development",
@@ -125,39 +125,39 @@
125125
},
126126
"partials_extension": {
127127
"title": "partials extension",
128-
"description": "A partial snippet extension of the current script\nhttps://bashly.dannyb.co/usage/settings/#partials_extension",
128+
"description": "The extension to use when reading/writing partial script snippets\nhttps://bashly.dannyb.co/usage/settings/#partials_extension",
129129
"type": "string",
130130
"minLength": 1,
131131
"default": "sh"
132132
},
133133
"usage_colors": {
134134
"title": "usage colors",
135-
"description": "Usage colors of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
135+
"description": "Enable and configure colorful output for --help\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
136136
"type": "object",
137137
"properties": {
138138
"caption": {
139139
"title": "caption",
140-
"description": "A caption color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
140+
"description": "Color for captions\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
141141
"$ref": "#/definitions/color"
142142
},
143143
"command": {
144144
"title": "command",
145-
"description": "A command color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
145+
"description": "Color for commands\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
146146
"$ref": "#/definitions/color"
147147
},
148148
"arg": {
149149
"title": "arg",
150-
"description": "An argument color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
150+
"description": "Color for positional arguments\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
151151
"$ref": "#/definitions/color"
152152
},
153153
"flag": {
154154
"title": "flag",
155-
"description": "A flag color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
155+
"description": "Color for flags\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
156156
"$ref": "#/definitions/color"
157157
},
158158
"environment_variable": {
159159
"title": "environment variable",
160-
"description": "An environment variable color of the current script\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
160+
"description": "Color for env environment variables\nhttps://bashly.dannyb.co/usage/settings/#usage_colors",
161161
"$ref": "#/definitions/color"
162162
}
163163
},

0 commit comments

Comments
 (0)