Compare commits

..
Author SHA1 Message Date
Eric Freese 36dae44064 WIP implementing a historywords suggestion strategy 2019-06-23 13:39:00 -06:00
18 changed files with 155 additions and 281 deletions
+1
View File
@@ -5,6 +5,7 @@ jobs:
shell: /bin/bash --login shell: /bin/bash --login
docker: docker:
- image: ericfreese/zsh-autosuggestions-test:latest - image: ericfreese/zsh-autosuggestions-test:latest
command: /sbin/init
steps: steps:
- checkout - checkout
- run: - run:
-36
View File
@@ -1,36 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
### Describe the bug
<!-- A clear and concise description of what the bug is. -->
### To Reproduce
Steps to reproduce the behavior:
<!-- If you are not able to reproduce it by running `zsh -df` and sourcing the plugin manually, it means there that the issue is caused by something in your local config file(s). Temporarily comment out or remove sections of your config and restart `zsh` until you narrow down exactly what is causing the issue. -->
```sh
% zsh -df
% source path/to/zsh-autosuggestions.zsh
% ... # what do you do to reproduce?
```
### Expected behavior
<!-- A clear and concise description of what you expected to happen. -->
### Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->
### Desktop
- OS + distribution: <!-- e.g. Arch Linux 2019.07.01 -->
- Zsh version: <!-- `echo $ZSH_VERSION` -->
- Plugin version: <!-- or git commit hash if installed via git -->
### Additional context
<!-- Add any other context about the problem here. -->
-20
View File
@@ -1,20 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---
### Is your feature request related to a problem? Please describe.
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
### Describe the solution you'd like
<!-- A clear and concise description of what you want to happen. -->
### Describe alternatives you've considered
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
### Additional context
<!-- Add any other context or screenshots about the feature request here. -->
-8
View File
@@ -1,13 +1,5 @@
# Changelog # Changelog
## 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)
- New configuration option to ignore history entries matching a pattern (#456)
## v0.6.3
- Fixed bug moving cursor to end of buffer after accepting suggestion (#453)
## v0.6.2 ## v0.6.2
- Fixed bug deleting the last character in the buffer in vi mode (#450) - Fixed bug deleting the last character in the buffer in vi mode (#450)
- Degrade gracefully when user doesn't have `zsh/system` module installed (#447) - Degrade gracefully when user doesn't have `zsh/system` module installed (#447)
+39 -17
View File
@@ -1,22 +1,26 @@
# Installation # Installation
* [Packages](#packages) * [Manual](#manual-git-clone)
* [Antigen](#antigen) * [Antigen](#antigen)
* [Oh My Zsh](#oh-my-zsh) * [Oh My Zsh](#oh-my-zsh)
* [Manual](#manual-git-clone) * [Arch Linux](#arch-linux)
* [macOS via Homebrew](#macos-via-homebrew)
## Packages ## Manual (Git Clone)
| System | Package | 1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`.
| ------------- | ------------- |
| Debian / Ubuntu | [zsh-autosuggestions OBS repository](https://software.opensuse.org/download.html?project=shells%3Azsh-users%3Azsh-autosuggestions&package=zsh-autosuggestions) | ```sh
| Fedora / CentOS / RHEL / Scientific Linux | [zsh-autosuggestions OBS repository](https://software.opensuse.org/download.html?project=shells%3Azsh-users%3Azsh-autosuggestions&package=zsh-autosuggestions) | git clone https://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions
| OpenSUSE / SLE | [zsh-autosuggestions OBS repository](https://software.opensuse.org/download.html?project=shells%3Azsh-users%3Azsh-autosuggestions&package=zsh-autosuggestions) | ```
| Arch Linux / Manjaro / Antergos / Hyperbola | [zsh-autosuggestions](https://www.archlinux.org/packages/zsh-autosuggestions), [zsh-autosuggestions-git](https://aur.archlinux.org/packages/zsh-autosuggestions-git) |
| NixOS | [zsh-autosuggestions](https://github.com/NixOS/nixpkgs/blob/master/pkgs/shells/zsh/zsh-autosuggestions/default.nix) | 2. Add the following to your `.zshrc`:
| Void Linux | [zsh-autosuggestions](https://github.com/void-linux/void-packages/blob/master/srcpkgs/zsh-autosuggestions/template) |
| Mac OS | [homebrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/zsh-autosuggestions.rb) | ```sh
| NetBSD | [pkgsrc](http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/shells/zsh-autosuggestions/README.html) | source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh
```
3. Start a new terminal session.
## Antigen ## Antigen
@@ -44,18 +48,36 @@
3. Start a new terminal session. 3. Start a new terminal session.
## Manual (Git Clone) ## Arch Linux
1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`. 1. Install [`zsh-autosuggestions`](https://www.archlinux.org/packages/community/any/zsh-autosuggestions/) from the `community` repository.
```sh ```sh
git clone https://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions pacman -S zsh-autosuggestions
```
or, to use a package based on the `master` branch, install [`zsh-autosuggestions-git`](https://aur.archlinux.org/packages/zsh-autosuggestions-git/) from the [AUR](https://wiki.archlinux.org/index.php/Arch_User_Repository).
2. Add the following to your `.zshrc`:
```sh
source /usr/share/zsh/plugins/zsh-autosuggestions/zsh-autosuggestions.zsh
```
3. Start a new terminal session.
## macOS via Homebrew
1. Install the `zsh-autosuggestions` package using [Homebrew](https://brew.sh/).
```sh
brew install zsh-autosuggestions
``` ```
2. Add the following to your `.zshrc`: 2. Add the following to your `.zshrc`:
```sh ```sh
source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh source /usr/local/share/zsh-autosuggestions/zsh-autosuggestions.zsh
``` ```
3. Start a new terminal session. 3. Start a new terminal session.
+3 -16
View File
@@ -6,8 +6,7 @@ It suggests commands as you type based on history and completions.
Requirements: Zsh v4.3.11 or later Requirements: Zsh v4.3.11 or later
[![CircleCI](https://img.shields.io/circleci/build/github/zsh-users/zsh-autosuggestions.svg)](https://circleci.com/gh/zsh-users/zsh-autosuggestions) [![CircleCI](https://circleci.com/gh/zsh-users/zsh-autosuggestions.svg?style=svg)](https://circleci.com/gh/zsh-users/zsh-autosuggestions)
[![Chat on Gitter](https://img.shields.io/gitter/room/zsh-users/zsh-autosuggestions.svg)](https://gitter.im/zsh-users/zsh-autosuggestions)
<a href="https://asciinema.org/a/37390" target="_blank"><img src="https://asciinema.org/a/37390.png" width="400" /></a> <a href="https://asciinema.org/a/37390" target="_blank"><img src="https://asciinema.org/a/37390.png" width="400" /></a>
@@ -35,7 +34,7 @@ You may want to override the default global config variables. Default values of
### Suggestion Highlight Style ### Suggestion Highlight Style
Set `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` to configure the style that the suggestion is shown with. The default is `fg=8`, which will set the foreground color to color 8 from the [256-color palette](https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg). If your terminal only supports 8 colors, you will need to use a number between 0 and 7. Set `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` to configure the style that the suggestion is shown with. The default is `fg=8`, which will set the foreground color to color 8 from the 256-color palette. If your terminal only supports 8 colors, you will need to use a number between 0 and 7.
Background color can also be set, and the suggestion can be styled bold, underlined, or standout. For example, this would show suggestions with bold, underlined, pink text on a cyan background: Background color can also be set, and the suggestion can be styled bold, underlined, or standout. For example, this would show suggestions with bold, underlined, pink text on a cyan background:
@@ -53,8 +52,8 @@ For more info, read the Character Highlighting section of the zsh manual: `man z
`ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated. The strategies in the array are tried successively until a suggestion is found. There are currently three built-in strategies to choose from: `ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated. The strategies in the array are tried successively until a suggestion is found. There are currently three built-in strategies to choose from:
- `history`: Chooses the most recent match from history. - `history`: Chooses the most recent match from history.
- `completion`: Chooses a suggestion based on what tab-completion would suggest. (requires `zpty` module)
- `match_prev_cmd`: Like `history`, but chooses the most recent match whose preceding history item matches the most recently executed command ([more info](src/strategies/match_prev_cmd.zsh)). Note that this strategy won't work as expected with ZSH options that don't preserve the history order such as `HIST_IGNORE_ALL_DUPS` or `HIST_EXPIRE_DUPS_FIRST`. - `match_prev_cmd`: Like `history`, but chooses the most recent match whose preceding history item matches the most recently executed command ([more info](src/strategies/match_prev_cmd.zsh)). Note that this strategy won't work as expected with ZSH options that don't preserve the history order such as `HIST_IGNORE_ALL_DUPS` or `HIST_EXPIRE_DUPS_FIRST`.
- `completion`: (experimental) Chooses a suggestion based on what tab-completion would suggest. (requires `zpty` module)
For example, setting `ZSH_AUTOSUGGEST_STRATEGY=(history completion)` will first try to find a suggestion from your history, but, if it can't find a match, will find a suggestion from the completion engine. For example, setting `ZSH_AUTOSUGGEST_STRATEGY=(history completion)` will first try to find a suggestion from your history, but, if it can't find a match, will find a suggestion from the completion engine.
@@ -87,18 +86,6 @@ As of `v0.4.0`, suggestions can be fetched asynchronously. To enable this behavi
Set `ZSH_AUTOSUGGEST_MANUAL_REBIND` (it can be set to anything) to disable automatic widget re-binding on each precmd. This can be a big boost to performance, but you'll need to handle re-binding yourself if any of the widget lists change or if you or another plugin wrap any of the autosuggest widgets. To re-bind widgets, run `_zsh_autosuggest_bind_widgets`. Set `ZSH_AUTOSUGGEST_MANUAL_REBIND` (it can be set to anything) to disable automatic widget re-binding on each precmd. This can be a big boost to performance, but you'll need to handle re-binding yourself if any of the widget lists change or if you or another plugin wrap any of the autosuggest widgets. To re-bind widgets, run `_zsh_autosuggest_bind_widgets`.
### Ignoring history suggestions that match a pattern
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 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.
### Key Bindings ### Key Bindings
+1 -1
View File
@@ -1 +1 @@
v0.6.4 v0.6.2
+1 -2
View File
@@ -5,13 +5,12 @@ describe 'a zle widget' do
context 'when added to ZSH_AUTOSUGGEST_ACCEPT_WIDGETS' do context 'when added to ZSH_AUTOSUGGEST_ACCEPT_WIDGETS' do
let(:options) { ["ZSH_AUTOSUGGEST_ACCEPT_WIDGETS+=(#{widget})"] } let(:options) { ["ZSH_AUTOSUGGEST_ACCEPT_WIDGETS+=(#{widget})"] }
it 'accepts the suggestion and moves the cursor to the end of the buffer when invoked' do it 'accepts the suggestion when invoked' do
with_history('echo hello') do with_history('echo hello') do
session.send_string('e') session.send_string('e')
wait_for { session.content }.to eq('echo hello') wait_for { session.content }.to eq('echo hello')
session.send_keys('C-b') session.send_keys('C-b')
wait_for { session.content(esc_seqs: true) }.to eq('echo hello') wait_for { session.content(esc_seqs: true) }.to eq('echo hello')
wait_for { session.cursor }.to eq([10, 0])
end end
end end
end end
+1 -18
View File
@@ -5,9 +5,7 @@ describe 'the `completion` suggestion strategy' do
session. session.
run_command('autoload compinit && compinit'). run_command('autoload compinit && compinit').
run_command('_foo() { compadd bar; compadd bat }'). run_command('_foo() { compadd bar; compadd bat }').
run_command('_num() { compadd two; compadd three }'). run_command('compdef _foo baz')
run_command('compdef _foo baz').
run_command('compdef _num one')
end end
end end
@@ -39,21 +37,6 @@ describe 'the `completion` suggestion strategy' do
end end
end end
context 'when ZSH_AUTOSUGGEST_COMPLETION_IGNORE is set to a pattern' do
let(:options) { ['ZSH_AUTOSUGGEST_STRATEGY=completion', 'ZSH_AUTOSUGGEST_COMPLETION_IGNORE="one *"'] }
it 'makes suggestions when the buffer does not match the pattern' do
session.send_string('baz ')
wait_for { session.content }.to eq('baz bar')
end
it 'does not make suggestions when the buffer matches the pattern' do
session.send_string('one t')
sleep 1
expect(session.content).to eq('one t')
end
end
context 'when async mode is enabled' do context 'when async mode is enabled' do
let(:options) { ['ZSH_AUTOSUGGEST_USE_ASYNC=true', 'ZSH_AUTOSUGGEST_STRATEGY=completion'] } let(:options) { ['ZSH_AUTOSUGGEST_USE_ASYNC=true', 'ZSH_AUTOSUGGEST_STRATEGY=completion'] }
-11
View File
@@ -8,16 +8,5 @@ describe 'the `history` suggestion strategy' do
end end
end end
context 'when ZSH_AUTOSUGGEST_HISTORY_IGNORE is set to a pattern' do
let(:options) { ['ZSH_AUTOSUGGEST_HISTORY_IGNORE="* bar"'] }
it 'does not make suggestions that match the pattern' do
with_history('ls foo', 'ls bar', 'echo baz') do
session.send_string('ls')
wait_for { session.content }.to eq('ls foo')
end
end
end
include_examples 'special characters' include_examples 'special characters'
end end
+3 -16
View File
@@ -3,32 +3,19 @@ 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'] }
let(:history) { [ it 'suggests the last matching history entry after the previous command' do
with_history(
'echo what', 'echo what',
'ls foo', 'ls foo',
'echo what', 'echo what',
'ls bar', 'ls bar',
'ls baz', 'ls baz',
'echo what' 'echo what'
] } ) do
it 'suggests the last matching history entry after the previous command' do
with_history(*history) do
session.send_string('ls') session.send_string('ls')
wait_for { session.content }.to eq('ls bar') wait_for { session.content }.to eq('ls bar')
end end
end end
context 'when ZSH_AUTOSUGGEST_HISTORY_IGNORE is set to a pattern' do
let(:options) { ['ZSH_AUTOSUGGEST_STRATEGY=match_prev_cmd', 'ZSH_AUTOSUGGEST_HISTORY_IGNORE="* bar"'] }
it 'does not make suggestions that match the pattern' do
with_history(*history) do
session.send_string('ls')
wait_for { session.content }.to eq('ls foo')
end
end
end
include_examples 'special characters' include_examples 'special characters'
end end
+2 -10
View File
@@ -18,14 +18,6 @@ _zsh_autosuggest_start() {
_zsh_autosuggest_bind_widgets _zsh_autosuggest_bind_widgets
} }
# Mark for auto-loading the functions that we use # Start the autosuggestion widgets on the next precmd
autoload -Uz add-zsh-hook is-at-least autoload -Uz add-zsh-hook
# If zle is already running, go ahead and start the autosuggestion widgets.
# Otherwise, wait until the next precmd.
if zle; then
_zsh_autosuggest_start
(( ! ${+ZSH_AUTOSUGGEST_MANUAL_REBIND} )) && add-zsh-hook precmd _zsh_autosuggest_start
else
add-zsh-hook precmd _zsh_autosuggest_start add-zsh-hook precmd _zsh_autosuggest_start
fi
+3 -10
View File
@@ -45,6 +45,8 @@ _zsh_autosuggest_capture_completion_widget() {
zle -N autosuggest-capture-completion _zsh_autosuggest_capture_completion_widget zle -N autosuggest-capture-completion _zsh_autosuggest_capture_completion_widget
_zsh_autosuggest_capture_setup() { _zsh_autosuggest_capture_setup() {
autoload -Uz is-at-least
# There is a bug in zpty module in older zsh versions by which a # There is a bug in zpty module in older zsh versions by which a
# zpty that exits will kill all zpty processes that were forked # zpty that exits will kill all zpty processes that were forked
# before it. Here we set up a zsh exit hook to SIGKILL the zpty # before it. Here we set up a zsh exit hook to SIGKILL the zpty
@@ -94,12 +96,6 @@ _zsh_autosuggest_capture_completion_async() {
} }
_zsh_autosuggest_strategy_completion() { _zsh_autosuggest_strategy_completion() {
# Reset options to defaults and enable LOCAL_OPTIONS
emulate -L zsh
# Enable extended glob for completion ignore pattern
setopt EXTENDED_GLOB
typeset -g suggestion typeset -g suggestion
local line REPLY local line REPLY
@@ -109,9 +105,6 @@ _zsh_autosuggest_strategy_completion() {
# Exit if we don't have zpty # Exit if we don't have zpty
zmodload zsh/zpty 2>/dev/null || return zmodload zsh/zpty 2>/dev/null || return
# Exit if our search string matches the ignore pattern
[[ -n "$ZSH_AUTOSUGGEST_COMPLETION_IGNORE" ]] && [[ "$1" == $~ZSH_AUTOSUGGEST_COMPLETION_IGNORE ]] && return
# Zle will be inactive if we are in async mode # Zle will be inactive if we are in async mode
if zle; then if zle; then
zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_sync zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_sync
@@ -129,7 +122,7 @@ _zsh_autosuggest_strategy_completion() {
# versions of zsh (older than 5.3), we sometimes get extra bytes after # versions of zsh (older than 5.3), we sometimes get extra bytes after
# the second null byte, so trim those off the end. # the second null byte, so trim those off the end.
# See http://www.zsh.org/mla/workers/2015/msg03290.html # See http://www.zsh.org/mla/workers/2015/msg03290.html
suggestion="${${(@0)line}[2]}" suggestion="${${line#*$'\0'}%$'\0'*}"
} always { } always {
# Destroy the pty # Destroy the pty
zpty -d $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME zpty -d $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME
+3 -10
View File
@@ -10,7 +10,7 @@ _zsh_autosuggest_strategy_history() {
# Reset options to defaults and enable LOCAL_OPTIONS # Reset options to defaults and enable LOCAL_OPTIONS
emulate -L zsh emulate -L zsh
# Enable globbing flags so that we can use (#m) and (x~y) glob operator # Enable globbing flags so that we can use (#m)
setopt EXTENDED_GLOB setopt EXTENDED_GLOB
# Escape backslashes and all of the glob operators so we can use # Escape backslashes and all of the glob operators so we can use
@@ -19,14 +19,7 @@ _zsh_autosuggest_strategy_history() {
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8 # TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}" local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
# Get the history items that match the prefix, excluding those that match # Get the history items that match
# the ignore pattern
local pattern="$prefix*"
if [[ -n $ZSH_AUTOSUGGEST_HISTORY_IGNORE ]]; then
pattern="($pattern)~($ZSH_AUTOSUGGEST_HISTORY_IGNORE)"
fi
# Give the first history item matching the pattern as the suggestion
# - (r) subscript flag makes the pattern match on values # - (r) subscript flag makes the pattern match on values
typeset -g suggestion="${history[(r)$pattern]}" typeset -g suggestion="${history[(r)${prefix}*]}"
} }
+28
View File
@@ -0,0 +1,28 @@
#--------------------------------------------------------------------#
# History Words Suggestion Strategy #
#--------------------------------------------------------------------#
# Suggests the most recent history word that matches the given
# prefix.
#
_zsh_autosuggest_strategy_historywords() {
# Reset options to defaults and enable LOCAL_OPTIONS
emulate -L zsh
# Enable globbing flags so that we can use (#m)
setopt EXTENDED_GLOB
local last_word="${${=1}[-1]}"
# 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
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
local prefix="${last_word//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
# Get the first history word that matches. Concatenate it together with the
# prefix to form the full suggestion.
# - (r) subscript flag makes the pattern match on values
typeset -g suggestion="${1:0:-$#last_word}${historywords[(r)${prefix}?*]}"
}
+3 -10
View File
@@ -24,23 +24,16 @@ _zsh_autosuggest_strategy_match_prev_cmd() {
# Reset options to defaults and enable LOCAL_OPTIONS # Reset options to defaults and enable LOCAL_OPTIONS
emulate -L zsh emulate -L zsh
# Enable globbing flags so that we can use (#m) and (x~y) glob operator # Enable globbing flags so that we can use (#m)
setopt EXTENDED_GLOB setopt EXTENDED_GLOB
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8 # TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}" local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
# Get the history items that match the prefix, excluding those that match
# the ignore pattern
local pattern="$prefix*"
if [[ -n $ZSH_AUTOSUGGEST_HISTORY_IGNORE ]]; then
pattern="($pattern)~($ZSH_AUTOSUGGEST_HISTORY_IGNORE)"
fi
# Get all history event numbers that correspond to history # Get all history event numbers that correspond to history
# entries that match the pattern # entries that match pattern $prefix*
local history_match_keys local history_match_keys
history_match_keys=(${(k)history[(R)$~pattern]}) history_match_keys=(${(k)history[(R)$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]}"
+5 -19
View File
@@ -56,7 +56,7 @@ _zsh_autosuggest_modify() {
emulate -L zsh emulate -L zsh
# 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
POSTDISPLAY="$orig_postdisplay" POSTDISPLAY="$orig_postdisplay"
return $retval return $retval
fi fi
@@ -119,7 +119,7 @@ _zsh_autosuggest_suggest() {
# Accept the entire suggestion # Accept the entire suggestion
_zsh_autosuggest_accept() { _zsh_autosuggest_accept() {
local -i retval max_cursor_pos=$#BUFFER local -i max_cursor_pos=$#BUFFER
# 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
@@ -127,33 +127,19 @@ _zsh_autosuggest_accept() {
max_cursor_pos=$((max_cursor_pos - 1)) max_cursor_pos=$((max_cursor_pos - 1))
fi fi
# If we're not in a valid state to accept a suggestion, just run the
# original widget and bail out
if (( $CURSOR != $max_cursor_pos || !$#POSTDISPLAY )); then
_zsh_autosuggest_invoke_original_widget $@
return
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 = $max_cursor_pos ]]; then
# Add the suggestion to the buffer # Add the suggestion to the buffer
BUFFER="$BUFFER$POSTDISPLAY" BUFFER="$BUFFER$POSTDISPLAY"
# Remove the suggestion # Remove the suggestion
unset POSTDISPLAY unset POSTDISPLAY
# Run the original widget before manually moving the cursor so that the
# cursor movement doesn't make the widget do something unexpected
_zsh_autosuggest_invoke_original_widget $@
retval=$?
# Move the cursor to the end of the buffer # Move the cursor to the end of the buffer
if [[ "$KEYMAP" = "vicmd" ]]; then CURSOR=${max_cursor_pos}
CURSOR=$(($#BUFFER - 1))
else
CURSOR=$#BUFFER
fi fi
return $retval _zsh_autosuggest_invoke_original_widget $@
} }
# Accept the entire suggestion and execute it # Accept the entire suggestion and execute it
+45 -60
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.6.4 # v0.6.2
# Copyright (c) 2013 Thiago de Arruda # Copyright (c) 2013 Thiago de Arruda
# Copyright (c) 2016-2019 Eric Freese # Copyright (c) 2016-2019 Eric Freese
# #
@@ -318,7 +318,7 @@ _zsh_autosuggest_modify() {
emulate -L zsh emulate -L zsh
# 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
POSTDISPLAY="$orig_postdisplay" POSTDISPLAY="$orig_postdisplay"
return $retval return $retval
fi fi
@@ -381,7 +381,7 @@ _zsh_autosuggest_suggest() {
# Accept the entire suggestion # Accept the entire suggestion
_zsh_autosuggest_accept() { _zsh_autosuggest_accept() {
local -i retval max_cursor_pos=$#BUFFER local -i max_cursor_pos=$#BUFFER
# 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
@@ -389,33 +389,19 @@ _zsh_autosuggest_accept() {
max_cursor_pos=$((max_cursor_pos - 1)) max_cursor_pos=$((max_cursor_pos - 1))
fi fi
# If we're not in a valid state to accept a suggestion, just run the
# original widget and bail out
if (( $CURSOR != $max_cursor_pos || !$#POSTDISPLAY )); then
_zsh_autosuggest_invoke_original_widget $@
return
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 = $max_cursor_pos ]]; then
# Add the suggestion to the buffer # Add the suggestion to the buffer
BUFFER="$BUFFER$POSTDISPLAY" BUFFER="$BUFFER$POSTDISPLAY"
# Remove the suggestion # Remove the suggestion
unset POSTDISPLAY unset POSTDISPLAY
# Run the original widget before manually moving the cursor so that the
# cursor movement doesn't make the widget do something unexpected
_zsh_autosuggest_invoke_original_widget $@
retval=$?
# Move the cursor to the end of the buffer # Move the cursor to the end of the buffer
if [[ "$KEYMAP" = "vicmd" ]]; then CURSOR=${max_cursor_pos}
CURSOR=$(($#BUFFER - 1))
else
CURSOR=$#BUFFER
fi fi
return $retval _zsh_autosuggest_invoke_original_widget $@
} }
# Accept the entire suggestion and execute it # Accept the entire suggestion and execute it
@@ -541,6 +527,8 @@ _zsh_autosuggest_capture_completion_widget() {
zle -N autosuggest-capture-completion _zsh_autosuggest_capture_completion_widget zle -N autosuggest-capture-completion _zsh_autosuggest_capture_completion_widget
_zsh_autosuggest_capture_setup() { _zsh_autosuggest_capture_setup() {
autoload -Uz is-at-least
# There is a bug in zpty module in older zsh versions by which a # There is a bug in zpty module in older zsh versions by which a
# zpty that exits will kill all zpty processes that were forked # zpty that exits will kill all zpty processes that were forked
# before it. Here we set up a zsh exit hook to SIGKILL the zpty # before it. Here we set up a zsh exit hook to SIGKILL the zpty
@@ -590,12 +578,6 @@ _zsh_autosuggest_capture_completion_async() {
} }
_zsh_autosuggest_strategy_completion() { _zsh_autosuggest_strategy_completion() {
# Reset options to defaults and enable LOCAL_OPTIONS
emulate -L zsh
# Enable extended glob for completion ignore pattern
setopt EXTENDED_GLOB
typeset -g suggestion typeset -g suggestion
local line REPLY local line REPLY
@@ -605,9 +587,6 @@ _zsh_autosuggest_strategy_completion() {
# Exit if we don't have zpty # Exit if we don't have zpty
zmodload zsh/zpty 2>/dev/null || return zmodload zsh/zpty 2>/dev/null || return
# Exit if our search string matches the ignore pattern
[[ -n "$ZSH_AUTOSUGGEST_COMPLETION_IGNORE" ]] && [[ "$1" == $~ZSH_AUTOSUGGEST_COMPLETION_IGNORE ]] && return
# Zle will be inactive if we are in async mode # Zle will be inactive if we are in async mode
if zle; then if zle; then
zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_sync zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_sync
@@ -625,13 +604,41 @@ _zsh_autosuggest_strategy_completion() {
# versions of zsh (older than 5.3), we sometimes get extra bytes after # versions of zsh (older than 5.3), we sometimes get extra bytes after
# the second null byte, so trim those off the end. # the second null byte, so trim those off the end.
# See http://www.zsh.org/mla/workers/2015/msg03290.html # See http://www.zsh.org/mla/workers/2015/msg03290.html
suggestion="${${(@0)line}[2]}" suggestion="${${line#*$'\0'}%$'\0'*}"
} always { } always {
# Destroy the pty # Destroy the pty
zpty -d $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME zpty -d $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME
} }
} }
#--------------------------------------------------------------------#
# History Words Suggestion Strategy #
#--------------------------------------------------------------------#
# Suggests the most recent history word that matches the given
# prefix.
#
_zsh_autosuggest_strategy_historywords() {
# Reset options to defaults and enable LOCAL_OPTIONS
emulate -L zsh
# Enable globbing flags so that we can use (#m)
setopt EXTENDED_GLOB
local last_word="${${=1}[-1]}"
# 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
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
local prefix="${last_word//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
# Get the first history word that matches. Concatenate it together with the
# prefix to form the full suggestion.
# - (r) subscript flag makes the pattern match on values
typeset -g suggestion="${1:0:-$#last_word}${historywords[(r)${prefix}?*]}"
}
#--------------------------------------------------------------------# #--------------------------------------------------------------------#
# History Suggestion Strategy # # History Suggestion Strategy #
#--------------------------------------------------------------------# #--------------------------------------------------------------------#
@@ -643,7 +650,7 @@ _zsh_autosuggest_strategy_history() {
# Reset options to defaults and enable LOCAL_OPTIONS # Reset options to defaults and enable LOCAL_OPTIONS
emulate -L zsh emulate -L zsh
# Enable globbing flags so that we can use (#m) and (x~y) glob operator # Enable globbing flags so that we can use (#m)
setopt EXTENDED_GLOB setopt EXTENDED_GLOB
# Escape backslashes and all of the glob operators so we can use # Escape backslashes and all of the glob operators so we can use
@@ -652,16 +659,9 @@ _zsh_autosuggest_strategy_history() {
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8 # TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}" local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
# Get the history items that match the prefix, excluding those that match # Get the history items that match
# the ignore pattern
local pattern="$prefix*"
if [[ -n $ZSH_AUTOSUGGEST_HISTORY_IGNORE ]]; then
pattern="($pattern)~($ZSH_AUTOSUGGEST_HISTORY_IGNORE)"
fi
# Give the first history item matching the pattern as the suggestion
# - (r) subscript flag makes the pattern match on values # - (r) subscript flag makes the pattern match on values
typeset -g suggestion="${history[(r)$pattern]}" typeset -g suggestion="${history[(r)${prefix}*]}"
} }
#--------------------------------------------------------------------# #--------------------------------------------------------------------#
@@ -689,23 +689,16 @@ _zsh_autosuggest_strategy_match_prev_cmd() {
# Reset options to defaults and enable LOCAL_OPTIONS # Reset options to defaults and enable LOCAL_OPTIONS
emulate -L zsh emulate -L zsh
# Enable globbing flags so that we can use (#m) and (x~y) glob operator # Enable globbing flags so that we can use (#m)
setopt EXTENDED_GLOB setopt EXTENDED_GLOB
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8 # TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}" local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
# Get the history items that match the prefix, excluding those that match
# the ignore pattern
local pattern="$prefix*"
if [[ -n $ZSH_AUTOSUGGEST_HISTORY_IGNORE ]]; then
pattern="($pattern)~($ZSH_AUTOSUGGEST_HISTORY_IGNORE)"
fi
# Get all history event numbers that correspond to history # Get all history event numbers that correspond to history
# entries that match the pattern # entries that match pattern $prefix*
local history_match_keys local history_match_keys
history_match_keys=(${(k)history[(R)$~pattern]}) history_match_keys=(${(k)history[(R)$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]}"
@@ -851,14 +844,6 @@ _zsh_autosuggest_start() {
_zsh_autosuggest_bind_widgets _zsh_autosuggest_bind_widgets
} }
# Mark for auto-loading the functions that we use # Start the autosuggestion widgets on the next precmd
autoload -Uz add-zsh-hook is-at-least autoload -Uz add-zsh-hook
# If zle is already running, go ahead and start the autosuggestion widgets.
# Otherwise, wait until the next precmd.
if zle; then
_zsh_autosuggest_start
(( ! ${+ZSH_AUTOSUGGEST_MANUAL_REBIND} )) && add-zsh-hook precmd _zsh_autosuggest_start
else
add-zsh-hook precmd _zsh_autosuggest_start add-zsh-hook precmd _zsh_autosuggest_start
fi