summaryrefslogtreecommitdiff
path: root/plugins/history-substring-search
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2026-01-04 22:47:54 -0800
committerTuowen Zhao <ztuowen@gmail.com>2026-01-04 22:47:54 -0800
commit2aa4cb7a52b28722816ecfd55f3b06293332c55c (patch)
treef02a9f3d59d109c70caf932a24e43368994e0e8c /plugins/history-substring-search
parent7e951c254e779ff0620537cf43ca69dd878387b4 (diff)
parentd23d3ea69fdb839088e6e5589557cce77b34aaf8 (diff)
downloadzsh-master.tar.gz
zsh-master.tar.bz2
zsh-master.zip
Merge remote-tracking branch 'github/master'HEADmaster
Diffstat (limited to 'plugins/history-substring-search')
-rw-r--r--plugins/history-substring-search/README.md103
-rw-r--r--plugins/history-substring-search/dependencies/OMZ-README.md15
-rw-r--r--plugins/history-substring-search/history-substring-search.plugin.zsh1
-rw-r--r--plugins/history-substring-search/history-substring-search.zsh236
-rwxr-xr-xplugins/history-substring-search/update-from-upstream.zsh129
5 files changed, 258 insertions, 226 deletions
diff --git a/plugins/history-substring-search/README.md b/plugins/history-substring-search/README.md
index 6d8b56425..71a389535 100644
--- a/plugins/history-substring-search/README.md
+++ b/plugins/history-substring-search/README.md
@@ -23,7 +23,15 @@ Install
Using the [Homebrew]( https://brew.sh ) package manager:
brew install zsh-history-substring-search
- echo 'source /usr/local/share/zsh-history-substring-search/zsh-history-substring-search.zsh' >> ~/.zshrc
+ echo 'source $(brew --prefix)/share/zsh-history-substring-search/zsh-history-substring-search.zsh' >> ~/.zshrc
+
+Using [Fig](https://fig.io):
+
+Fig adds apps, shortcuts, and autocomplete to your existing terminal.
+
+Install `zsh-history-substring-search` in just one click.
+
+<a href="https://fig.io/plugins/other/zsh-history-substring-search" target="_blank"><img src="https://fig.io/badges/install-with-fig.svg" /></a>
Using [Oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh):
@@ -33,24 +41,63 @@ Using [Oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh):
2. Activate the plugin in `~/.zshrc`:
- plugins=( [plugins...] history-substring-search)
+ plugins=( [plugins...] zsh-history-substring-search)
+
+3. Run `exec zsh` to take changes into account:
+
+ exec zsh
+
+Using [zplug](https://github.com/zplug/zplug):
+
+1. Add this repo to `~/.zshrc`:
+
+ zplug "zsh-users/zsh-history-substring-search", as: plugin
+
+Using [antigen](https://github.com/zsh-users/antigen):
+
+1. Add the `antigen bundle` command just before `antigen apply`, like this:
+
+```
+antigen bundle zsh-users/zsh-history-substring-search
+antigen apply
+```
+
+2. Then, **after** `antigen apply`, add the key binding configurations, like this:
+
+```
+# zsh-history-substring-search configuration
+bindkey '^[[A' history-substring-search-up # or '\eOA'
+bindkey '^[[B' history-substring-search-down # or '\eOB'
+HISTORY_SUBSTRING_SEARCH_ENSURE_UNIQUE=1
+```
+
+Using [Zinit](https://github.com/zdharma-continuum/zinit):
-3. Source `~/.zshrc` to take changes into account:
+1. Use the `Oh-my-zsh` Zinit snippet in `~/.zshrc`:
- source ~/.zshrc
+ zinit snippet OMZ::plugins/git/git.plugin.zsh`
+
+2. Load the plugin in `~/.zshrc`:
+
+ zinit load 'zsh-users/zsh-history-substring-search
+ zinit ice wait atload'_history_substring_search_config'
+
+3. Run `exec zsh` to take changes into account:
+
+ exec zsh
Usage
------------------------------------------------------------------------------
1. Load this script into your interactive ZSH session:
- % source zsh-history-substring-search.zsh
+ source zsh-history-substring-search.zsh
If you want to use [zsh-syntax-highlighting][6] along with this script,
then make sure that you load it *before* you load this script:
- % source zsh-syntax-highlighting.zsh
- % source zsh-history-substring-search.zsh
+ source zsh-syntax-highlighting.zsh
+ source zsh-history-substring-search.zsh
2. Bind keyboard shortcuts to this script's functions.
@@ -73,6 +120,10 @@ Usage
bindkey "$terminfo[kcuu1]" history-substring-search-up
bindkey "$terminfo[kcud1]" history-substring-search-down
+ Users have also observed that `[OA` and `[OB` are correct values,
+ _even if_ these were not the observed values. If you are having trouble
+ with the observed values, give these a try.
+
You might also want to bind the Control-P/N keys for use in EMACS mode:
bindkey -M emacs '^P' history-substring-search-up
@@ -115,7 +166,7 @@ Configuration
------------------------------------------------------------------------------
This script defines the following global variables. You may override their
-default values only after having loaded this script into your ZSH session.
+default values.
* `HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_FOUND` is a global variable that defines
how the query should be highlighted inside a matching command. Its default
@@ -141,6 +192,12 @@ default values only after having loaded this script into your ZSH session.
value, causes this script to perform a fuzzy search by words, matching in
given order e.g. `ab c` will match `*ab*c*`
+* `HISTORY_SUBSTRING_SEARCH_PREFIXED` is a global variable that defines how
+ the command history will be searched for your query. If set to a non-empty
+ value, your query will be matched against the start of each history entry.
+ For example, if this variable is empty, `ls` will match `ls -l` and `echo
+ ls`; if it is non-empty, `ls` will only match `ls -l`.
+
* `HISTORY_SUBSTRING_SEARCH_ENSURE_UNIQUE` is a global variable that defines
whether all search results returned are _unique_. If set to a non-empty
value, then only unique search results are presented. This behaviour is off
@@ -155,6 +212,9 @@ default values only after having loaded this script into your ZSH session.
receive globally unique search results only once, then use this
configuration variable, or use `setopt HIST_IGNORE_ALL_DUPS`.
+* `HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_TIMEOUT` is a global variable that
+ defines a timeout in seconds for clearing the search highlight.
+
History
------------------------------------------------------------------------------
@@ -175,24 +235,17 @@ History
* March 2016: Geza Lore (@gezalore) greatly refactored it in pull request #55.
-------------------------------------------------------------------------------
-Oh My Zsh Distribution Notes
-------------------------------------------------------------------------------
-
-What you are looking at now is Oh My Zsh's repackaging of zsh-history-substring-search
-as an OMZ module inside the Oh My Zsh distribution.
+---
-The upstream repo, zsh-users/zsh-history-substring-search, can be found on GitHub at
-https://github.com/zsh-users/zsh-history-substring-search.
-
-This downstream copy was last updated from the following upstream commit:
+## Oh My Zsh Distribution Notes
- SHA: 0f80b8eb3368b46e5e573c1d91ae69eb095db3fb
- Commit date: 2019-05-12 17:35:54 -0700
+What you are looking at now is Oh My Zsh's repackaging of zsh-history-substring-search as an OMZ module inside
+the Oh My Zsh distribution.
-Everything above this section is a copy of the original upstream's README, so things
-may differ slightly when you're using this inside OMZ. In particular, you do not
-need to set up key bindings for the up and down arrows yourself in `~/.zshrc`; the OMZ
-plugin does that for you. You may still want to set up additional emacs- or vi-specific
-bindings as mentioned above.
+The upstream repo, zsh-users/zsh-history-substring-search, can be found on GitHub at
+https://github.com/zsh-users/zsh-history-substring-search.
+Everything above this section is a copy of the original upstream's README, so things may differ slightly when
+you're using this inside OMZ. In particular, you do not need to set up key bindings for the up and down arrows
+yourself in `~/.zshrc`; the OMZ plugin does that for you. You may still want to set up additional emacs- or
+vi-specific bindings as mentioned above.
diff --git a/plugins/history-substring-search/dependencies/OMZ-README.md b/plugins/history-substring-search/dependencies/OMZ-README.md
new file mode 100644
index 000000000..c5967bb7d
--- /dev/null
+++ b/plugins/history-substring-search/dependencies/OMZ-README.md
@@ -0,0 +1,15 @@
+
+---
+
+## Oh My Zsh Distribution Notes
+
+What you are looking at now is Oh My Zsh's repackaging of zsh-history-substring-search as an OMZ module inside
+the Oh My Zsh distribution.
+
+The upstream repo, zsh-users/zsh-history-substring-search, can be found on GitHub at
+https://github.com/zsh-users/zsh-history-substring-search.
+
+Everything above this section is a copy of the original upstream's README, so things may differ slightly when
+you're using this inside OMZ. In particular, you do not need to set up key bindings for the up and down arrows
+yourself in `~/.zshrc`; the OMZ plugin does that for you. You may still want to set up additional emacs- or
+vi-specific bindings as mentioned above.
diff --git a/plugins/history-substring-search/history-substring-search.plugin.zsh b/plugins/history-substring-search/history-substring-search.plugin.zsh
index 63f0bdd42..077105ea3 100644
--- a/plugins/history-substring-search/history-substring-search.plugin.zsh
+++ b/plugins/history-substring-search/history-substring-search.plugin.zsh
@@ -16,4 +16,3 @@ if [[ -n "$terminfo[kcud1]" ]]; then
bindkey -M emacs "$terminfo[kcud1]" history-substring-search-down
bindkey -M viins "$terminfo[kcud1]" history-substring-search-down
fi
-
diff --git a/plugins/history-substring-search/history-substring-search.zsh b/plugins/history-substring-search/history-substring-search.zsh
index c326778d4..db516f580 100644
--- a/plugins/history-substring-search/history-substring-search.zsh
+++ b/plugins/history-substring-search/history-substring-search.zsh
@@ -43,11 +43,19 @@
# declare global configuration variables
#-----------------------------------------------------------------------------
-typeset -g HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_FOUND='bg=magenta,fg=white,bold'
-typeset -g HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_NOT_FOUND='bg=red,fg=white,bold'
-typeset -g HISTORY_SUBSTRING_SEARCH_GLOBBING_FLAGS='i'
-typeset -g HISTORY_SUBSTRING_SEARCH_ENSURE_UNIQUE=''
-typeset -g HISTORY_SUBSTRING_SEARCH_FUZZY=''
+: ${HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_FOUND='bg=magenta,fg=white,bold'}
+: ${HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_NOT_FOUND='bg=red,fg=white,bold'}
+
+# Respect CASE_SENSITIVE setting for case sensitivity
+if [[ "$CASE_SENSITIVE" = true ]]; then
+ : ${HISTORY_SUBSTRING_SEARCH_GLOBBING_FLAGS=''}
+else
+ : ${HISTORY_SUBSTRING_SEARCH_GLOBBING_FLAGS='i'}
+fi
+
+: ${HISTORY_SUBSTRING_SEARCH_ENSURE_UNIQUE=''}
+: ${HISTORY_SUBSTRING_SEARCH_FUZZY=''}
+: ${HISTORY_SUBSTRING_SEARCH_PREFIXED=''}
#-----------------------------------------------------------------------------
# declare internal global variables
@@ -64,6 +72,7 @@ typeset -g -i _history_substring_search_raw_match_index
typeset -g -a _history_substring_search_matches
typeset -g -i _history_substring_search_match_index
typeset -g -A _history_substring_search_unique_filter
+typeset -g -i _history_substring_search_zsh_5_9
#-----------------------------------------------------------------------------
# the main ZLE widgets
@@ -97,6 +106,11 @@ zle -N history-substring-search-down
#-----------------------------------------------------------------------------
zmodload -F zsh/parameter
+autoload -Uz is-at-least
+
+if is-at-least 5.9 $ZSH_VERSION; then
+ _history_substring_search_zsh_5_9=1
+fi
#
# We have to "override" some keys and widgets if the
@@ -117,80 +131,125 @@ if [[ $+functions[_zsh_highlight] -eq 0 ]]; then
}
#
- # The following snippet was taken from the zsh-syntax-highlighting project:
- #
- # https://github.com/zsh-users/zsh-syntax-highlighting/blob/56b134f5d62ae3d4e66c7f52bd0cc2595f9b305b/zsh-syntax-highlighting.zsh#L126-161
- #
- # Copyright (c) 2010-2011 zsh-syntax-highlighting contributors
- # All rights reserved.
+ # Check if $1 denotes the name of a callable function, i.e. it is fully
+ # defined or it is marked for autoloading and autoloading it at the first
+ # call to it will succeed. In particular, if $1 has been marked for
+ # autoloading but is not available in $fpath, then it will return 1 (false).
#
- # Redistribution and use in source and binary forms, with or without
- # modification, are permitted provided that the following conditions are
- # met:
+ # This is based on the zsh-syntax-highlighting plugin.
#
- # * Redistributions of source code must retain the above copyright
- # notice, this list of conditions and the following disclaimer.
- #
- # * Redistributions in binary form must reproduce the above copyright
- # notice, this list of conditions and the following disclaimer in the
- # documentation and/or other materials provided with the distribution.
- #
- # * Neither the name of the zsh-syntax-highlighting contributors nor the
- # names of its contributors may be used to endorse or promote products
- # derived from this software without specific prior written permission.
+ _history-substring-search-function-callable() {
+ if (( ${+functions[$1]} )) && ! [[ "$functions[$1]" == *"builtin autoload -X"* ]]; then
+ return 0 # already fully loaded
+ else
+ # "$1" is either an autoload stub, or not a function at all.
+ # We expect 'autoload +X' to return non-zero if it fails to fully load
+ # the function.
+ ( autoload -U +X -- "$1" 2>/dev/null )
+ return $?
+ fi
+ }
+
#
- # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
- # IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
- # THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
- # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ # The zsh-syntax-highlighting plugin uses zle-line-pre-redraw hook instead
+ # of the legacy "bind all widgets" if 1) zsh has the memo= feature (added in
+ # version 5.9) and 2) add-zle-hook-widget is available.
#
- #--------------8<-------------------8<-------------------8<-----------------
- # Rebind all ZLE widgets to make them invoke _zsh_highlights.
- _zsh_highlight_bind_widgets()
- {
- # Load ZSH module zsh/zleparameter, needed to override user defined widgets.
- zmodload zsh/zleparameter 2>/dev/null || {
- echo 'zsh-syntax-highlighting: failed loading zsh/zleparameter.' >&2
- return 1
+ if [[ $_history_substring_search_zsh_5_9 -eq 1 ]] && _history-substring-search-function-callable add-zle-hook-widget; then
+ #
+ # The following code is based on the zsh-syntax-highlighting plugin.
+ #
+ autoload -U add-zle-hook-widget
+
+ _history-substring-search-zle-line-finish() {
+ #
+ # Reset $WIDGET since the 'main' highlighter depends on it.
+ #
+ # Since $WIDGET is declared by zle as read-only in this function's scope,
+ # a nested function is required in order to shadow its built-in value;
+ # see "User-defined widgets" in zshall.
+ #
+ () {
+ local -h -r WIDGET=zle-line-finish
+ _zsh_highlight
+ }
+ }
+
+ _history-substring-search-zle-line-pre-redraw() {
+ #
+ # If the zsh-syntax-highlighting plugin has been loaded (after our plugin
+ # plugin, otherwise this hook wouldn't be called), remove our hooks.
+ #
+ if [[ $+ZSH_HIGHLIGHT_VERSION -eq 1 ]]; then
+ autoload -U add-zle-hook-widget
+ add-zle-hook-widget -d zle-line-pre-redraw _history-substring-search-zle-line-pre-redraw
+ add-zle-hook-widget -d zle-line-finish _history-substring-search-zle-line-finish
+ return 0
+ fi
+ #
+ # Set $? to 0 for _zsh_highlight. Without this, subsequent
+ # zle-line-pre-redraw hooks won't run, since add-zle-hook-widget happens to
+ # call us with $? == 1 in the common case.
+ #
+ true && _zsh_highlight "$@"
}
- # Override ZLE widgets to make them invoke _zsh_highlight.
- local cur_widget
- for cur_widget in ${${(f)"$(builtin zle -la)"}:#(.*|_*|orig-*|run-help|which-command|beep|yank*)}; do
- case $widgets[$cur_widget] in
+ if [[ -o zle ]]; then
+ add-zle-hook-widget zle-line-pre-redraw _history-substring-search-zle-line-pre-redraw
+ add-zle-hook-widget zle-line-finish _history-substring-search-zle-line-finish
+ fi
+ else
+ #
+ # The following snippet was taken from the zsh-syntax-highlighting project:
+ # https://github.com/zsh-users/zsh-syntax-highlighting/blob/56b134f5d62ae3d4e66c7f52bd0cc2595f9b305b/zsh-syntax-highlighting.zsh#L126-161
+ #
+ # SPDX-SnippetBegin
+ # SPDX-License-Identifier: BSD-3-Clause
+ # SPDX-SnippetCopyrightText: 2010-2011 zsh-syntax-highlighting contributors
+ #--------------8<-------------------8<-------------------8<-----------------
+ # Rebind all ZLE widgets to make them invoke _zsh_highlights.
+ _zsh_highlight_bind_widgets()
+ {
+ # Load ZSH module zsh/zleparameter, needed to override user defined widgets.
+ zmodload zsh/zleparameter 2>/dev/null || {
+ echo 'zsh-syntax-highlighting: failed loading zsh/zleparameter.' >&2
+ return 1
+ }
- # Already rebound event: do nothing.
- user:$cur_widget|user:_zsh_highlight_widget_*);;
+ # Override ZLE widgets to make them invoke _zsh_highlight.
+ local cur_widget
+ for cur_widget in ${${(f)"$(builtin zle -la)"}:#(.*|_*|orig-*|run-help|which-command|beep|yank*)}; do
+ case $widgets[$cur_widget] in
- # User defined widget: override and rebind old one with prefix "orig-".
- user:*) eval "zle -N orig-$cur_widget ${widgets[$cur_widget]#*:}; \
- _zsh_highlight_widget_$cur_widget() { builtin zle orig-$cur_widget -- \"\$@\" && _zsh_highlight }; \
- zle -N $cur_widget _zsh_highlight_widget_$cur_widget";;
+ # Already rebound event: do nothing.
+ user:$cur_widget|user:_zsh_highlight_widget_*);;
- # Completion widget: override and rebind old one with prefix "orig-".
- completion:*) eval "zle -C orig-$cur_widget ${${widgets[$cur_widget]#*:}/:/ }; \
- _zsh_highlight_widget_$cur_widget() { builtin zle orig-$cur_widget -- \"\$@\" && _zsh_highlight }; \
- zle -N $cur_widget _zsh_highlight_widget_$cur_widget";;
+ # User defined widget: override and rebind old one with prefix "orig-".
+ user:*) eval "zle -N orig-$cur_widget ${widgets[$cur_widget]#*:}; \
+ _zsh_highlight_widget_$cur_widget() { builtin zle orig-$cur_widget -- \"\$@\" && _zsh_highlight }; \
+ zle -N $cur_widget _zsh_highlight_widget_$cur_widget";;
- # Builtin widget: override and make it call the builtin ".widget".
- builtin) eval "_zsh_highlight_widget_$cur_widget() { builtin zle .$cur_widget -- \"\$@\" && _zsh_highlight }; \
- zle -N $cur_widget _zsh_highlight_widget_$cur_widget";;
+ # Completion widget: override and rebind old one with prefix "orig-".
+ completion:*) eval "zle -C orig-$cur_widget ${${widgets[$cur_widget]#*:}/:/ }; \
+ _zsh_highlight_widget_$cur_widget() { builtin zle orig-$cur_widget -- \"\$@\" && _zsh_highlight }; \
+ zle -N $cur_widget _zsh_highlight_widget_$cur_widget";;
- # Default: unhandled case.
- *) echo "zsh-syntax-highlighting: unhandled ZLE widget '$cur_widget'" >&2 ;;
- esac
- done
- }
- #-------------->8------------------->8------------------->8-----------------
+ # Builtin widget: override and make it call the builtin ".widget".
+ builtin) eval "_zsh_highlight_widget_$cur_widget() { builtin zle .$cur_widget -- \"\$@\" && _zsh_highlight }; \
+ zle -N $cur_widget _zsh_highlight_widget_$cur_widget";;
- _zsh_highlight_bind_widgets
+ # Default: unhandled case.
+ *) echo "zsh-syntax-highlighting: unhandled ZLE widget '$cur_widget'" >&2 ;;
+ esac
+ done
+ }
+ #-------------->8------------------->8------------------->8-----------------
+ # SPDX-SnippetEnd
+
+ _zsh_highlight_bind_widgets
+ fi
+
+ unfunction _history-substring-search-function-callable
fi
_history-substring-search-begin() {
@@ -246,7 +305,14 @@ _history-substring-search-begin() {
# Escape and join query parts with wildcard character '*' as separator
# `(j:CHAR:)` join array to string with CHAR as separator
#
- local search_pattern="*${(j:*:)_history_substring_search_query_parts[@]//(#m)[\][()|\\*?#<>~^]/\\$MATCH}*"
+ local search_pattern="${(j:*:)_history_substring_search_query_parts[@]//(#m)[\][()|\\*?#<>~^]/\\$MATCH}*"
+
+ #
+ # Support anchoring history search to the beginning of the command
+ #
+ if [[ -z $HISTORY_SUBSTRING_SEARCH_PREFIXED ]]; then
+ search_pattern="*${search_pattern}"
+ fi
#
# Find all occurrences of the search pattern in the history file.
@@ -304,12 +370,21 @@ _history-substring-search-begin() {
_history-substring-search-end() {
setopt localoptions extendedglob
+ local highlight_memo=
_history_substring_search_result=$BUFFER
+ if [[ $_history_substring_search_zsh_5_9 -eq 1 ]]; then
+ highlight_memo='memo=history-substring-search'
+ fi
+
# the search was successful so display the result properly by clearing away
# existing highlights and moving the cursor to the end of the result buffer
if [[ $_history_substring_search_refresh_display -eq 1 ]]; then
- region_highlight=()
+ if [[ -n $highlight_memo ]]; then
+ region_highlight=( "${(@)region_highlight:#*${highlight_memo}*}" )
+ else
+ region_highlight=()
+ fi
CURSOR=${#BUFFER}
fi
@@ -329,14 +404,33 @@ _history-substring-search-end() {
if [[ $query_part_match_index -le ${#BUFFER:$highlight_start_index} ]]; then
highlight_start_index=$(( $highlight_start_index + $query_part_match_index ))
highlight_end_index=$(( $highlight_start_index + ${#query_part} ))
- region_highlight+=("$(($highlight_start_index - 1)) $(($highlight_end_index - 1)) $_history_substring_search_query_highlight")
+ region_highlight+=(
+ "$(($highlight_start_index - 1)) $(($highlight_end_index - 1)) ${_history_substring_search_query_highlight}${highlight_memo:+,$highlight_memo}"
+ )
fi
done
fi
# For debugging purposes:
# zle -R "mn: "$_history_substring_search_match_index" m#: "${#_history_substring_search_matches}
- # read -k -t 200 && zle -U $REPLY
+ # read -k -t 200 && zle -U -- "$REPLY"
+
+ #
+ # When this function returns, z-sy-h runs its line-pre-redraw hook. It has no
+ # logic for determining highlight priority, when two different memo= marked
+ # region highlights overlap; instead, it always prioritises itself. Below is
+ # a workaround for dealing with it.
+ #
+ if [[ $_history_substring_search_zsh_5_9 -eq 1 ]]; then
+ zle -R
+ #
+ # After line redraw with desired highlight, wait for timeout or user input
+ # before removing search highlight and exiting. This ensures no highlights
+ # are left lingering after search is finished.
+ #
+ read -k -t ${HISTORY_SUBSTRING_SEARCH_HIGHLIGHT_TIMEOUT:-1} && zle -U -- "$REPLY"
+ region_highlight=( "${(@)region_highlight:#*${highlight_memo}*}" )
+ fi
# Exit successfully from the history-substring-search-* widgets.
return 0
diff --git a/plugins/history-substring-search/update-from-upstream.zsh b/plugins/history-substring-search/update-from-upstream.zsh
deleted file mode 100755
index 81e1942a5..000000000
--- a/plugins/history-substring-search/update-from-upstream.zsh
+++ /dev/null
@@ -1,129 +0,0 @@
-#!/usr/bin/env zsh
-#
-# update-from-upstream.zsh
-#
-# This script updates the Oh My Zsh version of the zsh-history-substring-search
-# plugin from the independent upstream repo. This is to be run by OMZ developers
-# when they want to pull in new changes from upstream to OMZ. It is not run
-# during normal use of the plugin.
-#
-# The official upstream repo is zsh-users/zsh-history-substring-search
-# https://github.com/zsh-users/zsh-history-substring-search
-#
-# This is a zsh script, not a function. Call it with `zsh update-from-upstream.zsh`
-# from the command line, running it from within the plugin directory.
-#
-# You can set the environment variable REPO_PATH to point it at an upstream
-# repo you have already prepared. Otherwise, it will do a clean checkout of
-# upstream's HEAD to a temporary local repo and use that.
-
-
-# Just bail on any error so we don't have to do extra checking.
-# This is a developer-use script, so terse output like that should
-# be fine.
-set -e
-
-
-upstream_basename=zsh-history-substring-search
-plugin_basename=history-substring-search
-UPSTREAM_REPO=zsh-users/$upstream_basename
-need_repo_cleanup=false
-upstream_github_url="https://github.com/$UPSTREAM_REPO"
-
-if [[ -z "$UPSTREAM_REPO_PATH" ]]; then
- # Do a clean checkout
- my_tempdir=$(mktemp -d -t omz-update-histsubstrsrch)
- UPSTREAM_REPO_PATH="$my_tempdir/$upstream_basename"
- git clone "$upstream_github_url" "$UPSTREAM_REPO_PATH"
- need_repo_cleanup=true
- print "Checked out upstream repo to $UPSTREAM_REPO_PATH"
-else
- print "Using existing $upstream_basename repo at $UPSTREAM_REPO_PATH"
-fi
-
-upstream="$UPSTREAM_REPO_PATH"
-
-# Figure out what we're pulling in
-upstream_sha=$(cd $upstream && git rev-parse HEAD)
-upstream_commit_date=$(cd $upstream && git log -1 --pretty=format:%ci)
-upstream_just_date=${${=upstream_commit_date}[1]}
-print "upstream SHA: $upstream_sha"
-print "upstream commit time: $upstream_commit_date"
-print "upstream commit date: $upstream_just_date"
-print
-
-# Copy the files over, using the OMZ plugin's names where needed
-cp -v "$upstream"/* .
-mv -v zsh-history-substring-search.zsh $plugin_basename.zsh
-mv -v zsh-history-substring-search.plugin.zsh $plugin_basename.plugin.zsh
-
-if [[ $need_repo_cleanup == true ]]; then
- print "Removing temporary repo at $my_tempdir"
- rm -rf "$my_tempdir"
-fi
-
-# Do OMZ-specific edits
-
-print
-print "Updating files with OMZ-specific stuff"
-print
-
-# OMZ binds the keys as part of the plugin loading
-
-cat >> $plugin_basename.plugin.zsh <<EOF
-
-
-# Bind terminal-specific up and down keys
-
-if [[ -n "\$terminfo[kcuu1]" ]]; then
- bindkey -M emacs "\$terminfo[kcuu1]" history-substring-search-up
- bindkey -M viins "\$terminfo[kcuu1]" history-substring-search-up
-fi
-if [[ -n "\$terminfo[kcud1]" ]]; then
- bindkey -M emacs "\$terminfo[kcud1]" history-substring-search-down
- bindkey -M viins "\$terminfo[kcud1]" history-substring-search-down
-fi
-
-EOF
-
-# Tack OMZ-specific notes on to readme
-
-thin_line="------------------------------------------------------------------------------"
-cat >> README.md <<EOF
-
-$thin_line
-Oh My Zsh Distribution Notes
-$thin_line
-
-What you are looking at now is Oh My Zsh's repackaging of zsh-history-substring-search
-as an OMZ module inside the Oh My Zsh distribution.
-
-The upstream repo, $UPSTREAM_REPO, can be found on GitHub at
-$upstream_github_url.
-
-This downstream copy was last updated from the following upstream commit:
-
- SHA: $upstream_sha
- Commit date: $upstream_commit_date
-
-Everything above this section is a copy of the original upstream's README, so things
-may differ slightly when you're using this inside OMZ. In particular, you do not
-need to set up key bindings for the up and down arrows yourself in \`~/.zshrc\`; the OMZ
-plugin does that for you. You may still want to set up additional emacs- or vi-specific
-bindings as mentioned above.
-
-EOF
-
-# Announce success and generate git commit messages
-
-cat <<EOF
-Done OK
-
-Now you can check the results and commit like this:
-
- git add *
- git commit -m "history-substring-search: update to upstream version $upstream_just_date" \\
- -m "Updates OMZ's copy to commit $upstream_sha from $UPSTREAM_REPO"
-
-EOF
-