@@ -43,7 +43,7 @@ When setting environment variables, you can use:
4343- ` 0 ` , ` false ` or ` no ` to represent false
4444- ` 1 ` , ` true ` or ` yes ` to represent true
4545
46- ## Options
46+ ## Path Options
4747
4848### ` source_dir `
4949
@@ -104,6 +104,20 @@ recommended to enable this by setting it to something like
104104
105105[!button variant="primary" icon="code-review" text="Command Paths Example"](https://github.com/DannyBen/bashly/tree/master/examples/command-paths#readme)
106106
107+ # ## `partials_extension`
108+
109+ ` ` ` yaml
110+ # default
111+ partials_extension: sh
112+
113+ # example
114+ partials_extension: bash
115+ ` ` `
116+
117+ Set the extension to use when reading/writing partial script snippets.
118+
119+ # # Format Options
120+
107121# ## `strict`
108122
109123` ` ` yaml
@@ -137,6 +151,8 @@ Specify the indentation style of the generated script.
137151- `tab_indent : true` - Indent with Tab (every 2 leading spaces will be converted
138152 to a tab character).
139153
154+ # # Interface Options
155+
140156# ## `compact_short_flags`
141157
142158` ` ` yaml
@@ -162,19 +178,6 @@ or `-f=value`
162178- `conjoined_flag_args : true` - Expand `--flag=value` to `--flag value` and `-f=value` to `-f value`.
163179- `conjoined_flag_args : false` - Do not expand `--flag=value` or `-f=value` (consider this an invalid input).
164180
165- # ## `partials_extension`
166-
167- ` ` ` yaml
168- # default
169- partials_extension: sh
170-
171- # example
172- partials_extension: bash
173- ` ` `
174-
175- Set the extension to use when reading/writing partial script snippets.
176-
177-
178181# ## `show_examples_on_error`
179182
180183` ` ` yaml
@@ -188,7 +191,6 @@ provide the required arguments.
188191
189192[!button variant="primary" icon="code-review" text="Show Examples on Error Example"](https://github.com/DannyBen/bashly/tree/master/examples/command-examples-on-error#readme)
190193
191-
192194# ## `private_reveal_key`
193195
194196` ` ` yaml
@@ -205,6 +207,40 @@ all the private elements in the usage texts, as if they were public.
205207
206208[!button variant="primary" icon="code-review" text="Private Reveal Example"](https://github.com/DannyBen/bashly/tree/master/examples/private-reveal#readme)
207209
210+ # ## `usage_colors`
211+
212+ ` ` ` yaml
213+ # default
214+ usage_colors:
215+ caption: ~
216+ command: ~
217+ arg: ~
218+ flag: ~
219+ environment_variable: ~
220+
221+ # example
222+ usage_colors:
223+ caption: bold
224+ command: green_underlined
225+ arg: blue
226+ flag: magenta
227+ environment_variable: cyan_bold
228+ ` ` `
229+
230+ Enable color output for several aspects of the help message of the generated
231+ script. Each of these options may be a name of a color function that exists in
232+ your script, for example : ` green` or `bold`.
233+
234+ You can run `bashly add colors` to add a standard colors library.
235+
236+ !!! Note
237+ This option cannot be set using environment variables.
238+ !!!
239+
240+ [!button variant="primary" icon="code-review" text="Usage Colors Example"](https://github.com/DannyBen/bashly/tree/master/examples/colors-usage#readme)
241+
242+ # # Feature Toggles
243+
208244# ## `env`
209245
210246` ` ` yaml
@@ -294,35 +330,3 @@ Specify if you want to populate the `$env_var_names` bash array.
294330
295331This is applicable only if your script uses the
296332[Environment Variable](/configuration/environment-variable) configuration option.
297-
298- # ## `usage_colors`
299-
300- ` ` ` yaml
301- # default
302- usage_colors:
303- caption: ~
304- command: ~
305- arg: ~
306- flag: ~
307- environment_variable: ~
308-
309- # example
310- usage_colors:
311- caption: bold
312- command: green_underlined
313- arg: blue
314- flag: magenta
315- environment_variable: cyan_bold
316- ` ` `
317-
318- Enable color output for several aspects of the help message of the generated
319- script. Each of these options may be a name of a color function that exists in
320- your script, for example : ` green` or `bold`.
321-
322- You can run `bashly add colors` to add a standard colors library.
323-
324- !!! Note
325- This option cannot be set using environment variables.
326- !!!
327-
328- [!button variant="primary" icon="code-review" text="Usage Colors Example"](https://github.com/DannyBen/bashly/tree/master/examples/colors-usage#readme)
0 commit comments