Skip to content

Commit ca1a4d8

Browse files
committed
- Add Settings.var_aliases
1 parent 317d16d commit ca1a4d8

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

retype.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ editor:
1313
branding:
1414
logo: assets/logo.svg
1515
logoDark: assets/logo-dark.svg
16-
label: v1.2.6
16+
label: v1.2.7
1717

1818
meta:
1919
title: " | Bashly - Bash Command Line Framework"

src/usage/settings.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,3 +330,33 @@ Specify if you want to populate the `$env_var_names` bash array.
330330

331331
This is applicable only if your script uses the
332332
[Environment Variable](/configuration/environment-variable) configuration option.
333+
334+
## Scripting Options
335+
336+
### `var_aliases`
337+
338+
```yaml
339+
# default
340+
var_aliases:
341+
args: ~
342+
other_args: ~
343+
deps: ~
344+
env_var_names: ~
345+
346+
# example
347+
var_aliases:
348+
args: ARGS
349+
other_args: catch_all
350+
deps: dependencies
351+
env_var_names: ENV_VARS
352+
```
353+
354+
Update one or more of these options in case you wish to change the name of the
355+
public global array that bashly uses for storing data.
356+
357+
Note that this feature will not change the original name, but rather create
358+
an alias using `declare -gn`.
359+
360+
!!! Note
361+
This option cannot be set using environment variables.
362+
!!!

0 commit comments

Comments
 (0)