Skip to content

Commit 8c63fcc

Browse files
committed
organize settings into subtopics
1 parent de8731e commit 8c63fcc

File tree

1 file changed

+35
-16
lines changed

1 file changed

+35
-16
lines changed

lib/bashly/libraries/settings/settings.yml

Lines changed: 35 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@
99
# If you wish to change the path to this file, set the environment variable
1010
# BASHLY_SETTINGS_PATH.
1111

12+
13+
#-------------------------------------------------------------------------------
14+
# PATH OPTIONS
15+
#-------------------------------------------------------------------------------
16+
1217
# The path containing the bashly source files
1318
source_dir: src
1419

@@ -27,6 +32,14 @@ lib_dir: lib
2732
# directory, and each command will get its own subdirectory
2833
commands_dir: ~
2934

35+
# The extension to use when reading/writing partial script snippets
36+
partials_extension: sh
37+
38+
39+
#-------------------------------------------------------------------------------
40+
# FORMAT OPTIONS
41+
#-------------------------------------------------------------------------------
42+
3043
# Configure the bash options that will be added to the initialize function:
3144
# strict: true Bash strict mode (set -euo pipefail)
3245
# strict: false Only exit on errors (set -e)
@@ -38,6 +51,11 @@ strict: false
3851
# (every 2 leading spaces will be converted to a tab character)
3952
tab_indent: false
4053

54+
55+
#-------------------------------------------------------------------------------
56+
# INTERFACE OPTIONS
57+
#-------------------------------------------------------------------------------
58+
4159
# When true, the generated script will consider any argument in the form of
4260
# `-abc` as if it is `-a -b -c`.
4361
compact_short_flags: true
@@ -47,9 +65,6 @@ compact_short_flags: true
4765
# respectively.
4866
conjoined_flag_args: true
4967

50-
# The extension to use when reading/writing partial script snippets
51-
partials_extension: sh
52-
5368
# Show command examples (if any) whenever the user does not provide the
5469
# required arguments
5570
show_examples_on_error: false
@@ -59,6 +74,23 @@ show_examples_on_error: false
5974
# all the private elements in the usage texts, as if they were public.
6075
private_reveal_key: ~
6176

77+
# Display various usage elements in color by providing the name of the color
78+
# function. The value for each property is a name of a function that is
79+
# available in your script, for example: `green` or `bold`.
80+
# You can run `bashly add colors` to add a standard colors library.
81+
# This option cannot be set via environment variables.
82+
usage_colors:
83+
caption: ~
84+
command: ~
85+
arg: ~
86+
flag: ~
87+
environment_variable: ~
88+
89+
90+
#-------------------------------------------------------------------------------
91+
# FEATURE TOGGLES
92+
#-------------------------------------------------------------------------------
93+
6294
# Set to 'production' or 'development'.
6395
# Determines which features are enabled in the rendered script.
6496
# Use the `enable_*` options below to adjust settings for each environment.
@@ -78,16 +110,3 @@ enable_view_markers: development
78110
enable_inspect_args: development
79111
enable_deps_array: always
80112
enable_env_var_names_array: always
81-
82-
# Display various usage elements in color by providing the name of the color
83-
# function. The value for each property is a name of a function that is
84-
# available in your script, for example: `green` or `bold`.
85-
# You can run `bashly add colors` to add a standard colors library.
86-
# This option cannot be set via environment variables.
87-
usage_colors:
88-
caption: ~
89-
command: ~
90-
arg: ~
91-
flag: ~
92-
environment_variable: ~
93-

0 commit comments

Comments
 (0)