Merge pull request #295 from zsh-users/develop

v0.4.1
This commit is contained in:
Eric Freese 2017-11-28 10:14:41 -07:00 committed by GitHub
commit dda220f140
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
21 changed files with 180 additions and 200 deletions

View file

@ -1,14 +1,21 @@
# Changelog # Changelog
## v0.4.1
- Switch to [[ and (( conditionals instead of [ (#257)
- Avoid warnnestedvar warnings with `typeset -g` (#275)
- Replace tabs with spaces in yaml (#268)
- Clean up and fix escaping of special characters (#267)
- Add `emacs-forward-word` to default list of partial accept widgets (#246)
## v0.4.0 ## v0.4.0
- High-level integration tests using RSpec and tmux - High-level integration tests using RSpec and tmux
- Add continuous integration with Circle CI - Add continuous integration with Circle CI
- Experimental support for asynchronous suggestions (#) - Experimental support for asynchronous suggestions (#170)
- Fix problems with multi-line suggestions (#) - Fix problems with multi-line suggestions (#225)
- Optimize case where manually typing in suggestion - Optimize case where manually typing in suggestion
- Avoid wrapping any zle-* widgets (#) - Avoid wrapping any zle-* widgets (#206)
- Remove support for deprecated options from v0.0.x - Remove support for deprecated options from v0.0.x
- Handle history entries that begin with dashes (#) - Handle history entries that begin with dashes
- Gracefully handle being sourced multiple times (#126) - Gracefully handle being sourced multiple times (#126)
- Add enable/disable/toggle widgets to disable/enable suggestions (#219) - Add enable/disable/toggle widgets to disable/enable suggestions (#219)

View file

@ -3,7 +3,6 @@ SRC_DIR := ./src
SRC_FILES := \ SRC_FILES := \
$(SRC_DIR)/setup.zsh \ $(SRC_DIR)/setup.zsh \
$(SRC_DIR)/config.zsh \ $(SRC_DIR)/config.zsh \
$(SRC_DIR)/util.zsh \
$(SRC_DIR)/features.zsh \ $(SRC_DIR)/features.zsh \
$(SRC_DIR)/bind.zsh \ $(SRC_DIR)/bind.zsh \
$(SRC_DIR)/highlight.zsh \ $(SRC_DIR)/highlight.zsh \

View file

@ -16,7 +16,7 @@ It suggests commands as you type, based on command history.
1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`. 1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`.
```sh ```sh
git clone git://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions git clone https://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions
``` ```
2. Add the following to your `.zshrc`: 2. Add the following to your `.zshrc`:
@ -33,7 +33,7 @@ It suggests commands as you type, based on command history.
1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`) 1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`)
```sh ```sh
git clone git://github.com/zsh-users/zsh-autosuggestions $ZSH_CUSTOM/plugins/zsh-autosuggestions git clone https://github.com/zsh-users/zsh-autosuggestions $ZSH_CUSTOM/plugins/zsh-autosuggestions
``` ```
2. Add the plugin to the list of plugins for Oh My Zsh to load: 2. Add the plugin to the list of plugins for Oh My Zsh to load:

View file

@ -1 +1 @@
v0.4.0 v0.4.1

View file

@ -23,14 +23,5 @@ describe 'pasting using bracketed-paste-magic' do
expect(session.content).to eq("echo #{'a' * 60}") expect(session.content).to eq("echo #{'a' * 60}")
end end
end end
it 'shows a suggestion after a non-modifying keystroke' do
with_history('echo hello') do
session.paste_string('echo')
sleep 1
session.send_keys('left')
wait_for { session.content }.to eq('echo hello')
end
end
end end
end end

View file

@ -0,0 +1,13 @@
describe 'rebinding [' do
context 'initialized before sourcing the plugin' do
before do
session.run_command("function [ { $commands[\\[] \"$@\" }")
session.clear_screen
end
it 'executes the custom behavior and the built-in behavior' do
session.send_string('asdf')
wait_for { session.content }.to eq('asdf')
end
end
end

View file

@ -1,60 +0,0 @@
describe 'a special character in the buffer' do
it 'should be treated like any other character' do
with_history('echo "hello*"', 'echo "hello."') do
session.send_string('echo "hello*')
wait_for { session.content }.to eq('echo "hello*"')
end
with_history('echo "hello?"', 'echo "hello."') do
session.send_string('echo "hello?')
wait_for { session.content }.to eq('echo "hello?"')
end
with_history('echo "hello\nworld"') do
session.send_string('echo "hello\\')
wait_for { session.content }.to eq('echo "hello\nworld"')
end
with_history('echo "\\\\"') do
session.send_string('echo "\\\\')
wait_for { session.content }.to eq('echo "\\\\"')
end
with_history('echo ~/foo') do
session.send_string('echo ~')
wait_for { session.content }.to eq('echo ~/foo')
end
with_history('echo "$(ls foo)"') do
session.send_string('echo "$(')
wait_for { session.content }.to eq('echo "$(ls foo)"')
end
with_history('echo "$history[123]"') do
session.send_string('echo "$history[')
wait_for { session.content }.to eq('echo "$history[123]"')
session.send_string('123]')
wait_for { session.content }.to eq('echo "$history[123]"')
end
with_history('echo "#yolo"') do
session.send_string('echo "#')
wait_for { session.content }.to eq('echo "#yolo"')
end
with_history('echo "#foo"', 'echo $#abc') do
session.send_string('echo "#')
wait_for { session.content }.to eq('echo "#foo"')
end
with_history('echo "^A"', 'echo "^B"') do
session.send_string('echo "^A')
wait_for { session.content }.to eq('echo "^A"')
end
with_history('-foo() {}') do
session.send_string('-')
wait_for { session.content }.to eq('-foo() {}')
end
end
end

View file

@ -1,3 +1,5 @@
require 'strategies/special_characters_helper'
describe 'the default suggestion strategy' do describe 'the default suggestion strategy' do
it 'suggests the last matching history entry' do it 'suggests the last matching history entry' do
with_history('ls foo', 'ls bar', 'echo baz') do with_history('ls foo', 'ls bar', 'echo baz') do
@ -5,4 +7,6 @@ describe 'the default suggestion strategy' do
wait_for { session.content }.to eq('ls bar') wait_for { session.content }.to eq('ls bar')
end end
end end
include_examples 'special characters'
end end

View file

@ -1,3 +1,5 @@
require 'strategies/special_characters_helper'
describe 'the match_prev_cmd strategy' do describe 'the match_prev_cmd strategy' do
let(:options) { ['ZSH_AUTOSUGGEST_STRATEGY=match_prev_cmd'] } let(:options) { ['ZSH_AUTOSUGGEST_STRATEGY=match_prev_cmd'] }
@ -14,4 +16,6 @@ describe 'the match_prev_cmd strategy' do
wait_for { session.content }.to eq('ls bar') wait_for { session.content }.to eq('ls bar')
end end
end end
include_examples 'special characters'
end end

View file

@ -0,0 +1,62 @@
shared_examples 'special characters' do
describe 'a special character in the buffer' do
it 'should be treated like any other character' do
with_history('echo "hello*"', 'echo "hello."') do
session.send_string('echo "hello*')
wait_for { session.content }.to eq('echo "hello*"')
end
with_history('echo "hello?"', 'echo "hello."') do
session.send_string('echo "hello?')
wait_for { session.content }.to eq('echo "hello?"')
end
with_history('echo "hello\nworld"') do
session.send_string('echo "hello\\')
wait_for { session.content }.to eq('echo "hello\nworld"')
end
with_history('echo "\\\\"') do
session.send_string('echo "\\\\')
wait_for { session.content }.to eq('echo "\\\\"')
end
with_history('echo ~/foo') do
session.send_string('echo ~')
wait_for { session.content }.to eq('echo ~/foo')
end
with_history('echo "$(ls foo)"') do
session.send_string('echo "$(')
wait_for { session.content }.to eq('echo "$(ls foo)"')
end
with_history('echo "$history[123]"') do
session.send_string('echo "$history[')
wait_for { session.content }.to eq('echo "$history[123]"')
session.send_string('123]')
wait_for { session.content }.to eq('echo "$history[123]"')
end
with_history('echo "#yolo"') do
session.send_string('echo "#')
wait_for { session.content }.to eq('echo "#yolo"')
end
with_history('echo "#foo"', 'echo $#abc') do
session.send_string('echo "#')
wait_for { session.content }.to eq('echo "#foo"')
end
with_history('echo "^A"', 'echo "^B"') do
session.send_string('echo "^A')
wait_for { session.content }.to eq('echo "^A"')
end
with_history('-foo() {}') do
session.send_string('-')
wait_for { session.content }.to eq('-foo() {}')
end
end
end
end

View file

@ -63,7 +63,7 @@ _zsh_autosuggest_async_pty_create() {
typeset -h REPLY typeset -h REPLY
# If we won't get a fd back from zpty, try to guess it # If we won't get a fd back from zpty, try to guess it
if [ $_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD -eq 0 ]; then if (( ! $_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD )); then
integer -l zptyfd integer -l zptyfd
exec {zptyfd}>&1 # Open a new file descriptor (above 10). exec {zptyfd}>&1 # Open a new file descriptor (above 10).
exec {zptyfd}>&- # Close it so it's free to be used by zpty. exec {zptyfd}>&- # Close it so it's free to be used by zpty.

View file

@ -10,14 +10,14 @@ _zsh_autosuggest_incr_bind_count() {
_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=1 _ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=1
fi fi
bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1] typeset -gi bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]
} }
_zsh_autosuggest_get_bind_count() { _zsh_autosuggest_get_bind_count() {
if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then
bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1] typeset -gi bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]
else else
bind_count=0 typeset -gi bind_count=0
fi fi
} }
@ -88,13 +88,13 @@ _zsh_autosuggest_bind_widgets() {
# Find every widget we might want to bind and bind it appropriately # Find every widget we might want to bind and bind it appropriately
for widget in ${${(f)"$(builtin zle -la)"}:#${(j:|:)~ignore_widgets}}; do for widget in ${${(f)"$(builtin zle -la)"}:#${(j:|:)~ignore_widgets}}; do
if [ ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]; then if [[ -n ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]]; then
_zsh_autosuggest_bind_widget $widget clear _zsh_autosuggest_bind_widget $widget clear
elif [ ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]; then elif [[ -n ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]]; then
_zsh_autosuggest_bind_widget $widget accept _zsh_autosuggest_bind_widget $widget accept
elif [ ${ZSH_AUTOSUGGEST_EXECUTE_WIDGETS[(r)$widget]} ]; then elif [[ -n ${ZSH_AUTOSUGGEST_EXECUTE_WIDGETS[(r)$widget]} ]]; then
_zsh_autosuggest_bind_widget $widget execute _zsh_autosuggest_bind_widget $widget execute
elif [ ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]; then elif [[ -n ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]]; then
_zsh_autosuggest_bind_widget $widget partial_accept _zsh_autosuggest_bind_widget $widget partial_accept
else else
# Assume any unspecified widget might modify the buffer # Assume any unspecified widget might modify the buffer
@ -106,13 +106,13 @@ _zsh_autosuggest_bind_widgets() {
# Given the name of an original widget and args, invoke it, if it exists # Given the name of an original widget and args, invoke it, if it exists
_zsh_autosuggest_invoke_original_widget() { _zsh_autosuggest_invoke_original_widget() {
# Do nothing unless called with at least one arg # Do nothing unless called with at least one arg
[ $# -gt 0 ] || return (( $# )) || return
local original_widget_name="$1" local original_widget_name="$1"
shift shift
if [ $widgets[$original_widget_name] ]; then if (( ${+widgets[$original_widget_name]} )); then
zle $original_widget_name -- $@ zle $original_widget_name -- $@
fi fi
} }

View file

@ -42,6 +42,7 @@ ZSH_AUTOSUGGEST_EXECUTE_WIDGETS=(
# Widgets that accept the suggestion as far as the cursor moves # Widgets that accept the suggestion as far as the cursor moves
ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=( ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
forward-word forward-word
emacs-forward-word
vi-forward-word vi-forward-word
vi-forward-word-end vi-forward-word-end
vi-forward-blank-word vi-forward-blank-word

View file

@ -7,7 +7,7 @@
_zsh_autosuggest_highlight_reset() { _zsh_autosuggest_highlight_reset() {
typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
if [ -n "$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT" ]; then if [[ -n "$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT" ]]; then
region_highlight=("${(@)region_highlight:#$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT}") region_highlight=("${(@)region_highlight:#$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT}")
unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
fi fi
@ -17,8 +17,8 @@ _zsh_autosuggest_highlight_reset() {
_zsh_autosuggest_highlight_apply() { _zsh_autosuggest_highlight_apply() {
typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
if [ $#POSTDISPLAY -gt 0 ]; then if (( $#POSTDISPLAY )); then
_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT="$#BUFFER $(($#BUFFER + $#POSTDISPLAY)) $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT="$#BUFFER $(($#BUFFER + $#POSTDISPLAY)) $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE"
region_highlight+=("$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT") region_highlight+=("$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT")
else else
unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT

View file

@ -15,7 +15,7 @@ _zsh_autosuggest_start() {
# to the widget list variables to take effect on the next precmd. # to the widget list variables to take effect on the next precmd.
add-zsh-hook precmd _zsh_autosuggest_bind_widgets add-zsh-hook precmd _zsh_autosuggest_bind_widgets
if [ -n "${ZSH_AUTOSUGGEST_USE_ASYNC+x}" ]; then if [[ -n "${ZSH_AUTOSUGGEST_USE_ASYNC+x}" ]]; then
_zsh_autosuggest_async_start _zsh_autosuggest_async_start
fi fi
} }

View file

@ -7,19 +7,9 @@
# #
_zsh_autosuggest_strategy_default() { _zsh_autosuggest_strategy_default() {
# Reset options to defaults and enable LOCAL_OPTIONS local prefix="$1"
emulate -L zsh
# Enable globbing flags so that we can use (#m)
setopt EXTENDED_GLOB
# Escape backslashes and all of the glob operators so we can use
# this string as a pattern to search the $history associative array.
# - (#m) globbing flag enables setting references for match data
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
# Get the history items that match # Get the history items that match
# - (r) subscript flag makes the pattern match on values # - (r) subscript flag makes the pattern match on values
suggestion="${history[(r)$prefix*]}" typeset -g suggestion="${history[(r)${(b)prefix}*]}"
} }

View file

@ -21,18 +21,18 @@
# `HIST_EXPIRE_DUPS_FIRST`. # `HIST_EXPIRE_DUPS_FIRST`.
_zsh_autosuggest_strategy_match_prev_cmd() { _zsh_autosuggest_strategy_match_prev_cmd() {
local prefix="${1//(#m)[\\()\[\]|*?~]/\\$MATCH}" local prefix="$1"
# Get all history event numbers that correspond to history # Get all history event numbers that correspond to history
# entries that match pattern $prefix* # entries that match pattern $prefix*
local history_match_keys local history_match_keys
history_match_keys=(${(k)history[(R)$prefix*]}) history_match_keys=(${(k)history[(R)${(b)prefix}*]})
# By default we use the first history number (most recent history entry) # By default we use the first history number (most recent history entry)
local histkey="${history_match_keys[1]}" local histkey="${history_match_keys[1]}"
# Get the previously executed command # Get the previously executed command
local prev_cmd="$(_zsh_autosuggest_escape_command "${history[$((HISTCMD-1))]}")" local prev_cmd="${history[$((HISTCMD-1))]}"
# Iterate up to the first 200 history event numbers that match $prefix # Iterate up to the first 200 history event numbers that match $prefix
for key in "${(@)history_match_keys[1,200]}"; do for key in "${(@)history_match_keys[1,200]}"; do
@ -48,5 +48,5 @@ _zsh_autosuggest_strategy_match_prev_cmd() {
done done
# Give back the matched history entry # Give back the matched history entry
suggestion="$history[$histkey]" typeset -g suggestion="$history[$histkey]"
} }

View file

@ -1,11 +0,0 @@
#--------------------------------------------------------------------#
# Utility Functions #
#--------------------------------------------------------------------#
_zsh_autosuggest_escape_command() {
setopt localoptions EXTENDED_GLOB
# Escape special chars in the string (requires EXTENDED_GLOB)
echo -E "${1//(#m)[\"\'\\()\[\]|*?~]/\\$MATCH}"
}

View file

@ -13,14 +13,14 @@ _zsh_autosuggest_disable() {
_zsh_autosuggest_enable() { _zsh_autosuggest_enable() {
unset _ZSH_AUTOSUGGEST_DISABLED unset _ZSH_AUTOSUGGEST_DISABLED
if [ $#BUFFER -gt 0 ]; then if (( $#BUFFER )); then
_zsh_autosuggest_fetch _zsh_autosuggest_fetch
fi fi
} }
# Toggle suggestions (enable/disable) # Toggle suggestions (enable/disable)
_zsh_autosuggest_toggle() { _zsh_autosuggest_toggle() {
if [ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]; then if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
_zsh_autosuggest_enable _zsh_autosuggest_enable
else else
_zsh_autosuggest_disable _zsh_autosuggest_disable
@ -39,7 +39,7 @@ _zsh_autosuggest_clear() {
_zsh_autosuggest_modify() { _zsh_autosuggest_modify() {
local -i retval local -i retval
# Only added to zsh very recently # Only available in zsh >= 5.4
local -i KEYS_QUEUED_COUNT local -i KEYS_QUEUED_COUNT
# Save the contents of the buffer/postdisplay # Save the contents of the buffer/postdisplay
@ -54,35 +54,35 @@ _zsh_autosuggest_modify() {
retval=$? retval=$?
# Don't fetch a new suggestion if there's more input to be read immediately # Don't fetch a new suggestion if there's more input to be read immediately
if [[ $PENDING > 0 ]] || [[ $KEYS_QUEUED_COUNT > 0 ]]; then if (( $PENDING > 0 )) || (( $KEYS_QUEUED_COUNT > 0 )); then
return $retval return $retval
fi fi
# Optimize if manually typing in the suggestion # Optimize if manually typing in the suggestion
if [ $#BUFFER -gt $#orig_buffer ]; then if (( $#BUFFER > $#orig_buffer )); then
local added=${BUFFER#$orig_buffer} local added=${BUFFER#$orig_buffer}
# If the string added matches the beginning of the postdisplay # If the string added matches the beginning of the postdisplay
if [ "$added" = "${orig_postdisplay:0:$#added}" ]; then if [[ "$added" = "${orig_postdisplay:0:$#added}" ]]; then
POSTDISPLAY="${orig_postdisplay:$#added}" POSTDISPLAY="${orig_postdisplay:$#added}"
return $retval return $retval
fi fi
fi fi
# Don't fetch a new suggestion if the buffer hasn't changed # Don't fetch a new suggestion if the buffer hasn't changed
if [ "$BUFFER" = "$orig_buffer" ]; then if [[ "$BUFFER" = "$orig_buffer" ]]; then
POSTDISPLAY="$orig_postdisplay" POSTDISPLAY="$orig_postdisplay"
return $retval return $retval
fi fi
# Bail out if suggestions are disabled # Bail out if suggestions are disabled
if [ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]; then if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
return $? return $?
fi fi
# Get a new suggestion if the buffer is not empty after modification # Get a new suggestion if the buffer is not empty after modification
if [ $#BUFFER -gt 0 ]; then if (( $#BUFFER > 0 )); then
if [ -z "$ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" -o $#BUFFER -le "$ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" ]; then if [[ -z "$ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" ]] || (( $#BUFFER <= $ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE )); then
_zsh_autosuggest_fetch _zsh_autosuggest_fetch
fi fi
fi fi
@ -105,7 +105,7 @@ _zsh_autosuggest_fetch() {
_zsh_autosuggest_suggest() { _zsh_autosuggest_suggest() {
local suggestion="$1" local suggestion="$1"
if [ -n "$suggestion" ] && [ $#BUFFER -gt 0 ]; then if [[ -n "$suggestion" ]] && (( $#BUFFER )); then
POSTDISPLAY="${suggestion#$BUFFER}" POSTDISPLAY="${suggestion#$BUFFER}"
else else
unset POSTDISPLAY unset POSTDISPLAY
@ -118,12 +118,12 @@ _zsh_autosuggest_accept() {
# When vicmd keymap is active, the cursor can't move all the way # When vicmd keymap is active, the cursor can't move all the way
# to the end of the buffer # to the end of the buffer
if [ "$KEYMAP" = "vicmd" ]; then if [[ "$KEYMAP" = "vicmd" ]]; then
max_cursor_pos=$((max_cursor_pos - 1)) max_cursor_pos=$((max_cursor_pos - 1))
fi fi
# Only accept if the cursor is at the end of the buffer # Only accept if the cursor is at the end of the buffer
if [ $CURSOR -eq $max_cursor_pos ]; then if [[ $CURSOR = $max_cursor_pos ]]; then
# Add the suggestion to the buffer # Add the suggestion to the buffer
BUFFER="$BUFFER$POSTDISPLAY" BUFFER="$BUFFER$POSTDISPLAY"
@ -165,7 +165,7 @@ _zsh_autosuggest_partial_accept() {
retval=$? retval=$?
# If we've moved past the end of the original buffer # If we've moved past the end of the original buffer
if [ $CURSOR -gt $#original_buffer ]; then if (( $CURSOR > $#original_buffer )); then
# Set POSTDISPLAY to text right of the cursor # Set POSTDISPLAY to text right of the cursor
POSTDISPLAY="$RBUFFER" POSTDISPLAY="$RBUFFER"

View file

@ -1,6 +1,6 @@
# Fish-like fast/unobtrusive autosuggestions for zsh. # Fish-like fast/unobtrusive autosuggestions for zsh.
# https://github.com/zsh-users/zsh-autosuggestions # https://github.com/zsh-users/zsh-autosuggestions
# v0.4.0 # v0.4.1
# Copyright (c) 2013 Thiago de Arruda # Copyright (c) 2013 Thiago de Arruda
# Copyright (c) 2016-2017 Eric Freese # Copyright (c) 2016-2017 Eric Freese
# #
@ -78,6 +78,7 @@ ZSH_AUTOSUGGEST_EXECUTE_WIDGETS=(
# Widgets that accept the suggestion as far as the cursor moves # Widgets that accept the suggestion as far as the cursor moves
ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=( ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
forward-word forward-word
emacs-forward-word
vi-forward-word vi-forward-word
vi-forward-word-end vi-forward-word-end
vi-forward-blank-word vi-forward-blank-word
@ -100,17 +101,6 @@ ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE=
# Pty name for calculating autosuggestions asynchronously # Pty name for calculating autosuggestions asynchronously
ZSH_AUTOSUGGEST_ASYNC_PTY_NAME=zsh_autosuggest_pty ZSH_AUTOSUGGEST_ASYNC_PTY_NAME=zsh_autosuggest_pty
#--------------------------------------------------------------------#
# Utility Functions #
#--------------------------------------------------------------------#
_zsh_autosuggest_escape_command() {
setopt localoptions EXTENDED_GLOB
# Escape special chars in the string (requires EXTENDED_GLOB)
echo -E "${1//(#m)[\"\'\\()\[\]|*?~]/\\$MATCH}"
}
#--------------------------------------------------------------------# #--------------------------------------------------------------------#
# Feature Detection # # Feature Detection #
#--------------------------------------------------------------------# #--------------------------------------------------------------------#
@ -141,14 +131,14 @@ _zsh_autosuggest_incr_bind_count() {
_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=1 _ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=1
fi fi
bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1] typeset -gi bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]
} }
_zsh_autosuggest_get_bind_count() { _zsh_autosuggest_get_bind_count() {
if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then
bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1] typeset -gi bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]
else else
bind_count=0 typeset -gi bind_count=0
fi fi
} }
@ -219,13 +209,13 @@ _zsh_autosuggest_bind_widgets() {
# Find every widget we might want to bind and bind it appropriately # Find every widget we might want to bind and bind it appropriately
for widget in ${${(f)"$(builtin zle -la)"}:#${(j:|:)~ignore_widgets}}; do for widget in ${${(f)"$(builtin zle -la)"}:#${(j:|:)~ignore_widgets}}; do
if [ ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]; then if [[ -n ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]]; then
_zsh_autosuggest_bind_widget $widget clear _zsh_autosuggest_bind_widget $widget clear
elif [ ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]; then elif [[ -n ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]]; then
_zsh_autosuggest_bind_widget $widget accept _zsh_autosuggest_bind_widget $widget accept
elif [ ${ZSH_AUTOSUGGEST_EXECUTE_WIDGETS[(r)$widget]} ]; then elif [[ -n ${ZSH_AUTOSUGGEST_EXECUTE_WIDGETS[(r)$widget]} ]]; then
_zsh_autosuggest_bind_widget $widget execute _zsh_autosuggest_bind_widget $widget execute
elif [ ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]; then elif [[ -n ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]]; then
_zsh_autosuggest_bind_widget $widget partial_accept _zsh_autosuggest_bind_widget $widget partial_accept
else else
# Assume any unspecified widget might modify the buffer # Assume any unspecified widget might modify the buffer
@ -237,13 +227,13 @@ _zsh_autosuggest_bind_widgets() {
# Given the name of an original widget and args, invoke it, if it exists # Given the name of an original widget and args, invoke it, if it exists
_zsh_autosuggest_invoke_original_widget() { _zsh_autosuggest_invoke_original_widget() {
# Do nothing unless called with at least one arg # Do nothing unless called with at least one arg
[ $# -gt 0 ] || return (( $# )) || return
local original_widget_name="$1" local original_widget_name="$1"
shift shift
if [ $widgets[$original_widget_name] ]; then if (( ${+widgets[$original_widget_name]} )); then
zle $original_widget_name -- $@ zle $original_widget_name -- $@
fi fi
} }
@ -256,7 +246,7 @@ _zsh_autosuggest_invoke_original_widget() {
_zsh_autosuggest_highlight_reset() { _zsh_autosuggest_highlight_reset() {
typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
if [ -n "$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT" ]; then if [[ -n "$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT" ]]; then
region_highlight=("${(@)region_highlight:#$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT}") region_highlight=("${(@)region_highlight:#$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT}")
unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
fi fi
@ -266,8 +256,8 @@ _zsh_autosuggest_highlight_reset() {
_zsh_autosuggest_highlight_apply() { _zsh_autosuggest_highlight_apply() {
typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
if [ $#POSTDISPLAY -gt 0 ]; then if (( $#POSTDISPLAY )); then
_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT="$#BUFFER $(($#BUFFER + $#POSTDISPLAY)) $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" typeset -g _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT="$#BUFFER $(($#BUFFER + $#POSTDISPLAY)) $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE"
region_highlight+=("$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT") region_highlight+=("$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT")
else else
unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
@ -288,14 +278,14 @@ _zsh_autosuggest_disable() {
_zsh_autosuggest_enable() { _zsh_autosuggest_enable() {
unset _ZSH_AUTOSUGGEST_DISABLED unset _ZSH_AUTOSUGGEST_DISABLED
if [ $#BUFFER -gt 0 ]; then if (( $#BUFFER )); then
_zsh_autosuggest_fetch _zsh_autosuggest_fetch
fi fi
} }
# Toggle suggestions (enable/disable) # Toggle suggestions (enable/disable)
_zsh_autosuggest_toggle() { _zsh_autosuggest_toggle() {
if [ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]; then if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
_zsh_autosuggest_enable _zsh_autosuggest_enable
else else
_zsh_autosuggest_disable _zsh_autosuggest_disable
@ -314,7 +304,7 @@ _zsh_autosuggest_clear() {
_zsh_autosuggest_modify() { _zsh_autosuggest_modify() {
local -i retval local -i retval
# Only added to zsh very recently # Only available in zsh >= 5.4
local -i KEYS_QUEUED_COUNT local -i KEYS_QUEUED_COUNT
# Save the contents of the buffer/postdisplay # Save the contents of the buffer/postdisplay
@ -329,35 +319,35 @@ _zsh_autosuggest_modify() {
retval=$? retval=$?
# Don't fetch a new suggestion if there's more input to be read immediately # Don't fetch a new suggestion if there's more input to be read immediately
if [[ $PENDING > 0 ]] || [[ $KEYS_QUEUED_COUNT > 0 ]]; then if (( $PENDING > 0 )) || (( $KEYS_QUEUED_COUNT > 0 )); then
return $retval return $retval
fi fi
# Optimize if manually typing in the suggestion # Optimize if manually typing in the suggestion
if [ $#BUFFER -gt $#orig_buffer ]; then if (( $#BUFFER > $#orig_buffer )); then
local added=${BUFFER#$orig_buffer} local added=${BUFFER#$orig_buffer}
# If the string added matches the beginning of the postdisplay # If the string added matches the beginning of the postdisplay
if [ "$added" = "${orig_postdisplay:0:$#added}" ]; then if [[ "$added" = "${orig_postdisplay:0:$#added}" ]]; then
POSTDISPLAY="${orig_postdisplay:$#added}" POSTDISPLAY="${orig_postdisplay:$#added}"
return $retval return $retval
fi fi
fi fi
# Don't fetch a new suggestion if the buffer hasn't changed # Don't fetch a new suggestion if the buffer hasn't changed
if [ "$BUFFER" = "$orig_buffer" ]; then if [[ "$BUFFER" = "$orig_buffer" ]]; then
POSTDISPLAY="$orig_postdisplay" POSTDISPLAY="$orig_postdisplay"
return $retval return $retval
fi fi
# Bail out if suggestions are disabled # Bail out if suggestions are disabled
if [ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]; then if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
return $? return $?
fi fi
# Get a new suggestion if the buffer is not empty after modification # Get a new suggestion if the buffer is not empty after modification
if [ $#BUFFER -gt 0 ]; then if (( $#BUFFER > 0 )); then
if [ -z "$ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" -o $#BUFFER -le "$ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" ]; then if [[ -z "$ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" ]] || (( $#BUFFER <= $ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE )); then
_zsh_autosuggest_fetch _zsh_autosuggest_fetch
fi fi
fi fi
@ -380,7 +370,7 @@ _zsh_autosuggest_fetch() {
_zsh_autosuggest_suggest() { _zsh_autosuggest_suggest() {
local suggestion="$1" local suggestion="$1"
if [ -n "$suggestion" ] && [ $#BUFFER -gt 0 ]; then if [[ -n "$suggestion" ]] && (( $#BUFFER )); then
POSTDISPLAY="${suggestion#$BUFFER}" POSTDISPLAY="${suggestion#$BUFFER}"
else else
unset POSTDISPLAY unset POSTDISPLAY
@ -393,12 +383,12 @@ _zsh_autosuggest_accept() {
# When vicmd keymap is active, the cursor can't move all the way # When vicmd keymap is active, the cursor can't move all the way
# to the end of the buffer # to the end of the buffer
if [ "$KEYMAP" = "vicmd" ]; then if [[ "$KEYMAP" = "vicmd" ]]; then
max_cursor_pos=$((max_cursor_pos - 1)) max_cursor_pos=$((max_cursor_pos - 1))
fi fi
# Only accept if the cursor is at the end of the buffer # Only accept if the cursor is at the end of the buffer
if [ $CURSOR -eq $max_cursor_pos ]; then if [[ $CURSOR = $max_cursor_pos ]]; then
# Add the suggestion to the buffer # Add the suggestion to the buffer
BUFFER="$BUFFER$POSTDISPLAY" BUFFER="$BUFFER$POSTDISPLAY"
@ -440,7 +430,7 @@ _zsh_autosuggest_partial_accept() {
retval=$? retval=$?
# If we've moved past the end of the original buffer # If we've moved past the end of the original buffer
if [ $CURSOR -gt $#original_buffer ]; then if (( $CURSOR > $#original_buffer )); then
# Set POSTDISPLAY to text right of the cursor # Set POSTDISPLAY to text right of the cursor
POSTDISPLAY="$RBUFFER" POSTDISPLAY="$RBUFFER"
@ -488,21 +478,11 @@ zle -N autosuggest-toggle _zsh_autosuggest_widget_toggle
# #
_zsh_autosuggest_strategy_default() { _zsh_autosuggest_strategy_default() {
# Reset options to defaults and enable LOCAL_OPTIONS local prefix="$1"
emulate -L zsh
# Enable globbing flags so that we can use (#m)
setopt EXTENDED_GLOB
# Escape backslashes and all of the glob operators so we can use
# this string as a pattern to search the $history associative array.
# - (#m) globbing flag enables setting references for match data
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
# Get the history items that match # Get the history items that match
# - (r) subscript flag makes the pattern match on values # - (r) subscript flag makes the pattern match on values
suggestion="${history[(r)$prefix*]}" typeset -g suggestion="${history[(r)${(b)prefix}*]}"
} }
#--------------------------------------------------------------------# #--------------------------------------------------------------------#
@ -527,18 +507,18 @@ _zsh_autosuggest_strategy_default() {
# `HIST_EXPIRE_DUPS_FIRST`. # `HIST_EXPIRE_DUPS_FIRST`.
_zsh_autosuggest_strategy_match_prev_cmd() { _zsh_autosuggest_strategy_match_prev_cmd() {
local prefix="${1//(#m)[\\()\[\]|*?~]/\\$MATCH}" local prefix="$1"
# Get all history event numbers that correspond to history # Get all history event numbers that correspond to history
# entries that match pattern $prefix* # entries that match pattern $prefix*
local history_match_keys local history_match_keys
history_match_keys=(${(k)history[(R)$prefix*]}) history_match_keys=(${(k)history[(R)${(b)prefix}*]})
# By default we use the first history number (most recent history entry) # By default we use the first history number (most recent history entry)
local histkey="${history_match_keys[1]}" local histkey="${history_match_keys[1]}"
# Get the previously executed command # Get the previously executed command
local prev_cmd="$(_zsh_autosuggest_escape_command "${history[$((HISTCMD-1))]}")" local prev_cmd="${history[$((HISTCMD-1))]}"
# Iterate up to the first 200 history event numbers that match $prefix # Iterate up to the first 200 history event numbers that match $prefix
for key in "${(@)history_match_keys[1,200]}"; do for key in "${(@)history_match_keys[1,200]}"; do
@ -554,7 +534,7 @@ _zsh_autosuggest_strategy_match_prev_cmd() {
done done
# Give back the matched history entry # Give back the matched history entry
suggestion="$history[$histkey]" typeset -g suggestion="$history[$histkey]"
} }
#--------------------------------------------------------------------# #--------------------------------------------------------------------#
@ -621,7 +601,7 @@ _zsh_autosuggest_async_pty_create() {
typeset -h REPLY typeset -h REPLY
# If we won't get a fd back from zpty, try to guess it # If we won't get a fd back from zpty, try to guess it
if [ $_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD -eq 0 ]; then if (( ! $_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD )); then
integer -l zptyfd integer -l zptyfd
exec {zptyfd}>&1 # Open a new file descriptor (above 10). exec {zptyfd}>&1 # Open a new file descriptor (above 10).
exec {zptyfd}>&- # Close it so it's free to be used by zpty. exec {zptyfd}>&- # Close it so it's free to be used by zpty.
@ -682,7 +662,7 @@ _zsh_autosuggest_start() {
# to the widget list variables to take effect on the next precmd. # to the widget list variables to take effect on the next precmd.
add-zsh-hook precmd _zsh_autosuggest_bind_widgets add-zsh-hook precmd _zsh_autosuggest_bind_widgets
if [ -n "${ZSH_AUTOSUGGEST_USE_ASYNC+x}" ]; then if [[ -n "${ZSH_AUTOSUGGEST_USE_ASYNC+x}" ]]; then
_zsh_autosuggest_async_start _zsh_autosuggest_async_start
fi fi
} }