Allow loading the plugin in the background

If zle is already active (plugin has been loaded in the background),
just start the widgets and set up the automatic re-binding (if manual
rebind has not been specified).

See GitHub issue #481

CHANGELOG.md

@@ -1,11 +1,5 @@
 # Changelog
 
-## v0.7.0
-- Enable asynchronous mode by default (#498)
-- No longer wrap user widgets starting with `autosuggest-` prefix (#496)
-- Fix a bug wrapping widgets that modify the buffer (#541)
-
-
 ## v0.6.4
 - Fix `vi-forward-char` triggering a bell when using it to accept a suggestion (#488)
 - New configuration option to skip completion suggestions when buffer matches a pattern (#487)

INSTALL.md

@@ -39,10 +39,7 @@
 2. Add the plugin to the list of plugins for Oh My Zsh to load (inside `~/.zshrc`):
 
     ```sh
-    plugins=( 
+    plugins=(zsh-autosuggestions)
-        # other plugins...
-        zsh-autosuggestions
-    )
     ```
 
 3. Start a new terminal session.

LICENSE

@@ -1,5 +1,5 @@
 Copyright (c) 2013 Thiago de Arruda
-Copyright (c) 2016-2021 Eric Freese
+Copyright (c) 2016-2019 Eric Freese
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -79,11 +79,9 @@ Widgets that modify the buffer and are not found in any of these arrays will fet
 Set `ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE` to an integer value to disable autosuggestion for large buffers. The default is unset, which means that autosuggestion will be tried for any buffer size. Recommended value is 20.
 This can be useful when pasting large amount of text in the terminal, to avoid triggering autosuggestion for strings that are too long.
 
-### Asynchronous Mode
+### Enable Asynchronous Mode
 
-Suggestions are fetched asynchronously by default in zsh versions 5.0.8 and greater. To disable asynchronous suggestions and fetch them synchronously instead, `unset ZSH_AUTOSUGGEST_USE_ASYNC` after sourcing the plugin.
+As of `v0.4.0`, suggestions can be fetched asynchronously. To enable this behavior, set the `ZSH_AUTOSUGGEST_USE_ASYNC` variable (it can be set to anything).
-
-Alternatively, if you are using a version of zsh older than 5.0.8 and want to enable asynchronous mode, set the `ZSH_AUTOSUGGEST_USE_ASYNC` variable after sourcing the plugin (it can be set to anything). Note that there is [a bug](https://github.com/zsh-users/zsh-autosuggestions/issues/364#issuecomment-481423232) in versions of zsh older than 5.0.8 where <kbd>ctrl</kbd> + <kbd>c</kbd> will fail to reset the prompt immediately after fetching a suggestion asynchronously.
 
 ### Disabling automatic widget re-binding
 
@@ -91,13 +89,13 @@ Set `ZSH_AUTOSUGGEST_MANUAL_REBIND` (it can be set to anything) to disable autom
 
 ### Ignoring history suggestions that match a pattern
 
-Set `ZSH_AUTOSUGGEST_HISTORY_IGNORE` to a [glob pattern](http://zsh.sourceforge.net/Doc/Release/Expansion.html#Glob-Operators) to prevent offering suggestions for history entries that match the pattern. For example, set it to `"cd *"` to never suggest any `cd` commands from history. Or set to `"?(#c50,)"` to never suggest anything 50 characters or longer.
+Set `ZSH_AUTOSUGGEST_HISTORY_IGNORE` to a glob pattern to prevent offering suggestions for history entries that match the pattern. For example, set it to `"cd *"` to never suggest any `cd` commands from history. Or set to `"?(#c50,)"` to never suggest anything 50 characters or longer.
 
 **Note:** This only affects the `history` and `match_prev_cmd` suggestion strategies.
 
 ### Skipping completion suggestions for certain cases
 
-Set `ZSH_AUTOSUGGEST_COMPLETION_IGNORE` to a [glob pattern](http://zsh.sourceforge.net/Doc/Release/Expansion.html#Glob-Operators) to prevent offering completion suggestions when the buffer matches that pattern. For example, set it to `"git *"` to disable completion suggestions for git subcommands.
+Set `ZSH_AUTOSUGGEST_COMPLETION_IGNORE` to a glob pattern to prevent offering completion suggestions when the buffer matches that pattern. For example, set it to `"git *"` to disable completion suggestions for git subcommands.
 
 **Note:** This only affects the `completion` suggestion strategy.
 

VERSION

@@ -1 +1 @@
-v0.7.0
+v0.6.4

ZSH_VERSIONS

@@ -14,4 +14,3 @@
 5.5.1
 5.6.2
 5.7.1
-5.8

spec/multi_line_spec.rb

@@ -1,6 +1,11 @@
 describe 'a multi-line suggestion' do
   it 'should be displayed on multiple lines' do
-    with_history("echo \"\n\"") do
+    with_history(-> {
+      session.send_string('echo "')
+      session.send_keys('enter')
+      session.send_string('"')
+      session.send_keys('enter')
+    }) do
       session.send_keys('e')
       wait_for { session.content }.to eq("echo \"\n\"")
     end

spec/options/use_async_spec.rb

@@ -0,0 +1,7 @@
+describe 'suggestion fetching' do
+  it 'is performed synchronously'
+
+  context 'when ZSH_AUTOSUGGEST_USE_ASYNC is set' do
+    it 'is performed asynchronously'
+  end
+end

spec/spec_helper.rb

@@ -1,7 +1,6 @@
 require 'pry'
 require 'rspec/wait'
 require 'terminal_session'
-require 'tempfile'
 
 RSpec.shared_context 'terminal session' do
   let(:term_opts) { {} }
@@ -22,12 +21,11 @@ RSpec.shared_context 'terminal session' do
   end
 
   def with_history(*commands, &block)
-    Tempfile.create do |f|
-      f.write(commands.map{|c| c.gsub("\n", "\\\n")}.join("\n"))
-      f.flush
-
     session.run_command('fc -p')
-      session.run_command("fc -R #{f.path}")
+
+    commands.each do |c|
+      c.respond_to?(:call) ? c.call : session.run_command(c)
+    end
 
     session.clear_screen
 
@@ -37,7 +35,6 @@ RSpec.shared_context 'terminal session' do
     session.run_command('fc -P')
   end
 end
-end
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|

spec/strategies/special_characters_helper.rb

@@ -1,71 +1,58 @@
 shared_examples 'special characters' do
-  describe 'a special character in the buffer should be treated like any other character' do
+  describe 'a special character in the buffer' do
-    it 'asterisk' 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
-    end
 
-    it 'question mark' do
       with_history('echo "hello?"', 'echo "hello."') do
         session.send_string('echo "hello?')
         wait_for { session.content }.to eq('echo "hello?"')
       end
-    end
 
-    it 'backslash' do
       with_history('echo "hello\nworld"') do
         session.send_string('echo "hello\\')
         wait_for { session.content }.to eq('echo "hello\nworld"')
       end
-    end
 
-    it 'double backslash' do
       with_history('echo "\\\\"') do
         session.send_string('echo "\\\\')
         wait_for { session.content }.to eq('echo "\\\\"')
       end
-    end
 
-    it 'tilde' do
       with_history('echo ~/foo') do
         session.send_string('echo ~')
         wait_for { session.content }.to eq('echo ~/foo')
       end
-    end
 
-    it 'parentheses' do
       with_history('echo "$(ls foo)"') do
         session.send_string('echo "$(')
         wait_for { session.content }.to eq('echo "$(ls foo)"')
       end
-    end
 
-    it 'square bracket' do
       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
-    end
 
-    it 'octothorpe' do
       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
 
-    it 'caret' do
       with_history('echo "^A"', 'echo "^B"') do
         session.send_string('echo "^A')
         wait_for { session.content }.to eq('echo "^A"')
       end
-    end
 
-    it 'dash' do
       with_history('-foo() {}') do
         session.send_string('-')
         wait_for { session.content }.to eq('-foo() {}')

src/async.zsh

@@ -44,8 +44,7 @@ _zsh_autosuggest_async_request() {
 
 	# There's a weird bug here where ^C stops working unless we force a fork
 	# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
-	autoload -Uz is-at-least
+	command true
-	is-at-least 5.8 || command true
 
 	# Read the pid from the child process
 	read _ZSH_AUTOSUGGEST_CHILD_PID <&$_ZSH_AUTOSUGGEST_ASYNC_FD

src/bind.zsh

@@ -69,7 +69,7 @@ _zsh_autosuggest_bind_widgets() {
 	ignore_widgets=(
 		.\*
 		_\*
-		${_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS/#/autosuggest-}
+		autosuggest-\*
 		$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX\*
 		$ZSH_AUTOSUGGEST_IGNORE_WIDGETS
 	)

src/start.zsh

@@ -21,13 +21,11 @@ _zsh_autosuggest_start() {
 # Mark for auto-loading the functions that we use
 autoload -Uz add-zsh-hook is-at-least
 
-# Automatically enable asynchronous mode in newer versions of zsh. Disable for
+# If zle is already running, go ahead and start the autosuggestion widgets.
-# older versions because there is a bug when using async mode where ^C does not
+# Otherwise, wait until the next precmd.
-# work immediately after fetching a suggestion.
+if zle; then
-# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
+	_zsh_autosuggest_start
-if is-at-least 5.0.8; then
+	(( ! ${+ZSH_AUTOSUGGEST_MANUAL_REBIND} )) && add-zsh-hook precmd _zsh_autosuggest_start
-	typeset -g ZSH_AUTOSUGGEST_USE_ASYNC=
+else
-fi
-
-# Start the autosuggestion widgets on the next precmd
 	add-zsh-hook precmd _zsh_autosuggest_start
+fi

src/widgets.zsh

@@ -20,7 +20,7 @@ _zsh_autosuggest_enable() {
 
 # Toggle suggestions (enable/disable)
 _zsh_autosuggest_toggle() {
-	if (( ${+_ZSH_AUTOSUGGEST_DISABLED} )); then
+	if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
 		_zsh_autosuggest_enable
 	else
 		_zsh_autosuggest_disable
@@ -61,14 +61,25 @@ _zsh_autosuggest_modify() {
 		return $retval
 	fi
 
-	# Optimize if manually typing in the suggestion or if buffer hasn't changed
+	# Optimize if manually typing in the suggestion
-	if [[ "$BUFFER" = "$orig_buffer"* && "$orig_postdisplay" = "${BUFFER:$#orig_buffer}"* ]]; then
+	if (( $#BUFFER > $#orig_buffer )); then
-		POSTDISPLAY="${orig_postdisplay:$(($#BUFFER - $#orig_buffer))}"
+		local added=${BUFFER#$orig_buffer}
+
+		# If the string added matches the beginning of the postdisplay
+		if [[ "$added" = "${orig_postdisplay:0:$#added}" ]]; then
+			POSTDISPLAY="${orig_postdisplay:$#added}"
+			return $retval
+		fi
+	fi
+
+	# Don't fetch a new suggestion if the buffer hasn't changed
+	if [[ "$BUFFER" = "$orig_buffer" ]]; then
+		POSTDISPLAY="$orig_postdisplay"
 		return $retval
 	fi
 
 	# Bail out if suggestions are disabled
-	if (( ${+_ZSH_AUTOSUGGEST_DISABLED} )); then
+	if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
 		return $?
 	fi
 
@@ -194,21 +205,8 @@ _zsh_autosuggest_partial_accept() {
 }
 
 () {
-	typeset -ga _ZSH_AUTOSUGGEST_BUILTIN_ACTIONS
-
-	_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS=(
-		clear
-		fetch
-		suggest
-		accept
-		execute
-		enable
-		disable
-		toggle
-	)
-
 	local action
-	for action in $_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS modify partial_accept; do
+	for action in clear modify fetch suggest accept partial_accept execute enable disable toggle; do
 		eval "_zsh_autosuggest_widget_$action() {
 			local -i retval
 
@@ -225,7 +223,12 @@ _zsh_autosuggest_partial_accept() {
 		}"
 	done
 
-	for action in $_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS; do
+	zle -N autosuggest-fetch _zsh_autosuggest_widget_fetch
-		zle -N autosuggest-$action _zsh_autosuggest_widget_$action
+	zle -N autosuggest-suggest _zsh_autosuggest_widget_suggest
-	done
+	zle -N autosuggest-accept _zsh_autosuggest_widget_accept
+	zle -N autosuggest-clear _zsh_autosuggest_widget_clear
+	zle -N autosuggest-execute _zsh_autosuggest_widget_execute
+	zle -N autosuggest-enable _zsh_autosuggest_widget_enable
+	zle -N autosuggest-disable _zsh_autosuggest_widget_disable
+	zle -N autosuggest-toggle _zsh_autosuggest_widget_toggle
 }

zsh-autosuggestions.zsh

@@ -1,8 +1,8 @@
 # Fish-like fast/unobtrusive autosuggestions for zsh.
 # https://github.com/zsh-users/zsh-autosuggestions
-# v0.7.0
+# v0.6.4
 # Copyright (c) 2013 Thiago de Arruda
-# Copyright (c) 2016-2021 Eric Freese
+# Copyright (c) 2016-2019 Eric Freese
 # 
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation
@@ -199,7 +199,7 @@ _zsh_autosuggest_bind_widgets() {
 	ignore_widgets=(
 		.\*
 		_\*
-		${_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS/#/autosuggest-}
+		autosuggest-\*
 		$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX\*
 		$ZSH_AUTOSUGGEST_IGNORE_WIDGETS
 	)
@@ -282,7 +282,7 @@ _zsh_autosuggest_enable() {
 
 # Toggle suggestions (enable/disable)
 _zsh_autosuggest_toggle() {
-	if (( ${+_ZSH_AUTOSUGGEST_DISABLED} )); then
+	if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
 		_zsh_autosuggest_enable
 	else
 		_zsh_autosuggest_disable
@@ -323,14 +323,25 @@ _zsh_autosuggest_modify() {
 		return $retval
 	fi
 
-	# Optimize if manually typing in the suggestion or if buffer hasn't changed
+	# Optimize if manually typing in the suggestion
-	if [[ "$BUFFER" = "$orig_buffer"* && "$orig_postdisplay" = "${BUFFER:$#orig_buffer}"* ]]; then
+	if (( $#BUFFER > $#orig_buffer )); then
-		POSTDISPLAY="${orig_postdisplay:$(($#BUFFER - $#orig_buffer))}"
+		local added=${BUFFER#$orig_buffer}
+
+		# If the string added matches the beginning of the postdisplay
+		if [[ "$added" = "${orig_postdisplay:0:$#added}" ]]; then
+			POSTDISPLAY="${orig_postdisplay:$#added}"
+			return $retval
+		fi
+	fi
+
+	# Don't fetch a new suggestion if the buffer hasn't changed
+	if [[ "$BUFFER" = "$orig_buffer" ]]; then
+		POSTDISPLAY="$orig_postdisplay"
 		return $retval
 	fi
 
 	# Bail out if suggestions are disabled
-	if (( ${+_ZSH_AUTOSUGGEST_DISABLED} )); then
+	if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
 		return $?
 	fi
 
@@ -456,21 +467,8 @@ _zsh_autosuggest_partial_accept() {
 }
 
 () {
-	typeset -ga _ZSH_AUTOSUGGEST_BUILTIN_ACTIONS
-
-	_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS=(
-		clear
-		fetch
-		suggest
-		accept
-		execute
-		enable
-		disable
-		toggle
-	)
-
 	local action
-	for action in $_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS modify partial_accept; do
+	for action in clear modify fetch suggest accept partial_accept execute enable disable toggle; do
 		eval "_zsh_autosuggest_widget_$action() {
 			local -i retval
 
@@ -487,9 +485,14 @@ _zsh_autosuggest_partial_accept() {
 		}"
 	done
 
-	for action in $_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS; do
+	zle -N autosuggest-fetch _zsh_autosuggest_widget_fetch
-		zle -N autosuggest-$action _zsh_autosuggest_widget_$action
+	zle -N autosuggest-suggest _zsh_autosuggest_widget_suggest
-	done
+	zle -N autosuggest-accept _zsh_autosuggest_widget_accept
+	zle -N autosuggest-clear _zsh_autosuggest_widget_clear
+	zle -N autosuggest-execute _zsh_autosuggest_widget_execute
+	zle -N autosuggest-enable _zsh_autosuggest_widget_enable
+	zle -N autosuggest-disable _zsh_autosuggest_widget_disable
+	zle -N autosuggest-toggle _zsh_autosuggest_widget_toggle
 }
 
 #--------------------------------------------------------------------#
@@ -799,8 +802,7 @@ _zsh_autosuggest_async_request() {
 
 	# There's a weird bug here where ^C stops working unless we force a fork
 	# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
-	autoload -Uz is-at-least
+	command true
-	is-at-least 5.8 || command true
 
 	# Read the pid from the child process
 	read _ZSH_AUTOSUGGEST_CHILD_PID <&$_ZSH_AUTOSUGGEST_ASYNC_FD
@@ -852,13 +854,11 @@ _zsh_autosuggest_start() {
 # Mark for auto-loading the functions that we use
 autoload -Uz add-zsh-hook is-at-least
 
-# Automatically enable asynchronous mode in newer versions of zsh. Disable for
+# If zle is already running, go ahead and start the autosuggestion widgets.
-# older versions because there is a bug when using async mode where ^C does not
+# Otherwise, wait until the next precmd.
-# work immediately after fetching a suggestion.
+if zle; then
-# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
+	_zsh_autosuggest_start
-if is-at-least 5.0.8; then
+	(( ! ${+ZSH_AUTOSUGGEST_MANUAL_REBIND} )) && add-zsh-hook precmd _zsh_autosuggest_start
-	typeset -g ZSH_AUTOSUGGEST_USE_ASYNC=
+else
-fi
-
-# Start the autosuggestion widgets on the next precmd
 	add-zsh-hook precmd _zsh_autosuggest_start
+fi