├── LICENSE
├── README.md
└── bash-debug


/LICENSE:
--------------------------------------------------------------------------------
 1 | DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
 2 | Version 2, December 2004
 3 | Copyright (C) 2004 Sam Hocevar
 4 | 14 rue de Plaisance, 75014 Paris, France
 5 | Everyone is permitted to copy and distribute verbatim or modified
 6 | copies of this license document, and changing it is allowed as long
 7 | as the name is changed.
 8 | DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
 9 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
10 | 0. You just DO WHAT THE FUCK YOU WANT TO.
11 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | A simple debugger for bash.
 2 | 
 3 | Each script command is printed before execution. Then command prompt appears (no autocompletion). Prompt includes the last command return value. You can print a command to execute in the script context or an empty line to continue.
 4 | 
 5 | ```bash
 6 | bash-debug script-to-debug.sh [script args]
 7 | ```
 8 | 
 9 | Note: `set -o functrace` is used, changing DEBUG and RETURN traps inheritance for shell functions.
10 | 


--------------------------------------------------------------------------------
/bash-debug:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | function _bash_debug_print_usage() {
 4 |     echo "Usage: $0 <script to debug> [script args]"
 5 |     echo
 6 |     echo "bash debugger"
 7 |     echo "Each script command is printed before execution"
 8 |     echo "Then command prompt appears (no autocompletion)"
 9 |     echo "Prompt includes the last command return value"
10 |     echo "You can print a command to execute or an empty line to continue"
11 |     echo "Note: set -T is used, changing DEBUG and RETURN traps inheritance"
12 | }
13 | 
14 | function _bash_debug_trap_DEBUG() {
15 |     _bash_debug_last_retcode="$?"
16 | 
17 |     # Skip prompt when starting script itself
18 |     # shellcheck disable=SC2016
19 |     if [ "$BASH_COMMAND" == 'source "$_bash_debug_script" "$@"' ]; then
20 |         return
21 |     fi
22 | 
23 |     echo "# $BASH_COMMAND";
24 |     # -r Do not interpret backslash escaped characters
25 |     # -e Use readline in interactive shell
26 |     # -p PROMPT
27 |     while read -r -e -p "($_bash_debug_last_retcode) debug> " _bash_debug_command; do
28 |         if [ -n "$_bash_debug_command" ]; then
29 |             eval "$_bash_debug_command";
30 |         else
31 |             break;
32 |         fi;
33 |     done
34 | }
35 | 
36 | if [ -z "$1" ]; then
37 |     _bash_debug_print_usage
38 | else
39 |     _bash_debug_script="$1"
40 |     shift
41 |     if [ ! -f "$_bash_debug_script" ]; then
42 |         echo "ERROR: not a readable file: $_bash_debug_script"
43 |         _bash_debug_print_usage
44 |         exit 1
45 |     fi
46 |     # -o functrace  Same as -T. If set, the DEBUG and RETURN traps are inherited by shell functions.
47 |     set -o functrace
48 |     trap '_bash_debug_trap_DEBUG' DEBUG
49 |     # shellcheck disable=SC1090
50 |     source "$_bash_debug_script" "$@"
51 | fi
52 | 


--------------------------------------------------------------------------------