Type object
File match bashly-settings.yml bashly-settings.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/bashly-settings-bashly-settings-yml/latest.json
Source https://raw.githubusercontent.com/DannyBen/bashly/master/schemas/settings.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Settings of the current application https://bashly.dev/usage/settings/#settings

Properties

source_dir string

The path containing the bashly source files https://bashly.dev/usage/settings/#source_dir

Default: "src"
minLength=1
config_path string
Default: "%{source_dir}/bashly.yml"
minLength=1
target_dir string

The path to use for creating the bash script https://bashly.dev/usage/settings/#target_dir

Default: "."
minLength=1
lib_dir string

The path to use for common library files, relative to source_dir https://bashly.dev/usage/settings/#lib_dir

Default: "lib"
minLength=1
extra_lib_dirs null | string | string[]

One or more paths to use for common library files, relative to the working directory. May be provided as an array or a comma delimited string. https://bashly.dev/usage/settings/#extra_lib_dirs

Default: null
commands_dir string | null

The path to use for command files, relative to source_dir https://bashly.dev/usage/settings/#commands_dir

strict boolean | string

Configure the bash options that will be added to the initialize function https://bashly.dev/usage/settings/#strict

Default: false
tab_indent boolean

Whether to use tabs or spaces in the generated script https://bashly.dev/usage/settings/#tab_indent

Default: false
word_wrap integer

Configure the character width used to wrap help and example messages https://bashly.dev/usage/settings/#word_wrap

Default: 80
compact_short_flags boolean

Whether to expand -abc to -a -b -c in the input line https://bashly.dev/usage/settings/#compact_short_flags

Default: true
conjoined_flag_args boolean

Whether to expand --flag=value to --flag value in the input line https://bashly.dev/usage/settings/#conjoined_flag_args

Default: true
show_examples_on_error boolean

Whether to show command examples when the input line is missing required arguments https://bashly.dev/usage/settings/#show_examples_on_error

Default: true
env string

Whether to include development related comments in the generated script https://bashly.dev/usage/settings/#env

Default: "development"
Values: "development" "production"
enable_header_comment string

Whether to include the header comment in the generated script https://bashly.dev/usage/settings/#enable_header_comment

Default: "always"
Values: "development" "production" "always" "never"
enable_bash3_bouncer string

Whether to include the code snippet that aborts when an old version of bash is detected in the generated script https://bashly.dev/usage/settings/#enable_bash3_bouncer

Default: "always"
Values: "development" "production" "always" "never"
enable_view_markers string

Whether to include view marker comments in the generated script https://bashly.dev/usage/settings/#enable_view_markers

Default: "development"
Values: "development" "production" "always" "never"
enable_inspect_args string

Whether to include the inspect_args function in the generated script https://bashly.dev/usage/settings/#enable_inspect_args

Default: "development"
Values: "development" "production" "always" "never"
enable_deps_array string

Whether to include the code for the dependencies array in the generated script https://bashly.dev/usage/settings/#enable_deps_array

Default: "always"
Values: "development" "production" "always" "never"
enable_env_var_names_array string

Whether to include the code for the env_var_names array in the generated script https://bashly.dev/usage/settings/#enable_env_var_names_array

Default: "always"
Values: "development" "production" "always" "never"
enable_sourcing string

Whether to wrap the script execution in a condition that checks if the script is sourced https://bashly.dev/usage/settings/#enable_sourcing

Default: "development"
Values: "development" "production" "always" "never"
formatter string | string

Choose how to post-process the generated script https://bashly.dev/usage/settings/#formatter

Default: "internal"
partials_extension string

The extension to use when reading/writing partial script snippets https://bashly.dev/usage/settings/#partials_extension

Default: "sh"
minLength=1
private_reveal_key string | null

The name of the environment variable (case sensitive) that, if set, will reveal private commands, flags and environment variables https://bashly.dev/usage/settings/#private_reveal_key

argfile_var string

The name of the environment variable that can override or disable command argfiles at runtime https://bashly.dev/usage/settings/#argfile_var

Default: "ARGFILE"
minLength=1
watch_evented boolean

Whether to use evented file system watch instead of the default polling https://bashly.dev/usage/settings/#watch_evented

Default: false
watch_latency number

The latency in seconds for the file system changes watcher https://bashly.dev/usage/settings/#watch_latency

Default: 1
usage_colors object

Enable and configure colorful output for --help https://bashly.dev/usage/settings/#usage_colors

5 nested properties
caption string | null
command string | null
arg string | null
flag string | null
environment_variable string | null
var_aliases object

Declare alias names for bashly's public global arrays https://bashly.dev/usage/settings/#var_aliases

4 nested properties
args string | null

Alias name for the args array https://bashly.dev/usage/settings/#var_aliases

other_args string | null

Alias name for the other_args array (used when catch_all is enabled) https://bashly.dev/usage/settings/#var_aliases

deps string | null

Alias name for the deps array https://bashly.dev/usage/settings/#var_aliases

env_var_names string | null

Alias name for the env_var_names array https://bashly.dev/usage/settings/#var_aliases

function_names object

Choose different names for some of the internal functions. https://bashly.dev/usage/settings/#function_names

2 nested properties
run string | null
initialize string | null

Name for the initialize() function https://bashly.dev/usage/settings/#function_names

Definitions

color string | null