Merge pull request #24 from ChanderG/add_prompt_suffix_var

feat: add '@tnotify-prompt-suffixes' variable

Author: rickstaa

README.md

@@ -6,15 +6,15 @@
 
 <a href="https://github.com/ChanderG/tmux-notify"><img src="resources/tmux-notify-logo.svg" alt="tmux notify logo" width="567" height="135"/></a>
 
-Tmux plugin to notify you when processes complete.
+Tmux plugin to notify you when processes are complete.
 
 Notification is via libnotify and visual bell raised in the tmux window. Visual bells can be mapped (in the terminal level) to X11 urgency bit and handled by your window manager.
 
 ## Use cases
 
--   When you have already started a process in a pane and wish to be notified; that is can't use a manual trigger
--   Working in different containers (Docker) -> can't choose the shell -> and can't use a shell level feature
--   Working over ssh but your tmux is on client side
+- When you have already started a process in a pane and wish to be notified, that is when you can't use a manual trigger.
+- Working in different containers (Docker) -> can't choose the shell -> and can't use a shell level feature
+- Working over ssh, but your tmux is on the client-side
 
 ## Install
 
@@ -41,41 +41,46 @@ Use `prefix + I` to install.
 - `notify-send` or `osascript`.
 
 > **Note**
->  Works on Linux and macOS (note: only actively tested on Linux).
+> Works on Linux and macOS (note: only actively tested on Linux).
 
 ## Configuration
 
 ### Enable verbose notification
 
-By default, the notification text is set to `Tmux pane task completed!`. We have also included a verbose output option. When enabled information about the pane, window and session in which the task has completed is given.
+By default, the notification text is set to `Tmux pane task completed!`. We have also included a verbose output option. When enabled, information about the pane, window, and session the task has completed is given.
 
-Put `set -g @tnotify-verbose 'on'` in `.tmux.conf` to enable this.
+Put `set -g @tnotify-verbose 'on'` in the `.tmux.conf` config file to enable this.
 
 #### Change the verbose notification message
 
-To change the verbose notification text put `set -g @tnotify-verbose-msg 'put your notification text here'` in `.tmux.conf`. You can use all the tmux variables in your notification text. Some useful tmux aliases are:
+To change the verbose notification text, put `set -g @tnotify-verbose-msg 'put your notification text here'` in the `.tmux.conf` config file. You can use all the tmux variables in your notification text. Some useful tmux aliases are:
 
--   `#D`: Pane id
--   `#P`: Pane index
--   `#T`: Pane title
--   `#S`: Session name
--   `#I`: Window index
--   `#W`: Window name
+- `#D`: Pane id
+- `#P`: Pane index
+- `#T`: Pane title
+- `#S`: Session name
+- `#I`: Window index
+- `#W`: Window name
 
