Merge pull request #4 from doekman/small-ideas

Many helpful ideas from Doeke

.ok

@@ -1,13 +1,15 @@
-# Manipulate customizations (colors)                                                                                                                                         
+# Manipulate customizations (colors)                                                                                                                                          
 unset _OK_C_HEADING;unset _OK_C_NUMBER;unset _OK_C_COMMENT;unset _OK_C_COMMAND;unset _OK_C_PROMPT                           #Reset colors to defaults                    
 _OK_C_HEADING="[h]";_OK_C_NUMBER="[n]";_OK_C_COMMENT="[--]";_OK_C_COMMAND="[C]";_OK_C_PROMPT="[p]"                          #Change colors to text markers for debugging 
 _OK_C_HEADING=$'\033[1;30;45m';_OK_C_NUMBER=$'\033[1;33;44m ';_OK_C_COMMENT=$'\033[1;34;46m';_OK_C_COMMAND=$'\033[1;37;44m' #Custom color scheme                         
-# Other customizations                                                                                                             
-unset _OK_PROMPT; unset _OK_VERBOSE  # Reset to defaults                                                                       
-_OK_PROMPT="-=> "; _OK_VERBOSE=2     # Show a "nice" prompt, and give all the feedback ok can provide for                      
-_OK_PROMPT="% "; _OK_VERBOSE=0       # Show ancient prompt, and only say the most necessary (don't even show executed command) 
+# Other customizations                                                                                                                                             
+unset _OK_PROMPT; unset _OK_VERBOSE; unset _OK_LIST_PROMPT  # Reset to defaults                                                                               
+_OK_PROMPT="-=> "; _OK_VERBOSE=2; _OK_PROMPT_DEFAULT=1      # Show a "nice" prompt, and give all the feedback ok can provide for, and default list'n'prompt   
+_OK_PROMPT="% "; _OK_VERBOSE=0; _OK_PROMPT_DEFAULT=0        # Show ancient prompt, and only say the most necessary (don't even show executed command)         
 
-# Tests arguments passing (you can pass arguments after <number>, both at the bash-prompt and the ok-prompt)                              
-echo "Passed arguments: 1:[$1], 2:[$2], 3:[$3], 4+:[${@:4}] (nr args: $#)" # Comment-color starts too early; clearly a bug (so better 
-echo "All passed arguments: [$@]"                                          # not to use a number sign in a command for now)...        
-ok help --verbose                                                          # Show help page of 🆗, including environment variables
+# Tests arguments passing (you can pass arguments after <number>, both at the bash-prompt and the ok-prompt)                                
+echo "Passed arguments: 1:[$1], 2:[$2], 3:[$3], 4+:[${@:4}] (nr args: $#)" # Comment-color starts too early; clearly a bug (so better  
+echo "All passed arguments: [$@]"                                          # not to use a number sign in a command for now)...         
+
+ok help --verbose                                                          # Show help page of 🆗, including environment variables     
+set | grep "^_OK_"                                                         # Show all set environment variables, used with ok-bash     

ok.sh

@@ -1,37 +1,53 @@
 #!/usr/bin/env bash
 
