9
9
# If you wish to change the path to this file, set the environment variable
10
10
# BASHLY_SETTINGS_PATH.
11
11
12
+
13
+ # -------------------------------------------------------------------------------
14
+ # PATH OPTIONS
15
+ # -------------------------------------------------------------------------------
16
+
12
17
# The path containing the bashly source files
13
18
source_dir : src
14
19
@@ -27,6 +32,14 @@ lib_dir: lib
27
32
# directory, and each command will get its own subdirectory
28
33
commands_dir : ~
29
34
35
+ # The extension to use when reading/writing partial script snippets
36
+ partials_extension : sh
37
+
38
+
39
+ # -------------------------------------------------------------------------------
40
+ # FORMAT OPTIONS
41
+ # -------------------------------------------------------------------------------
42
+
30
43
# Configure the bash options that will be added to the initialize function:
31
44
# strict: true Bash strict mode (set -euo pipefail)
32
45
# strict: false Only exit on errors (set -e)
@@ -38,6 +51,11 @@ strict: false
38
51
# (every 2 leading spaces will be converted to a tab character)
39
52
tab_indent : false
40
53
54
+
55
+ # -------------------------------------------------------------------------------
56
+ # INTERFACE OPTIONS
57
+ # -------------------------------------------------------------------------------
58
+
41
59
# When true, the generated script will consider any argument in the form of
42
60
# `-abc` as if it is `-a -b -c`.
43
61
compact_short_flags : true
@@ -47,9 +65,6 @@ compact_short_flags: true
47
65
# respectively.
48
66
conjoined_flag_args : true
49
67
50
- # The extension to use when reading/writing partial script snippets
51
- partials_extension : sh
52
-
53
68
# Show command examples (if any) whenever the user does not provide the
54
69
# required arguments
55
70
show_examples_on_error : false
@@ -59,6 +74,23 @@ show_examples_on_error: false
59
74
# all the private elements in the usage texts, as if they were public.
60
75
private_reveal_key : ~
61
76
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
+
62
94
# Set to 'production' or 'development'.
63
95
# Determines which features are enabled in the rendered script.
64
96
# Use the `enable_*` options below to adjust settings for each environment.
@@ -78,16 +110,3 @@ enable_view_markers: development
78
110
enable_inspect_args : development
79
111
enable_deps_array : always
80
112
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