-For the full list of aliases and variables you are referred to the `FORMATS`  section of the [tmux manual](http://man7.org/linux/man-pages/man1/tmux.1.html).
+For the full list of aliases and variables you are referred to the `FORMATS` section of the [tmux manual](http://man7.org/linux/man-pages/man1/tmux.1.html).
 
 ### Change monitor update period
 
 By default, the monitor sleep period is set to 10 seconds. This means that tmux-notify checks the pane activity every 10 seconds.
 
-Put `set -g @tnotify-sleep-duration 'desired duration'` in `.tmux.conf` to change this duration.
+Put `set -g @tnotify-sleep-duration 'desired duration" in the`.tmux.conf\` file to change this duration.
 
 **NOTE:** Keep in mind that there is a trade-off between notification speed (short sleep duration) and the amount of memory this tool needs.
 
+### Add additional shell suffixes
+
+The tmux notify script uses your shell prompt suffix to check whether a command has finished. It looks for the `$`, `#` and `%` suffixes by default. If you customise your shell to use different shell suffixes, you can add them by putting `set -g @tnotify-prompt-suffixes 'put your comma-separated bash suffix list here'` in the`.tmux.conf\` file.
+
+Feel free to open [a pull](https://github.com/ChanderG/tmux-notify/pulls) request or [issue](https://github.com/ChanderG/tmux-notify/issues) if you think your shell prompt suffix should be included by default.
+
 ## How does it work
 
-Pretty naive approach actually. Checks if pane content ends in $ every 10 seconds.
-Will add other prompt end characters as needed.
+The pretty naive approach. Checks if pane content ends with the bash prompt suffixes mentioned above every 10 seconds.
 
 ## Contributing
 

scripts/cancel.sh

@@ -6,19 +6,19 @@
 CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 # Source helpers and variables
-source "$CURRENT_DIR/helpers.sh"
-source "$CURRENT_DIR/variables.sh"
+source "${CURRENT_DIR}/helpers.sh"
+source "${CURRENT_DIR}/variables.sh"
 
 # Cancel pane monitoring if active
 if [[ -f "$PID_FILE_PATH" ]]; then
-
+  
   # Retrieve monitor process PID
   PID=$(cat "$PID_FILE_PATH")
-
+  
   # Kill process and remove pid file
   kill "$PID"
   rm "${PID_DIR}/${PANE_ID}.pid"
-
+  
   # Display success message
   tmux display-message "Pane monitoring canceled..."
 else

scripts/helpers.sh

@@ -4,19 +4,24 @@
 
 # Get tmux option
 get_tmux_option() {
-	local option="$1"
-	local default_value="$2"
-	local option_value=$(tmux show-option -gqv "$option")
-	if [ -z "$option_value" ]; then
-		echo "$default_value"
-	else
-		echo "$option_value"
-	fi
+  local option="$1"
+  local default_value="$2"
+  local option_value=$(tmux show-option -gqv "$option")
+  if [ -z "$option_value" ]; then
+    echo "$default_value"
+  else
+    echo "$option_value"
+  fi
 }
 
 # Set tmux option
 set_tmux_option() {
-	local option="$1"
-	local value="$2"
-	tmux set-option -gq "$option" "$value"
+  local option="$1"
+  local value="$2"
+  tmux set-option -gq "$option" "$value"
+}
+
+# Escape globbing charaters
+escape_glob_chars() {
+  echo "$1" | sed 's/[.[\*^$()+?{|]/\\&/g'
 }

scripts/notify.sh

@@ -5,8 +5,8 @@
 CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 # Source helpers and variables
-source "$CURRENT_DIR/helpers.sh"
-source "$CURRENT_DIR/variables.sh"
+source "${CURRENT_DIR}/helpers.sh"
+source "${CURRENT_DIR}/variables.sh"
 
 ## Functions
 
@@ -20,7 +20,7 @@ notify() {
     # see https://superuser.com/questions/1118878/using-notify-send-in-a-tmux-session-shows-error-no-notification#1118896
     notify-send "$1"
   fi
-
+  
   # trigger visual bell
   # your terminal emulator can be setup to set URGENT bit on visual bell
   # for eg, Xresources -> URxvt.urgentOnBell: true
@@ -32,7 +32,7 @@ on_cancel()
 {
   # Wait a bit for all pane monitors to complete
   sleep "$monitor_sleep_duration_value"
-
+  
   # Preform cleanup operation is monitoring was canceled
   if [[ -f "$PID_FILE_PATH" ]]; then
     kill "$PID"
@@ -44,38 +44,47 @@ trap 'on_cancel' TERM
 
 # Check if verbose option is enabled
 verbose_enabled() {
-	local verbose_value="$(get_tmux_option "$verbose_option" "$verbose_default")"
-	[ "$verbose_value" != "on" ]
+  local verbose_value="$(get_tmux_option "$verbose_option" "$verbose_default")"
+  [ "$verbose_value" != "on" ]
 }
 
 ## Main script
 
 # Monitor pane if it is not already monitored
 if [[ ! -f "$PID_FILE_PATH" ]]; then  # If pane not yet monitored
-
+  
   # job started - create pid-file
   echo "$$" > "$PID_FILE_PATH"
-
+  
   # Display tnotify start messsage
   tmux display-message "Monitoring pane..."
-
+  
   # Construct tnotify finish message
   if verbose_enabled; then  # If @tnotify-verbose is disabled
     complete_message="Tmux pane task completed!"
   else  # If @tnotify-verbose is enabled
     verbose_msg_value="$(get_tmux_option "$verbose_msg_option" "$verbose_msg_default")"
     complete_message=$(tmux display-message -p "$verbose_msg_value")
   fi
-
+  
+  # Create bash suffix list
+  # NOTE: Looks complicated but uses shell parameter expansion
+  # see https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html#Shell-Parameter-Expansion
+  prompt_suffixes="$(get_tmux_option "$prompt_suffixes" "$prompt_suffixes_default")"
+  prompt_suffixes=${prompt_suffixes// /} # Remove whitespace
+  prompt_suffixes=${prompt_suffixes//,/|} # Replace comma with or operator
+  prompt_suffixes=$(escape_glob_chars "$prompt_suffixes")
+  prompt_suffixes="\(${prompt_suffixes}\)$"
+  
   # Check process status every 10 seconds to see if has is finished
   while true; do
-
+    
     # capture pane output
     output=$(tmux capture-pane -pt %"$PANE_ID")
-
+    
     # run tests to determine if work is done
     # if so, break and notify
-    if echo "$output" | tail -n2 | grep -e '\$\|#\|%' &> /dev/null; then
+    if echo "$output" | tail -n2 | grep -e $prompt_suffixes &> /dev/null; then
       # tmux display-message "$@"
       if [[ "$1" == "refocus" ]]; then
         tmux switch -t \$"$SESSION_ID"
@@ -85,19 +94,19 @@ if [[ ! -f "$PID_FILE_PATH" ]]; then  # If pane not yet monitored
       notify "$complete_message"
       break
     fi
-
+    
     # Sleep for a given time
     monitor_sleep_duration_value=$(get_tmux_option "$monitor_sleep_duration" "$monitor_sleep_duration_default")
     sleep "$monitor_sleep_duration_value"
   done
-
+  
   # job done - remove pid file and return
   if [[ -f "$PID_FILE_PATH" ]]; then
     rm "$PID_FILE_PATH"
   fi
   exit 0
 else  # If pane is already being monitored
-
+  
   # Display pane already monitored message
   tmux display-message "Pane already monitored..."
   exit 0

scripts/variables.sh

@@ -3,9 +3,9 @@
 
 ## Main variables
 if [[ -z $XDG_CACHE_HOME ]]; then
-    export PID_DIR=~/.tmux/notify
+  export PID_DIR=~/.tmux/notify
 else
-    export PID_DIR="$XDG_CACHE_HOME/tmux/tmux-notify"
+  export PID_DIR="$XDG_CACHE_HOME/tmux/tmux-notify"
 fi
 
 # Get ID's
@@ -15,6 +15,8 @@ export PANE_ID=$(tmux display-message -p '#{pane_id}' | tr -d %)
 export PID_FILE_PATH="${PID_DIR}/${PANE_ID}.pid"
 
 ## Tnotify tmux options
+export prompt_suffixes="@tnotify-prompt-suffixes"
+export prompt_suffixes_default="$,#,%"
 
 # Notification verbosity settings
 export verbose_option="@tnotify-verbose"

tnotify.tmux

@@ -5,9 +5,9 @@ CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
 # Set PID_DIR
 if [[ -z $XDG_CACHE_HOME ]]; then
-    export PID_DIR=~/.tmux/notify
+  export PID_DIR=~/.tmux/notify
 else
-    export PID_DIR="$XDG_CACHE_HOME/tmux/tmux-notify"
+  export PID_DIR="$XDG_CACHE_HOME/tmux/tmux-notify"
 fi
 
 # Initialize variables