| Version | Description |
|---|---|
| 0.4.1 | install location |
| name config.sh module.sh and move to install location | |
| 0.4.0 | no-exit-immediatly |
| color support | |
| 0.3.0 | Adopt packages |
| 0.2.0 | Added loader with __import and __module_loaded |
| add fine grained bash option handling | |
| prepend __ to function names | |
| 0.1.0 | Initial version |
| Variable | Since | Description |
|---|---|---|
| shared_logger_tag | 0.1.0 | If set write not only to stdout but to logger |
| Defaults to empty string | ||
| shared_verbose | 0.1.0 | Toggle whether to be verbose on output. |
| If sth else than 1 does only write warnings, errors or explicitly called writealways | ||
| Defaults to 1 |
Include this file always
This sets the install location and some configuration properties. Currently existing variables:
| Variable | Since | Description |
|---|---|---|
| shared_pipefail | 0.2.0 | Enable pipefail only when 1 |
| Defaulting to 1 | ||
| shared_exit_immediatly | 0.2.0 | Exit immediatly when sub command fails |
| Defaulting to 1 | ||
| shared_install_location | 0.1.0 | The location where the scripts are located |
| always use this variable to source other scripts | ||
Defaulting to /opt/sascha-andres/shared-shell |
||
| shared_debug | 0.1.0 | If set turns on debugging with set -x |
Additionally, this sets set -euo pipefail
You do not source modules directly but import them using __import. The loader prevents modules from being loaded multiple times.
Sample:
pkg::import logger # will load logger functions
To check if a module is loaded you can do
if [ $(pkg::module_loaded ${module}) == "n" ]; then
echo not loaded
fi
Provides some helper methods to write output to console/logger. Prepend each function with logger::
To turn off colored output set shared_logger_colored=0
Print out a header to denote a section
Sample call:
logger::header "header"
Will print
<empty line>
*** header ***
<empty line>
Print out text
Sample call:
logger::write "hello world"
Will print
hello world
Same as write but prints out even if shared_verbose=0
Write a warning to stdout. Use this to indicate a problem that allows to continue.
Sample call:
logger::warn "warn"
Will print
?? warn ??
Write an error to stderr. Use this this indicate a problem that result in stopping the execution.
Sample call:
logger::error "error"
Will print
!! error !!
Write a log message to stdout
Sample call:
logger::log "log"
Will print
--> log
Variable shared_exec_err_ocurred is used to have exit code for check_and_error and signalled_exit in sync. . Prepend each function with executing::
Wraps the command in +e/-e
Print out an error based on parameter 1, message passed as parameter 2.
Paramter 1 defaults to -1, error message to 'wrong call; defaulting to error'
Executes the given parameter (one!) and evaluates the return code with check_and_exit
Prepend each function with exiting::
Exits if check_and_error was called with a non zero result code
Exit the script based on parameter 1, message passed as parameter 2 printed out as error. Calls quit from exiting.sh
Paramter 1 defaults to -1, error message to 'wrong call; defaulting to error'
Prints a log line with exit code and ends script execution