-# tip: "." (i.e. source) this file from your profile (.bashrc), e.g. ". ~/path/to/ok-bash/ok.sh"
+called=$_
+
+#basically, get the absolute path of this script (handy for loads of things)
+pushd "$(dirname "${BASH_SOURCE[0]}")" > /dev/null;
+_OK__PATH_TO_ME=$(pwd)
+popd > /dev/null;
+
 
 ok() {
     function _ok_cmd_usage {
         unset -f _ok_cmd_usage #emulate a "local" function
+        if [[ $show_prompt == 1 ]]; then
+            local list_default="" list_prompt_default=" Default command."
+        else
+            local list_default=" Default command." list_prompt_default=""
+        fi
         echo -e "Usage: ok [options] <number> [script-arguments..]
        ok command [options]
 
 command (use one):
-  <number>        Run the <number>th command from the '.ok' file.
-  l, list         Show the list from the '.ok' file.
-  L, list-once    Same as list, but only show when pwd is different from when the list was last shown.
-  p, list-prompt  Show the list and wait for input at the ok-prompt (like --list and <number> in one command). Default command.
-  h, help         Show this usage page.
+  <number>           Run the <number>th command from the '.ok' file.
+  l, list            Show the list from the '.ok' file.$list_default
+  L, list-once       Same as list, but only show when pwd is different from when the list was last shown.
+  p, list-prompt     Show the list and wait for input at the ok-prompt (like --list and <number> in one command).$list_prompt_default
+  h, help            Show this usage page.
 options:
-  -v, --verbose   Show more output, most of the time to stderr.
-  -q, --quiet     Only show really necessary output.
+  -v, --verbose      Show more output, most of the time to stderr.
+  -q, --quiet        Only show really necessary output.
 script-arguments:
-  ...             These are passed through, when a line is executed (you can enter these too at the ok-prompt)\n"
+  ...                These are passed through, when a line is executed (you can enter these too at the ok-prompt)\n"
 
         if [[ $verbose -ge 2 ]]; then
-            if [ -z ${_OK_PROMPT+x} ];    then local p="unset";  else local p="'$_OK_PROMPT'";  fi
-            if [ -z ${_OK_VERBOSE+x} ];   then local v="unset";  else local v="'$_OK_VERBOSE'"; fi
+            if [ -z ${_OK_PROMPT+x} ];         then local p="unset";  else local p="'$_OK_PROMPT'"; fi
+            if [ -z ${_OK_VERBOSE+x} ];        then local v="unset";  else local v="$_OK_VERBOSE"; fi
+            if [ -z ${_OK_PROMPT_DEFAULT+x} ]; then local l="unset";  else local l="$_OK_PROMPT_DEFAULT"; fi
             echo -e "environment variables (used for colored output; current colors are shown):
-  _OK_C_HEADING   ${_OK_C_HEADING}Color-code${C_NC} for lines starting with a comment (heading). Defaults to red.
-  _OK_C_NUMBER    ${_OK_C_NUMBER}Color-code${C_NC} for numbering. Defaults to cyan.
-  _OK_C_COMMENT   ${_OK_C_COMMENT}Color-code${C_NC} for comments after commands. Defaults to blue.
-  _OK_C_COMMAND   ${_OK_C_COMMAND}Color-code${C_NC} for commands. Defaults to color-reset.
-  _OK_C_PROMPT    ${_OK_C_PROMPT}Color-code${C_NC} for prompt (both input as command confirmation). Defaults to color for numbering.
-environment variables (other):
-  _OK_PROMPT      String ($p) used as prompt (both input as command confirmation). Defaults to '$ '.
-  _OK_VERBOSE     Level ($v) of feedback ok provides. 0=quiet, 1=normal, 2=verbose. Defaults to 1. Can be overriden with --verbose or --quiet.\n"
+  _OK_C_HEADING      ${_OK_C_HEADING}Color-code${C_NC} for lines starting with a comment (heading). Defaults to red.
+  _OK_C_NUMBER       ${_OK_C_NUMBER}Color-code${C_NC} for numbering. Defaults to cyan.
+  _OK_C_COMMENT      ${_OK_C_COMMENT}Color-code${C_NC} for comments after commands. Defaults to blue.
+  _OK_C_COMMAND      ${_OK_C_COMMAND}Color-code${C_NC} for commands. Defaults to color-reset.
+  _OK_C_PROMPT       ${_OK_C_PROMPT}Color-code${C_NC} for prompt (both input as command confirmation). Defaults to color for numbering.
+environment variables (other configuration):
+  _OK_PROMPT         String ($p) used as prompt (both input as command confirmation). Defaults to '$ '.
+  _OK_PROMPT_DEFAULT Setting ($l) if the prompt is default shown. 1=use command list-prompt when issuing no command, otherwise use list.
+  _OK_VERBOSE        Level ($v) of feedback ok provides. 0=quiet, 1=normal, 2=verbose. Defaults to 1. Can be overriden with --verbose or --quiet.
+environment variables (for internal use):
+  _OK__LAST_PWD      Remember the path ($_OK__LAST_PWD) that was last listed, for use with the list-once command.
+  _OK__PATH_TO_ME    The path ($_OK__PATH_TO_ME) to the location of this script.\n"
         fi
         if [[ -n $1 ]]; then
             echo -e "$1\n"
@@ -63,17 +79,21 @@ environment variables (other):
 
     function _ok_cmd_list {
         unset -f _ok_cmd_list
+        # determine number of command lines (need to trim on macOS)
+        nr_lines=$(cat .ok | egrep "^[^#]"  | wc -l | sed 's/^[ \t]*//')
+
         # list the content of the file, with a number (1-based) before each line,
         # except lines starting with a "#", those are printed red without a number) as headers
-        cat .ok | awk -v h="$C_HEADING" -v n="$C_NUMBER" -v c="$C_COMMENT" -v m="$C_COMMAND" -v x="$C_NC" $'
+        cat .ok | awk -v h="$C_HEADING" -v n="$C_NUMBER" -v c="$C_COMMENT" -v m="$C_COMMAND" -v x="$C_NC" -v P="${#nr_lines}" $'
             $0 ~ /^(#|$)/ {
                 #print the (sub-)headings and/or empty lines
                 print x h $0 x;
             }
             $0 ~ /^[^#]/ {
                 #print the commands
                 sub(/#/,c "#");
-                print x n "" ++i "." m " " $0 x;
+                NR = sprintf("%" P "d.", ++i);
+                print x n NR m " " $0 x;
             }'
     }
 
@@ -88,12 +108,13 @@ environment variables (other):
     if [ -z ${_OK_PROMPT+x} ];    then local PROMPT="$ ";               else local PROMPT=$_OK_PROMPT;       fi
     if [ -z ${_OK_VERBOSE+x} ];   then local verbose=1;                 else local verbose=$_OK_VERBOSE;     fi
 
-    # handle command line arguments first
+    # handle command line arguments now
+    local args="ok $@"              #preserve all arguments ($0 is '-bash', so hard-code function name)
     local re_is_num='^[1-9][0-9]*$' #numbers starting with "0" would be octal, and nobody knows those (also: sed on Linux complains about line "0")...
     local cmd=list
     local line_nr=0
     local once_check=0
-    local show_prompt=1
+    local show_prompt=${_OK_PROMPT_DEFAULT}
     local usage_error=
     local loop_args=1 #the Pascal-way to break loops
     while (( $# > 0 && $loop_args == 1 )) ; do
@@ -124,13 +145,16 @@ environment variables (other):
         if [[ $cmd == run ]]; then
             _ok_cmd_run $line_nr "$@" || return $?
         elif [[ $cmd == list ]]; then
-            if [[ $once_check == 0 || ($once_check == 1 && $_OK_LAST_PWD != $(pwd)) ]]; then
+            if [[ $once_check == 0 || ($once_check == 1 && $_OK__LAST_PWD != $(pwd)) ]]; then
                 _ok_cmd_list || return $?
                 if [[ $show_prompt == 1 ]]; then
                     local prompt_input
                     local re_num_begin='^[1-9][0-9]*($| )' # You can enter arguments at the ok-prompt too, hence different regex
                     read -p "${C_PROMPT}${PROMPT}${C_NC}" prompt_input
                     if [[ $prompt_input =~ $re_num_begin ]]; then
+                        #save command to history first
+                        history -s $args $prompt_input
+                        #execute command
                         eval _ok_cmd_run $prompt_input || return $?
                     else
                         if [[ $verbose -ge 2 ]]; then
@@ -140,10 +164,10 @@ environment variables (other):
                     fi
                 fi
             fi
-            if [[ $verbose -ge 2 && $once_check == 1 && $_OK_LAST_PWD == $(pwd) ]]; then
+            if [[ $verbose -ge 2 && $once_check == 1 && $_OK__LAST_PWD == $(pwd) ]]; then
                 echo "The listing for this folder has already been shown"
             fi
-            export _OK_LAST_PWD=$(pwd)
+            export _OK__LAST_PWD=$(pwd)
         elif [[ $cmd == usage ]]; then
             _ok_cmd_usage "$usage_error" || return $?
         fi
@@ -153,3 +177,36 @@ environment variables (other):
         fi
     fi
 }
+
+if [[ $called == $0 ]]; then
+    # tip: "." (i.e. source) this file from your profile (.bashrc), e.g. ". ~/path/to/ok-bash/ok.sh"
+    echo 'tip: "." (i.e. source) this file from your profile (.bashrc), e.g. ". '${_OK__PATH_TO_ME}'/ok.sh"'
+    echo
+    echo "arguments, if you need to customize (these can also be set via arguments/environment):"
+    echo "  prompt <prompt> Use the supplied prompt (e.g. prompt '> ')"
+    echo "  prompt_default  Prompt default when issueing running ok without arguments"
+    echo "  auto_show       Perform 'ok list-once' every time the prompt is shown (modifies \$PROMPT_COMMAND)"
+    echo "  verbose         Enable verbose mode"
+    echo "  quiet           Enable quiet mode"
+    echo
+else
+    # Reset all used environment variables
+    unset _OK_C_HEADING; unset _OK_C_NUMBER; unset _OK_C_COMMENT; unset _OK_C_COMMAND; unset _OK_C_PROMPT
+    unset _OK_PROMPT; unset _OK_PROMPT_DEFAULT; unset _OK_VERBOSE; unset _OK__LAST_PWD
+    # Process some installation helpers
+    re_list_once=$'ok list-once'
+    while (( $# > 0 )) ; do
+        case $1 in
+            prompt) if [[ $# -ge 2 ]]; then export _OK_PROMPT=$2; shift; else echo "the prompt argument needs the actual prompt as 2nd argument"; fi;;
+            prompt_default) export _OK_PROMPT_DEFAULT=1;;
+            verbose)        export _OK_VERBOSE=2;;
+            quiet)          export _OK_VERBOSE=0;;
+            auto_show)      if [[ ! $PROMPT_COMMAND =~ $re_list_once ]]; then export PROMPT_COMMAND="$PROMPT_COMMAND
+$re_list_once"; fi;;
+            *) echo "Ignoring unknown argument '$1'";;
+        esac
+        shift
+    done
+    unset re_list_once
+fi
+unset called