mirror of
https://github.com/zsh-users/zsh-autosuggestions.git
synced 2025-12-06 23:30:39 +01:00
Compare commits
147 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1ed9155f89 | ||
|
|
97b51a2c57 | ||
|
|
b54c8a15c6 | ||
|
|
2a6d401106 | ||
|
|
a314a01a6a | ||
|
|
e5cdbb6c33 | ||
|
|
dffd9beae1 | ||
|
|
d202b32ae9 | ||
|
|
ab0f4c0bd0 | ||
|
|
ee6dde9ee8 | ||
|
|
73f774bd5d | ||
|
|
976acc708c | ||
|
|
83f78d0760 | ||
|
|
9df362f783 | ||
|
|
125f48c7f2 | ||
|
|
8c3fdea75d | ||
|
|
aa597eea6d | ||
|
|
f0a745576f | ||
|
|
8935a39e9b | ||
|
|
c7c9929490 | ||
|
|
985de56f6e | ||
|
|
0a42f872b8 | ||
|
|
dd54925b06 | ||
|
|
c761dc8150 | ||
|
|
cc921994e6 | ||
|
|
0242c7eff1 | ||
|
|
9d100f4f32 | ||
|
|
ddb7284852 | ||
|
|
2a5791710a | ||
|
|
03fac1f0d7 | ||
|
|
aa859a282d | ||
|
|
f08a5a1baa | ||
|
|
70438d233d | ||
|
|
ba029e83d0 | ||
|
|
acc129de6c | ||
|
|
aa5ceee256 | ||
|
|
113ca0ad10 | ||
|
|
2b449a62f8 | ||
|
|
6d25df6864 | ||
|
|
0faa2b6584 | ||
|
|
a2d8d91196 | ||
|
|
dd9a8789a7 | ||
|
|
1b98af5b33 | ||
|
|
45ab49d1f2 | ||
|
|
41f15d5c9f | ||
|
|
3ce1adb55d | ||
|
|
2461a98857 | ||
|
|
76f415bf43 | ||
|
|
5e419da326 | ||
|
|
cd71081303 | ||
|
|
9788c2ee49 | ||
|
|
ebcfc46b72 | ||
|
|
b49d002888 | ||
|
|
266437c98a | ||
|
|
51b39e210e | ||
|
|
011f5420fc | ||
|
|
1a38fbf6a5 | ||
|
|
31452887d2 | ||
|
|
cf146b6696 | ||
|
|
74197498fc | ||
|
|
abe577d519 | ||
|
|
0ae5907294 | ||
|
|
03bd381112 | ||
|
|
00bd0e9125 | ||
|
|
48d2dc1091 | ||
|
|
f154d25fb3 | ||
|
|
e91db46ce0 | ||
|
|
28836f15c5 | ||
|
|
0dd1b7febb | ||
|
|
6a4b2b3865 | ||
|
|
3449ae505c | ||
|
|
775dd20706 | ||
|
|
7dc9e0f926 | ||
|
|
8777836a1c | ||
|
|
7a00bfa444 | ||
|
|
0ad9525955 | ||
|
|
ec1d251dad | ||
|
|
b1725e9e74 | ||
|
|
c044d06f70 | ||
|
|
fc4576758c | ||
|
|
cbaf7ced6e | ||
|
|
07165cd3ec | ||
|
|
dde838c226 | ||
|
|
a796ce5bdb | ||
|
|
40a8d73054 | ||
|
|
6de948c9c5 | ||
|
|
c6afbaf254 | ||
|
|
47283c2619 | ||
|
|
f090f609ac | ||
|
|
08f3b3148d | ||
|
|
8d29045ffb | ||
|
|
bbd5300d60 | ||
|
|
5b23a17241 | ||
|
|
2d5ac282a9 | ||
|
|
62af373a59 | ||
|
|
258e06c9ab | ||
|
|
f860711cc5 | ||
|
|
0371904875 | ||
|
|
4b6512d1e8 | ||
|
|
34c01f6259 | ||
|
|
e637eb58eb | ||
|
|
1bf5de2acc | ||
|
|
9b565ff6b5 | ||
|
|
24ac946dd9 | ||
|
|
59699a0946 | ||
|
|
d1640a399d | ||
|
|
533325c39d | ||
|
|
fe6e9812b0 | ||
|
|
c740515df4 | ||
|
|
3d5beea5c3 | ||
|
|
a23ad43188 | ||
|
|
c3e7668fbb | ||
|
|
8970e71d50 | ||
|
|
89b85d88cc | ||
|
|
d76af3c076 | ||
|
|
5f13490bae | ||
|
|
1be4a54048 | ||
|
|
7446059f63 | ||
|
|
71a7154815 | ||
|
|
9e710593e3 | ||
|
|
0d9aabedb2 | ||
|
|
32fb7930d8 | ||
|
|
0d36d4ccdd | ||
|
|
cbb0963896 | ||
|
|
683b48b644 | ||
|
|
85739dbe76 | ||
|
|
6dbb419a7a | ||
|
|
bd11c34e84 | ||
|
|
0cc05bd08e | ||
|
|
824b9be13f | ||
|
|
1cbd78c850 | ||
|
|
ebe4cf251a | ||
|
|
7e69ddda7f | ||
|
|
5dff7a69f1 | ||
|
|
c5567cf371 | ||
|
|
b18f01a256 | ||
|
|
a29e838cdf | ||
|
|
48f03e2b0c | ||
|
|
ea19b7bcf8 | ||
|
|
196cfa0eb0 | ||
|
|
8af98f7d29 | ||
|
|
6ddbde147f | ||
|
|
7d737e3cc8 | ||
|
|
a0d6493f34 | ||
|
|
7cb87a8a55 | ||
|
|
936056fd9b | ||
|
|
a6f53879ae |
10
.editorconfig
Normal file
10
.editorconfig
Normal file
@@ -0,0 +1,10 @@
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
indent_style = tab
|
||||
indent_size = 4
|
||||
|
||||
[*.md]
|
||||
indent_style = space
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,4 +0,0 @@
|
||||
/node_modules/
|
||||
/build/
|
||||
*.log
|
||||
*~
|
||||
6
.gitmodules
vendored
Normal file
6
.gitmodules
vendored
Normal file
@@ -0,0 +1,6 @@
|
||||
[submodule "vendor/shunit2"]
|
||||
path = vendor/shunit2
|
||||
url = https://github.com/kward/shunit2
|
||||
[submodule "vendor/stub.sh"]
|
||||
path = vendor/stub.sh
|
||||
url = https://github.com/ericfreese/stub.sh
|
||||
15
CHANGELOG.md
Normal file
15
CHANGELOG.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Changelog
|
||||
|
||||
## v0.3.0
|
||||
|
||||
- Adds `autosuggest-execute` widget (PR #124).
|
||||
- Adds concept of suggestion "strategies" for different ways of fetching suggestions.
|
||||
- Adds "match_prev_cmd" strategy (PR #131).
|
||||
- Uses git submodules for testing dependencies.
|
||||
- Lots of test cleanup.
|
||||
- Various bug fixes for zsh 5.0.x and `sh_word_split` option.
|
||||
|
||||
|
||||
## v0.2.17
|
||||
|
||||
Start of changelog.
|
||||
1
DESCRIPTION
Normal file
1
DESCRIPTION
Normal file
@@ -0,0 +1 @@
|
||||
Fish-like fast/unobtrusive autosuggestions for zsh.
|
||||
@@ -1,4 +1,5 @@
|
||||
Copyright (c) 2013 Thiago de Arruda
|
||||
Copyright (c) 2016 Eric Freese
|
||||
|
||||
Permission is hereby granted, free of charge, to any person
|
||||
obtaining a copy of this software and associated documentation
|
||||
59
Makefile
Normal file
59
Makefile
Normal file
@@ -0,0 +1,59 @@
|
||||
SRC_DIR := ./src
|
||||
TEST_DIR := ./script
|
||||
VENDOR_DIR := ./vendor
|
||||
|
||||
SRC_FILES := \
|
||||
$(SRC_DIR)/config.zsh \
|
||||
$(SRC_DIR)/deprecated.zsh \
|
||||
$(SRC_DIR)/bind.zsh \
|
||||
$(SRC_DIR)/highlight.zsh \
|
||||
$(SRC_DIR)/widgets.zsh \
|
||||
$(SRC_DIR)/suggestion.zsh \
|
||||
$(SRC_DIR)/strategies/*.zsh \
|
||||
$(SRC_DIR)/start.zsh
|
||||
|
||||
HEADER_FILES := \
|
||||
DESCRIPTION \
|
||||
URL \
|
||||
VERSION \
|
||||
LICENSE
|
||||
|
||||
PLUGIN_TARGET := zsh-autosuggestions.zsh
|
||||
OH_MY_ZSH_LINK_TARGET := zsh-autosuggestions.plugin.zsh
|
||||
|
||||
ALL_TARGETS := \
|
||||
$(PLUGIN_TARGET) \
|
||||
$(OH_MY_ZSH_LINK_TARGET)
|
||||
|
||||
SHUNIT2 := $(VENDOR_DIR)/shunit2/2.1.6
|
||||
STUB_SH := $(VENDOR_DIR)/stub.sh/stub.sh
|
||||
|
||||
TEST_PREREQS := \
|
||||
$(SHUNIT2) \
|
||||
$(STUB_SH)
|
||||
|
||||
TEST_FILES := \
|
||||
$(TEST_DIR)/**/*.zsh
|
||||
|
||||
all: $(ALL_TARGETS)
|
||||
|
||||
$(PLUGIN_TARGET): $(HEADER_FILES) $(SRC_FILES)
|
||||
cat $(HEADER_FILES) | sed -e 's/^/# /g' > $@
|
||||
cat $(SRC_FILES) >> $@
|
||||
|
||||
$(OH_MY_ZSH_LINK_TARGET): $(PLUGIN_TARGET)
|
||||
ln -s $(PLUGIN_TARGET) $@
|
||||
|
||||
$(SHUNIT2):
|
||||
git submodule update --init vendor/shunit2
|
||||
|
||||
$(STUB_SH):
|
||||
git submodule update --init vendor/stub.sh
|
||||
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm $(ALL_TARGETS)
|
||||
|
||||
.PHONY: test
|
||||
test: all $(TEST_PREREQS)
|
||||
script/test_runner.zsh
|
||||
157
README.md
Normal file
157
README.md
Normal file
@@ -0,0 +1,157 @@
|
||||
# zsh-autosuggestions
|
||||
|
||||
_[Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh._
|
||||
|
||||
It suggests commands as you type, based on command history.
|
||||
|
||||
<a href="https://asciinema.org/a/37390" target="_blank"><img src="https://asciinema.org/a/37390.png" width="400" /></a>
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Manual
|
||||
|
||||
1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`.
|
||||
|
||||
```sh
|
||||
git clone git://github.com/zsh-users/zsh-autosuggestions ~/.zsh/zsh-autosuggestions
|
||||
```
|
||||
|
||||
2. Add the following to your `.zshrc`:
|
||||
|
||||
```sh
|
||||
source ~/.zsh/zsh-autosuggestions/zsh-autosuggestions.zsh
|
||||
```
|
||||
|
||||
3. Start a new terminal session.
|
||||
|
||||
|
||||
### Oh My Zsh
|
||||
|
||||
1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`)
|
||||
|
||||
```sh
|
||||
git clone git://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:
|
||||
|
||||
```sh
|
||||
plugins=(zsh-autosuggestions)
|
||||
```
|
||||
|
||||
3. Start a new terminal session.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
As you type commands, you will see a completion offered after the cursor in a muted gray color. This color can be changed by setting the `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` variable. See [configuration](#configuration).
|
||||
|
||||
If you press the <kbd>→</kbd> key (`forward-char` widget) or <kbd>End</kbd> (`end-of-line` widget) with the cursor at the end of the buffer, it will accept the suggestion, replacing the contents of the command line buffer with the suggestion.
|
||||
|
||||
If you invoke the `forward-word` widget, it will partially accept the suggestion up to the point that the cursor moves to.
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
You may want to override the default global config variables after sourcing the plugin. Default values of these variables can be found [here](src/config.zsh).
|
||||
|
||||
**Note:** If you are using Oh My Zsh, you can put this configuration in a file in the `$ZSH_CUSTOM` directory. See their comments on [overriding internals](https://github.com/robbyrussell/oh-my-zsh/wiki/Customization#overriding-internals).
|
||||
|
||||
|
||||
### Suggestion Highlight Style
|
||||
|
||||
Set `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` to configure the style that the suggestion is shown with. The default is `fg=8`.
|
||||
|
||||
|
||||
### Suggestion Strategy
|
||||
|
||||
Set `ZSH_AUTOSUGGEST_STRATEGY` to choose the strategy for generating suggestions. There are currently two to choose from:
|
||||
|
||||
- `default`: Chooses the most recent match.
|
||||
- `match_prev_cmd`: Chooses the most recent match whose preceding history item matches the most recently executed command ([more info](src/strategies/match_prev_cmd.zsh)).
|
||||
|
||||
|
||||
### Widget Mapping
|
||||
|
||||
This plugin works by triggering custom behavior when certain [zle widgets](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets) are invoked. You can add and remove widgets from these arrays to change the behavior of this plugin:
|
||||
|
||||
- `ZSH_AUTOSUGGEST_CLEAR_WIDGETS`: Widgets in this array will clear the suggestion when invoked.
|
||||
- `ZSH_AUTOSUGGEST_ACCEPT_WIDGETS`: Widgets in this array will accept the suggestion when invoked.
|
||||
- `ZSH_AUTOSUGGEST_EXECUTE_WIDGETS`: Widgets in this array will execute the suggestion when invoked.
|
||||
- `ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS`: Widgets in this array will partially accept the suggestion when invoked.
|
||||
|
||||
Widgets not in any of these lists will update the suggestion when invoked.
|
||||
|
||||
**Note:** A widget shouldn't belong to more than one of the above arrays.
|
||||
|
||||
|
||||
### Key Bindings
|
||||
|
||||
This plugin provides three widgets that you can use with `bindkey`:
|
||||
|
||||
1. `autosuggest-accept`: Accepts the current suggestion.
|
||||
2. `autosuggest-execute`: Accepts and executes the current suggestion.
|
||||
3. `autosuggest-clear`: Clears the current suggestion.
|
||||
|
||||
For example, this would bind <kbd>ctrl</kbd> + <kbd>space</kbd> to accept the current suggestion.
|
||||
|
||||
```sh
|
||||
bindkey '^ ' autosuggest-accept
|
||||
```
|
||||
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you have a problem, please search through [the list of issues on GitHub](https://github.com/zsh-users/zsh-autosuggestions/issues) to see if someone else has already reported it.
|
||||
|
||||
|
||||
### Reporting an Issue
|
||||
|
||||
Before reporting an issue, please try temporarily disabling sections of your configuration and other plugins that may be conflicting with this plugin to isolate the problem.
|
||||
|
||||
When reporting an issue, please include:
|
||||
|
||||
- The smallest, simplest `.zshrc` configuration that will reproduce the problem. See [this comment](https://github.com/zsh-users/zsh-autosuggestions/issues/102#issuecomment-180944764) for a good example of what this means.
|
||||
- The version of zsh you're using (`zsh --version`)
|
||||
- Which operating system you're running
|
||||
|
||||
|
||||
## Uninstallation
|
||||
|
||||
1. Remove the code referencing this plugin from `~/.zshrc`.
|
||||
|
||||
2. Remove the git repository from your hard drive
|
||||
|
||||
```sh
|
||||
rm -rf ~/.zsh/zsh-autosuggestions # Or wherever you installed
|
||||
```
|
||||
|
||||
|
||||
## Development
|
||||
|
||||
### Build Process
|
||||
|
||||
Edit the source files in `src/`. Run `make` to build `zsh-autosuggestions.zsh` from those source files.
|
||||
|
||||
|
||||
### Pull Requests
|
||||
|
||||
Pull requests are welcome! If you send a pull request, please:
|
||||
|
||||
- Match the existing coding conventions.
|
||||
- Include helpful comments to keep the barrier-to-entry low for people new to the project.
|
||||
- Write tests that cover your code as much as possible.
|
||||
|
||||
|
||||
### Testing
|
||||
|
||||
Testing is performed with [`shunit2`](https://github.com/kward/shunit2) (v2.1.6). Documentation can be found [here](http://shunit2.googlecode.com/svn/trunk/source/2.1/doc/shunit2.html).
|
||||
|
||||
The test script lives at `script/test.zsh`. To run the tests, run `make test`.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under [MIT license](http://opensource.org/licenses/MIT).
|
||||
For the full text of the license, see the [LICENSE](LICENSE) file.
|
||||
20
README.mkd
20
README.mkd
@@ -1,20 +0,0 @@
|
||||
# zsh-autosuggestions
|
||||
|
||||
> [Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh.
|
||||
> [Shelr demo](http://shelr.tv/records/527007a99660803c5d000048).
|
||||
|
||||
## Installation
|
||||
|
||||
```zsh
|
||||
git clone git://github.com/tarruda/zsh-autosuggestions ~/.zsh-autosuggestions
|
||||
cat >> ~/.zshrc << "EOF"
|
||||
source ~/.zsh-autosuggestions/autosuggestions.zsh
|
||||
# Enable autosuggestions automatically
|
||||
zle-line-init() {
|
||||
zle autosuggest-start
|
||||
}
|
||||
zle -N zle-line-init
|
||||
# use ctrl+f to accept a suggested word
|
||||
bindkey '^F' autosuggest-accept-suggested-word
|
||||
EOF
|
||||
```
|
||||
@@ -1,168 +0,0 @@
|
||||
# Fish-like autosuggestions for zsh. Some of the code was based on the code
|
||||
# for 'predict-on'
|
||||
#
|
||||
# ```zsh
|
||||
# zle-line-init() {
|
||||
# autosuggest-start
|
||||
# }
|
||||
# zle -N zle-line-init
|
||||
# ```
|
||||
|
||||
ZLE_AUTOSUGGEST_PAUSE_WIDGETS=(
|
||||
vi-cmd-mode vi-backward-char backward-char backward-word beginning-of-line
|
||||
history-search-forward history-search-backward up-line-or-history
|
||||
down-line-or-history
|
||||
)
|
||||
|
||||
ZLE_AUTOSUGGEST_COMPLETION_WIDGETS=(
|
||||
complete-word expand-or-complete expand-or-complete-prefix list-choices
|
||||
menu-complete reverse-menu-complete menu-expand-or-complete menu-select
|
||||
accept-and-menu-complete
|
||||
)
|
||||
|
||||
autosuggest-pause() {
|
||||
[[ -z $ZLE_AUTOSUGGESTING ]] && return
|
||||
unset ZLE_AUTOSUGGESTING
|
||||
local widget
|
||||
# When autosuggestions are disabled, kill the unmaterialized part
|
||||
RBUFFER=''
|
||||
zle -A self-insert autosuggest-paused-self-insert
|
||||
zle -A .magic-space magic-space
|
||||
zle -A .backward-delete-char backward-delete-char
|
||||
zle -A .accept-line accept-line
|
||||
for widget in $ZLE_AUTOSUGGEST_PAUSE_WIDGETS; do
|
||||
eval "zle -A autosuggest-${widget}-orig ${widget}"
|
||||
done
|
||||
for widget in $ZLE_AUTOSUGGEST_COMPLETION_WIDGETS; do
|
||||
eval "zle -A autosuggest-${widget}-orig $widget"
|
||||
done
|
||||
autosuggest-highlight-suggested-text
|
||||
}
|
||||
|
||||
autosuggest-resume() {
|
||||
[[ -n $ZLE_AUTOSUGGESTING ]] && return
|
||||
ZLE_AUTOSUGGESTING=1
|
||||
local widget
|
||||
# Replace prediction widgets by versions that will also highlight RBUFFER
|
||||
zle -N self-insert autosuggest-insert-or-space
|
||||
zle -N magic-space autosuggest-insert-or-space
|
||||
zle -N backward-delete-char autosuggest-backward-delete-char
|
||||
zle -N accept-line autosuggest-accept-line
|
||||
# Hook into some default widgets that should pause autosuggestion
|
||||
# automatically
|
||||
for widget in $ZLE_AUTOSUGGEST_PAUSE_WIDGETS; do
|
||||
eval "zle -A $widget autosuggest-${widget}-orig; \
|
||||
zle -A autosuggest-suspend $widget"
|
||||
done
|
||||
# Hook into completion widgets to handle suggestions after completions
|
||||
for widget in $ZLE_AUTOSUGGEST_COMPLETION_WIDGETS; do
|
||||
eval "zle -A $widget autosuggest-${widget}-orig; \
|
||||
zle -A autosuggest-tab $widget"
|
||||
done
|
||||
if [[ $BUFFER != '' ]]; then
|
||||
autosuggest-request-suggestion
|
||||
fi
|
||||
}
|
||||
|
||||
autosuggest-start() {
|
||||
autosuggest-resume
|
||||
}
|
||||
|
||||
autosuggest-highlight-suggested-text() {
|
||||
if [[ -n $ZLE_AUTOSUGGESTING ]]; then
|
||||
local color='fg=8'
|
||||
[[ -n $AUTOSUGGESTION_HIGHLIGHT_COLOR ]] &&\
|
||||
color=$AUTOSUGGESTION_HIGHLIGHT_COLOR
|
||||
region_highlight=("$(( $CURSOR + 1 )) $(( $CURSOR + $#RBUFFER )) $color")
|
||||
else
|
||||
region_highlight=()
|
||||
fi
|
||||
}
|
||||
|
||||
autosuggest-insert-or-space() {
|
||||
if [[ $LBUFFER == *$'\012'* ]] || (( PENDING )); then
|
||||
# Editing a multiline buffer or pasting in a chunk of text, dont
|
||||
# autosuggest
|
||||
zle .$WIDGET "$@"
|
||||
elif [[ ${RBUFFER[1]} == ${KEYS[-1]} ]]; then
|
||||
# Same as what's typed, just move on
|
||||
((++CURSOR))
|
||||
autosuggest-highlight-suggested-text
|
||||
else
|
||||
LBUFFER="$LBUFFER$KEYS"
|
||||
autosuggest-request-suggestion
|
||||
fi
|
||||
}
|
||||
|
||||
autosuggest-backward-delete-char() {
|
||||
if ! (( CURSOR )); then
|
||||
zle .kill-whole-line
|
||||
return
|
||||
fi
|
||||
|
||||
if [[ $LBUFFER == *$'\012'* || $LASTWIDGET != (self-insert|magic-space|backward-delete-char) ]]; then
|
||||
# When editing a multiline buffer or if the last widget was e.g. a motion,
|
||||
# then probably the intent is to actually edit the line, not change the
|
||||
# search prefix.
|
||||
LBUFFER="$LBUFFER[1,-2]"
|
||||
else
|
||||
((--CURSOR))
|
||||
zle .history-beginning-search-forward || RBUFFER=''
|
||||
fi
|
||||
}
|
||||
|
||||
# When autosuggesting, ignore RBUFFER which corresponds to the 'unmaterialized'
|
||||
# section when the user accepts the line
|
||||
autosuggest-accept-line() {
|
||||
RBUFFER=''
|
||||
region_highlight=()
|
||||
zle .accept-line
|
||||
}
|
||||
|
||||
autosuggest-paused-self-insert() {
|
||||
if [[ $RBUFFER == '' ]]; then
|
||||
# Resume autosuggestions when inserting at the end of the line
|
||||
autosuggest-resume
|
||||
zle autosuggest-modify
|
||||
else
|
||||
zle .self-insert
|
||||
fi
|
||||
}
|
||||
|
||||
autosuggest-request-suggestion() {
|
||||
if (( $CURSOR == 0 )) || [[ ${LBUFFER[-1]} == ' ' ]]; then
|
||||
RBUFFER=''
|
||||
return
|
||||
fi
|
||||
|
||||
[[ -n $ZLE_DISABLE_AUTOSUGGEST || $LBUFFER == '' ]] && return
|
||||
zle .history-beginning-search-backward || RBUFFER=''
|
||||
autosuggest-highlight-suggested-text
|
||||
}
|
||||
|
||||
autosuggest-suspend() {
|
||||
autosuggest-pause
|
||||
zle autosuggest-${WIDGET}-orig "$@"
|
||||
}
|
||||
|
||||
autosuggest-tab() {
|
||||
RBUFFER=''
|
||||
zle autosuggest-${WIDGET}-orig "$@"
|
||||
autosuggest-highlight-suggested-text
|
||||
}
|
||||
|
||||
autosuggest-accept-suggested-small-word() {
|
||||
zle .vi-forward-word
|
||||
autosuggest-highlight-suggested-text
|
||||
}
|
||||
|
||||
autosuggest-accept-suggested-word() {
|
||||
zle .forward-word
|
||||
autosuggest-highlight-suggested-text
|
||||
}
|
||||
|
||||
zle -N autosuggest-start
|
||||
zle -N autosuggest-accept-suggested-small-word
|
||||
zle -N autosuggest-accept-suggested-word
|
||||
zle -N autosuggest-suspend
|
||||
zle -N autosuggest-tab
|
||||
374
script/test.zsh
Executable file
374
script/test.zsh
Executable file
@@ -0,0 +1,374 @@
|
||||
#!/usr/bin/env zsh
|
||||
|
||||
SCRIPT_DIR=$(dirname "$0")
|
||||
TEST_DIR=$SCRIPT_DIR/../test
|
||||
DIST_DIR=$SCRIPT_DIR/../
|
||||
|
||||
# Use stub.sh for stubbing/mocking
|
||||
source $TEST_DIR/stub-1.0.2.sh
|
||||
|
||||
source $DIST_DIR/zsh-autosuggestions.zsh
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Highlighting #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
testHighlightDefaultStyle() {
|
||||
assertEquals \
|
||||
"fg=8" \
|
||||
"$ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE"
|
||||
}
|
||||
|
||||
testHighlightApplyWithSuggestion() {
|
||||
orig_style=ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE
|
||||
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE="fg=4"
|
||||
|
||||
BUFFER="ec"
|
||||
POSTDISPLAY="ho hello"
|
||||
region_highlight=("0 2 fg=1")
|
||||
|
||||
_zsh_autosuggest_highlight_apply
|
||||
|
||||
assertEquals \
|
||||
"highlight did not use correct style" \
|
||||
"0 2 fg=1 2 10 $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" \
|
||||
"$region_highlight"
|
||||
|
||||
assertEquals \
|
||||
"higlight was not saved to be removed later" \
|
||||
"2 10 $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" \
|
||||
"$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT"
|
||||
|
||||
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE=orig_style
|
||||
}
|
||||
|
||||
testHighlightApplyWithoutSuggestion() {
|
||||
BUFFER="echo hello"
|
||||
POSTDISPLAY=""
|
||||
region_highlight=("0 4 fg=1")
|
||||
|
||||
_zsh_autosuggest_highlight_apply
|
||||
|
||||
assertEquals \
|
||||
"region_highlight was modified" \
|
||||
"0 4 fg=1" \
|
||||
"$region_highlight"
|
||||
|
||||
assertNull \
|
||||
"last highlight region was not cleared" \
|
||||
"$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT"
|
||||
}
|
||||
|
||||
testHighlightReset() {
|
||||
BUFFER="ec"
|
||||
POSTDISPLAY="ho hello"
|
||||
region_highlight=("0 1 fg=1" "2 10 fg=8" "1 2 fg=1")
|
||||
_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT="2 10 fg=8"
|
||||
|
||||
_zsh_autosuggest_highlight_reset
|
||||
|
||||
assertEquals \
|
||||
"last highlight region was not removed" \
|
||||
"0 1 fg=1 1 2 fg=1" \
|
||||
"$region_highlight"
|
||||
|
||||
assertNull \
|
||||
"last highlight variable was not cleared" \
|
||||
"$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT"
|
||||
}
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Widgets #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
testWidgetFunctionClear() {
|
||||
BUFFER="ec"
|
||||
POSTDISPLAY="ho hello"
|
||||
|
||||
_zsh_autosuggest_clear "original-widget"
|
||||
|
||||
assertEquals \
|
||||
"BUFFER was modified" \
|
||||
"ec" \
|
||||
"$BUFFER"
|
||||
|
||||
assertNull \
|
||||
"POSTDISPLAY was not cleared" \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetFunctionModify() {
|
||||
BUFFER=""
|
||||
POSTDISPLAY=""
|
||||
|
||||
stub_and_eval \
|
||||
_zsh_autosuggest_invoke_original_widget \
|
||||
'BUFFER+="e"'
|
||||
|
||||
stub_and_echo \
|
||||
_zsh_autosuggest_suggestion \
|
||||
"echo hello"
|
||||
|
||||
_zsh_autosuggest_modify "original-widget"
|
||||
|
||||
assertTrue \
|
||||
"original widget not invoked" \
|
||||
"stub_called _zsh_autosuggest_invoke_original_widget"
|
||||
|
||||
assertEquals \
|
||||
"BUFFER was not modified" \
|
||||
"e" \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
"POSTDISPLAY does not contain suggestion" \
|
||||
"cho hello" \
|
||||
"$POSTDISPLAY"
|
||||
|
||||
restore _zsh_autosuggest_invoke_original_widget
|
||||
restore _zsh_autosuggest_suggestion
|
||||
}
|
||||
|
||||
testWidgetFunctionAcceptCursorAtEnd() {
|
||||
BUFFER="echo"
|
||||
POSTDISPLAY=" hello"
|
||||
CURSOR=4
|
||||
|
||||
stub _zsh_autosuggest_invoke_original_widget
|
||||
|
||||
_zsh_autosuggest_accept "original-widget"
|
||||
|
||||
assertTrue \
|
||||
"original widget not invoked" \
|
||||
"stub_called _zsh_autosuggest_invoke_original_widget"
|
||||
|
||||
assertEquals \
|
||||
"BUFFER was not modified" \
|
||||
"echo hello" \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
"POSTDISPLAY was not cleared" \
|
||||
"" \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetFunctionAcceptCursorNotAtEnd() {
|
||||
BUFFER="echo"
|
||||
POSTDISPLAY=" hello"
|
||||
CURSOR=2
|
||||
|
||||
stub _zsh_autosuggest_invoke_original_widget
|
||||
|
||||
_zsh_autosuggest_accept "original-widget"
|
||||
|
||||
assertTrue \
|
||||
"original widget not invoked" \
|
||||
"stub_called _zsh_autosuggest_invoke_original_widget"
|
||||
|
||||
assertEquals \
|
||||
"BUFFER was modified" \
|
||||
"echo" \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
"POSTDISPLAY was modified" \
|
||||
" hello" \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetFunctionExecute() {
|
||||
BUFFER="ec"
|
||||
POSTDISPLAY="ho hello"
|
||||
|
||||
stub _zsh_autosuggest_invoke_original_widget
|
||||
|
||||
_zsh_autosuggest_execute
|
||||
|
||||
assertTrue \
|
||||
"accept-line not invoked" \
|
||||
"stub_called_with _zsh_autosuggest_invoke_original_widget 'accept-line'"
|
||||
|
||||
assertEquals \
|
||||
"BUFFER was not modified" \
|
||||
"echo hello" \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
"POSTDISPLAY was not cleared" \
|
||||
"" \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetFunctionPartialAcceptCursorMovesOutOfBuffer() {
|
||||
BUFFER="ec"
|
||||
POSTDISPLAY="ho hello"
|
||||
CURSOR=1
|
||||
|
||||
stub_and_eval \
|
||||
_zsh_autosuggest_invoke_original_widget \
|
||||
'CURSOR=5; LBUFFER="echo "; RBUFFER="hello"'
|
||||
|
||||
_zsh_autosuggest_partial_accept "original-widget"
|
||||
|
||||
assertTrue \
|
||||
"original widget not invoked" \
|
||||
"stub_called _zsh_autosuggest_invoke_original_widget"
|
||||
|
||||
assertEquals \
|
||||
"BUFFER was not modified correctly" \
|
||||
"echo " \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
"POSTDISPLAY was not modified correctly" \
|
||||
"hello" \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetFunctionPartialAcceptCursorStaysInBuffer() {
|
||||
BUFFER="echo hello"
|
||||
POSTDISPLAY=" world"
|
||||
CURSOR=1
|
||||
|
||||
stub_and_eval \
|
||||
_zsh_autosuggest_invoke_original_widget \
|
||||
'CURSOR=5; LBUFFER="echo "; RBUFFER="hello"'
|
||||
|
||||
_zsh_autosuggest_partial_accept "original-widget"
|
||||
|
||||
assertTrue \
|
||||
"original widget not invoked" \
|
||||
"stub_called _zsh_autosuggest_invoke_original_widget"
|
||||
|
||||
assertEquals \
|
||||
"BUFFER was modified" \
|
||||
"echo hello" \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
"POSTDISPLAY was modified" \
|
||||
" world" \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetAccept() {
|
||||
stub _zsh_autosuggest_highlight_reset
|
||||
stub _zsh_autosuggest_accept
|
||||
stub _zsh_autosuggest_highlight_apply
|
||||
|
||||
# Call the function pointed to by the widget since we can't call
|
||||
# the widget itself when zle is not active
|
||||
${widgets[autosuggest-accept]#*:} "original-widget"
|
||||
|
||||
assertTrue \
|
||||
"autosuggest-accept widget does not exist" \
|
||||
"zle -l autosuggest-accept"
|
||||
|
||||
assertTrue \
|
||||
"highlight_reset was not called" \
|
||||
"stub_called _zsh_autosuggest_highlight_reset"
|
||||
|
||||
assertTrue \
|
||||
"widget function was not called" \
|
||||
"stub_called _zsh_autosuggest_accept"
|
||||
|
||||
assertTrue \
|
||||
"highlight_apply was not called" \
|
||||
"stub_called _zsh_autosuggest_highlight_apply"
|
||||
}
|
||||
|
||||
testWidgetClear() {
|
||||
stub _zsh_autosuggest_highlight_reset
|
||||
stub _zsh_autosuggest_clear
|
||||
stub _zsh_autosuggest_highlight_apply
|
||||
|
||||
# Call the function pointed to by the widget since we can't call
|
||||
# the widget itself when zle is not active
|
||||
${widgets[autosuggest-clear]#*:} "original-widget"
|
||||
|
||||
assertTrue \
|
||||
"autosuggest-clear widget does not exist" \
|
||||
"zle -l autosuggest-clear"
|
||||
|
||||
assertTrue \
|
||||
"highlight_reset was not called" \
|
||||
"stub_called _zsh_autosuggest_highlight_reset"
|
||||
|
||||
assertTrue \
|
||||
"widget function was not called" \
|
||||
"stub_called _zsh_autosuggest_clear"
|
||||
|
||||
assertTrue \
|
||||
"highlight_apply was not called" \
|
||||
"stub_called _zsh_autosuggest_highlight_apply"
|
||||
}
|
||||
|
||||
testWidgetExecute() {
|
||||
stub _zsh_autosuggest_highlight_reset
|
||||
stub _zsh_autosuggest_execute
|
||||
stub _zsh_autosuggest_highlight_apply
|
||||
|
||||
# Call the function pointed to by the widget since we can't call
|
||||
# the widget itself when zle is not active
|
||||
${widgets[autosuggest-execute]#*:} "original-widget"
|
||||
|
||||
assertTrue \
|
||||
"autosuggest-execute widget does not exist" \
|
||||
"zle -l autosuggest-execute"
|
||||
|
||||
assertTrue \
|
||||
"highlight_reset was not called" \
|
||||
"stub_called _zsh_autosuggest_highlight_reset"
|
||||
|
||||
assertTrue \
|
||||
"widget function was not called" \
|
||||
"stub_called _zsh_autosuggest_execute"
|
||||
|
||||
assertTrue \
|
||||
"highlight_apply was not called" \
|
||||
"stub_called _zsh_autosuggest_highlight_apply"
|
||||
}
|
||||
|
||||
testEscapeCommandPrefix() {
|
||||
assertEquals \
|
||||
"Did not escape single backslash" \
|
||||
"\\\\" \
|
||||
"$(_zsh_autosuggest_escape_command "\\")"
|
||||
|
||||
assertEquals \
|
||||
"Did not escape two backslashes" \
|
||||
"\\\\\\\\" \
|
||||
"$(_zsh_autosuggest_escape_command "\\\\")"
|
||||
|
||||
assertEquals \
|
||||
"Did not escape parentheses" \
|
||||
"\\(\\)" \
|
||||
"$(_zsh_autosuggest_escape_command "()")"
|
||||
|
||||
assertEquals \
|
||||
"Did not escape square brackets" \
|
||||
"\\[\\]" \
|
||||
"$(_zsh_autosuggest_escape_command "[]")"
|
||||
|
||||
assertEquals \
|
||||
"Did not escape pipe" \
|
||||
"\\|" \
|
||||
"$(_zsh_autosuggest_escape_command "|")"
|
||||
|
||||
assertEquals \
|
||||
"Did not escape star" \
|
||||
"\\*" \
|
||||
"$(_zsh_autosuggest_escape_command "*")"
|
||||
|
||||
assertEquals \
|
||||
"Did not escape question mark" \
|
||||
"\\?" \
|
||||
"$(_zsh_autosuggest_escape_command "?")"
|
||||
}
|
||||
|
||||
# For zsh compatibility
|
||||
setopt shwordsplit
|
||||
SHUNIT_PARENT=$0
|
||||
|
||||
source $TEST_DIR/shunit2-2.1.6/src/shunit2
|
||||
29
script/test_runner.zsh
Executable file
29
script/test_runner.zsh
Executable file
@@ -0,0 +1,29 @@
|
||||
#!/usr/bin/env zsh
|
||||
|
||||
DIR="${0:a:h}"
|
||||
ROOT_DIR="$DIR/.."
|
||||
TEST_DIR="$ROOT_DIR/test"
|
||||
|
||||
header() {
|
||||
local message="$1"
|
||||
|
||||
cat <<-EOF
|
||||
|
||||
#====================================================================#
|
||||
# $message
|
||||
#====================================================================#
|
||||
EOF
|
||||
}
|
||||
|
||||
local -a tests
|
||||
|
||||
# Test suites to run
|
||||
tests=($TEST_DIR/**/*_test.zsh)
|
||||
|
||||
local retval=0
|
||||
for suite in $tests; do
|
||||
header "${suite#"$TEST_DIR"}"
|
||||
zsh -f "$suite" || retval=$?
|
||||
done
|
||||
|
||||
exit retval
|
||||
81
src/bind.zsh
Normal file
81
src/bind.zsh
Normal file
@@ -0,0 +1,81 @@
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Widget Helpers #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Bind a single widget to an autosuggest widget, saving a reference to the original widget
|
||||
_zsh_autosuggest_bind_widget() {
|
||||
local widget=$1
|
||||
local autosuggest_action=$2
|
||||
local prefix=$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX
|
||||
|
||||
# Save a reference to the original widget
|
||||
case $widgets[$widget] in
|
||||
# Already bound
|
||||
user:_zsh_autosuggest_(bound|orig)_*);;
|
||||
|
||||
# User-defined widget
|
||||
user:*)
|
||||
zle -N $prefix$widget ${widgets[$widget]#*:}
|
||||
;;
|
||||
|
||||
# Built-in widget
|
||||
builtin)
|
||||
eval "_zsh_autosuggest_orig_$widget() { zle .$widget }"
|
||||
zle -N $prefix$widget _zsh_autosuggest_orig_$widget
|
||||
;;
|
||||
|
||||
# Completion widget
|
||||
completion:*)
|
||||
eval "zle -C $prefix$widget ${${widgets[$widget]#*:}/:/ }"
|
||||
;;
|
||||
esac
|
||||
|
||||
# Pass the original widget's name explicitly into the autosuggest
|
||||
# function. Use this passed in widget name to call the original
|
||||
# widget instead of relying on the $WIDGET variable being set
|
||||
# correctly. $WIDGET cannot be trusted because other plugins call
|
||||
# zle without the `-w` flag (e.g. `zle self-insert` instead of
|
||||
# `zle self-insert -w`).
|
||||
eval "_zsh_autosuggest_bound_$widget() {
|
||||
_zsh_autosuggest_widget_$autosuggest_action $prefix$widget \$@
|
||||
}"
|
||||
|
||||
# Create the bound widget
|
||||
zle -N $widget _zsh_autosuggest_bound_$widget
|
||||
}
|
||||
|
||||
# Map all configured widgets to the right autosuggest widgets
|
||||
_zsh_autosuggest_bind_widgets() {
|
||||
local widget;
|
||||
|
||||
# Find every widget we might want to bind and bind it appropriately
|
||||
for widget in ${${(f)"$(builtin zle -la)"}:#(.*|_*|orig-*|autosuggest-*|$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX*|zle-line-*|run-help|which-command|beep|set-local-history|yank)}; do
|
||||
if [ ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]; then
|
||||
_zsh_autosuggest_bind_widget $widget clear
|
||||
elif [ ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]; then
|
||||
_zsh_autosuggest_bind_widget $widget accept
|
||||
elif [ ${ZSH_AUTOSUGGEST_EXECUTE_WIDGETS[(r)$widget]} ]; then
|
||||
_zsh_autosuggest_bind_widget $widget execute
|
||||
elif [ ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]; then
|
||||
_zsh_autosuggest_bind_widget $widget partial_accept
|
||||
else
|
||||
# Assume any unspecified widget might modify the buffer
|
||||
_zsh_autosuggest_bind_widget $widget modify
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
# Given the name of an original widget and args, invoke it, if it exists
|
||||
_zsh_autosuggest_invoke_original_widget() {
|
||||
# Do nothing unless called with at least one arg
|
||||
[ $# -gt 0 ] || return
|
||||
|
||||
local original_widget_name="$1"
|
||||
|
||||
shift
|
||||
|
||||
if [ $widgets[$original_widget_name] ]; then
|
||||
zle $original_widget_name -- $@
|
||||
fi
|
||||
}
|
||||
48
src/config.zsh
Normal file
48
src/config.zsh
Normal file
@@ -0,0 +1,48 @@
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Global Configuration Variables #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Color to use when highlighting suggestion
|
||||
# Uses format of `region_highlight`
|
||||
# More info: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets
|
||||
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=8'
|
||||
|
||||
# Prefix to use when saving original versions of bound widgets
|
||||
ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
||||
|
||||
ZSH_AUTOSUGGEST_STRATEGY=default
|
||||
|
||||
# Widgets that clear the suggestion
|
||||
ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
|
||||
history-search-forward
|
||||
history-search-backward
|
||||
history-beginning-search-forward
|
||||
history-beginning-search-backward
|
||||
history-substring-search-up
|
||||
history-substring-search-down
|
||||
up-line-or-history
|
||||
down-line-or-history
|
||||
accept-line
|
||||
)
|
||||
|
||||
# Widgets that accept the entire suggestion
|
||||
ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=(
|
||||
forward-char
|
||||
end-of-line
|
||||
vi-forward-char
|
||||
vi-end-of-line
|
||||
)
|
||||
|
||||
# Widgets that accept the entire suggestion and execute it
|
||||
ZSH_AUTOSUGGEST_EXECUTE_WIDGETS=(
|
||||
)
|
||||
|
||||
# Widgets that accept the suggestion as far as the cursor moves
|
||||
ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
|
||||
forward-word
|
||||
vi-forward-word
|
||||
vi-forward-word-end
|
||||
vi-forward-blank-word
|
||||
vi-forward-blank-word-end
|
||||
)
|
||||
36
src/deprecated.zsh
Normal file
36
src/deprecated.zsh
Normal file
@@ -0,0 +1,36 @@
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Handle Deprecated Variables/Widgets #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
_zsh_autosuggest_deprecated_warning() {
|
||||
>&2 echo "zsh-autosuggestions: $@"
|
||||
}
|
||||
|
||||
_zsh_autosuggest_check_deprecated_config() {
|
||||
if [ -n "$AUTOSUGGESTION_HIGHLIGHT_COLOR" ]; then
|
||||
_zsh_autosuggest_deprecated_warning "AUTOSUGGESTION_HIGHLIGHT_COLOR is deprecated. Use ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE instead."
|
||||
[ -z "$ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" ] && ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE=$AUTOSUGGESTION_HIGHLIGHT_STYLE
|
||||
unset AUTOSUGGESTION_HIGHLIGHT_STYLE
|
||||
fi
|
||||
|
||||
if [ -n "$AUTOSUGGESTION_HIGHLIGHT_CURSOR" ]; then
|
||||
_zsh_autosuggest_deprecated_warning "AUTOSUGGESTION_HIGHLIGHT_CURSOR is deprecated."
|
||||
unset AUTOSUGGESTION_HIGHLIGHT_CURSOR
|
||||
fi
|
||||
|
||||
if [ -n "$AUTOSUGGESTION_ACCEPT_RIGHT_ARROW" ]; then
|
||||
_zsh_autosuggest_deprecated_warning "AUTOSUGGESTION_ACCEPT_RIGHT_ARROW is deprecated. The right arrow now accepts the suggestion by default."
|
||||
unset AUTOSUGGESTION_ACCEPT_RIGHT_ARROW
|
||||
fi
|
||||
}
|
||||
|
||||
_zsh_autosuggest_deprecated_start_widget() {
|
||||
_zsh_autosuggest_deprecated_warning "The autosuggest-start widget is deprecated. For more info, see the README at https://github.com/zsh-users/zsh-autosuggestions."
|
||||
zle -D autosuggest-start
|
||||
eval "zle-line-init() {
|
||||
$(echo $functions[${widgets[zle-line-init]#*:}] | sed -e 's/zle autosuggest-start//g')
|
||||
}"
|
||||
}
|
||||
|
||||
zle -N autosuggest-start _zsh_autosuggest_deprecated_start_widget
|
||||
22
src/highlight.zsh
Normal file
22
src/highlight.zsh
Normal file
@@ -0,0 +1,22 @@
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Highlighting #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# If there was a highlight, remove it
|
||||
_zsh_autosuggest_highlight_reset() {
|
||||
if [ -n "$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT" ]; then
|
||||
region_highlight=("${(@)region_highlight:#$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT}")
|
||||
unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
|
||||
fi
|
||||
}
|
||||
|
||||
# If there's a suggestion, highlight it
|
||||
_zsh_autosuggest_highlight_apply() {
|
||||
if [ $#POSTDISPLAY -gt 0 ]; then
|
||||
_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT="$#BUFFER $(($#BUFFER + $#POSTDISPLAY)) $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE"
|
||||
region_highlight+=("$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT")
|
||||
else
|
||||
unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
|
||||
fi
|
||||
}
|
||||
13
src/start.zsh
Normal file
13
src/start.zsh
Normal file
@@ -0,0 +1,13 @@
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Start #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Start the autosuggestion widgets
|
||||
_zsh_autosuggest_start() {
|
||||
_zsh_autosuggest_check_deprecated_config
|
||||
_zsh_autosuggest_bind_widgets
|
||||
}
|
||||
|
||||
autoload -Uz add-zsh-hook
|
||||
add-zsh-hook precmd _zsh_autosuggest_start
|
||||
18
src/strategies/default.zsh
Normal file
18
src/strategies/default.zsh
Normal file
@@ -0,0 +1,18 @@
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Default Suggestion Strategy #
|
||||
#--------------------------------------------------------------------#
|
||||
# Suggests the most recent history item that matches the given
|
||||
# prefix.
|
||||
#
|
||||
|
||||
_zsh_autosuggest_strategy_default() {
|
||||
local prefix="$(_zsh_autosuggest_escape_command "$1")"
|
||||
|
||||
# Get the keys of the history items that match
|
||||
local -a histkeys
|
||||
histkeys=(${(k)history[(r)$prefix*]})
|
||||
|
||||
# Echo the value of the first key
|
||||
echo -E "${history[$histkeys[1]]}"
|
||||
}
|
||||
51
src/strategies/match_prev_cmd.zsh
Normal file
51
src/strategies/match_prev_cmd.zsh
Normal file
@@ -0,0 +1,51 @@
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Match Previous Command Suggestion Strategy #
|
||||
#--------------------------------------------------------------------#
|
||||
# Suggests the most recent history item that matches the given
|
||||
# prefix and whose preceding history item also matches the most
|
||||
# recently executed command.
|
||||
#
|
||||
# For example, suppose your history has the following entries:
|
||||
# - pwd
|
||||
# - ls foo
|
||||
# - ls bar
|
||||
# - pwd
|
||||
#
|
||||
# Given the history list above, when you type 'ls', the suggestion
|
||||
# will be 'ls foo' rather than 'ls bar' because your most recently
|
||||
# executed command (pwd) was previously followed by 'ls foo'.
|
||||
#
|
||||
|
||||
_zsh_autosuggest_strategy_match_prev_cmd() {
|
||||
local prefix="$(_zsh_autosuggest_escape_command "$1")"
|
||||
|
||||
# Get all history event numbers that correspond to history
|
||||
# entries that match pattern $prefix*
|
||||
local history_match_keys
|
||||
history_match_keys=(${(k)history[(R)$prefix*]})
|
||||
|
||||
# By default we use the first history number (most recent history entry)
|
||||
local histkey="${history_match_keys[1]}"
|
||||
|
||||
# Get the previously executed command
|
||||
local prev_cmd="$(_zsh_autosuggest_prev_command)"
|
||||
prev_cmd="$(_zsh_autosuggest_escape_command "$prev_cmd")"
|
||||
|
||||
# Iterate up to the first 200 history event numbers that match $prefix
|
||||
for key in "${(@)history_match_keys[1,200]}"; do
|
||||
# Stop if we ran out of history
|
||||
[[ $key -gt 1 ]] || break
|
||||
|
||||
# See if the history entry preceding the suggestion matches the
|
||||
# previous command, and use it if it does
|
||||
if [[ "${history[$((key - 1))]}" == "$prev_cmd" ]]; then
|
||||
histkey="$key"
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
# Echo the matched history entry
|
||||
echo -E "$history[$histkey]"
|
||||
}
|
||||
|
||||
26
src/suggestion.zsh
Normal file
26
src/suggestion.zsh
Normal file
@@ -0,0 +1,26 @@
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Suggestion #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Delegate to the selected strategy to determine a suggestion
|
||||
_zsh_autosuggest_suggestion() {
|
||||
local prefix="$1"
|
||||
local strategy_function="_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY"
|
||||
|
||||
if [ -n "$functions[$strategy_function]" ]; then
|
||||
echo -E "$($strategy_function "$prefix")"
|
||||
fi
|
||||
}
|
||||
|
||||
_zsh_autosuggest_escape_command() {
|
||||
setopt localoptions EXTENDED_GLOB
|
||||
|
||||
# Escape special chars in the string (requires EXTENDED_GLOB)
|
||||
echo -E "${1//(#m)[\\()\[\]|*?]/\\$MATCH}"
|
||||
}
|
||||
|
||||
# Get the previously executed command
|
||||
_zsh_autosuggest_prev_command() {
|
||||
echo -E "${history[$((HISTCMD-1))]}"
|
||||
}
|
||||
97
src/widgets.zsh
Normal file
97
src/widgets.zsh
Normal file
@@ -0,0 +1,97 @@
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Autosuggest Widget Implementations #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Clear the suggestion
|
||||
_zsh_autosuggest_clear() {
|
||||
# Remove the suggestion
|
||||
unset POSTDISPLAY
|
||||
|
||||
_zsh_autosuggest_invoke_original_widget $@
|
||||
}
|
||||
|
||||
# Modify the buffer and get a new suggestion
|
||||
_zsh_autosuggest_modify() {
|
||||
# Original widget modifies the buffer
|
||||
_zsh_autosuggest_invoke_original_widget $@
|
||||
|
||||
# Get a new suggestion if the buffer is not empty after modification
|
||||
local suggestion
|
||||
if [ $#BUFFER -gt 0 ]; then
|
||||
suggestion="$(_zsh_autosuggest_suggestion "$BUFFER")"
|
||||
fi
|
||||
|
||||
# Add the suggestion to the POSTDISPLAY
|
||||
if [ -n "$suggestion" ]; then
|
||||
POSTDISPLAY="${suggestion#$BUFFER}"
|
||||
else
|
||||
unset POSTDISPLAY
|
||||
fi
|
||||
}
|
||||
|
||||
# Accept the entire suggestion
|
||||
_zsh_autosuggest_accept() {
|
||||
# Only accept if the cursor is at the end of the buffer
|
||||
if [ $CURSOR -eq $#BUFFER ]; then
|
||||
# Add the suggestion to the buffer
|
||||
BUFFER="$BUFFER$POSTDISPLAY"
|
||||
|
||||
# Remove the suggestion
|
||||
unset POSTDISPLAY
|
||||
|
||||
# Move the cursor to the end of the buffer
|
||||
CURSOR=${#BUFFER}
|
||||
fi
|
||||
|
||||
_zsh_autosuggest_invoke_original_widget $@
|
||||
}
|
||||
|
||||
# Accept the entire suggestion and execute it
|
||||
_zsh_autosuggest_execute() {
|
||||
# Add the suggestion to the buffer
|
||||
BUFFER="$BUFFER$POSTDISPLAY"
|
||||
|
||||
# Remove the suggestion
|
||||
unset POSTDISPLAY
|
||||
|
||||
# Call the original `accept-line` to handle syntax highlighting or
|
||||
# other potential custom behavior
|
||||
_zsh_autosuggest_invoke_original_widget "accept-line"
|
||||
}
|
||||
|
||||
# Partially accept the suggestion
|
||||
_zsh_autosuggest_partial_accept() {
|
||||
# Save the contents of the buffer so we can restore later if needed
|
||||
local original_buffer="$BUFFER"
|
||||
|
||||
# Temporarily accept the suggestion.
|
||||
BUFFER="$BUFFER$POSTDISPLAY"
|
||||
|
||||
# Original widget moves the cursor
|
||||
_zsh_autosuggest_invoke_original_widget $@
|
||||
|
||||
# If we've moved past the end of the original buffer
|
||||
if [ $CURSOR -gt $#original_buffer ]; then
|
||||
# Set POSTDISPLAY to text right of the cursor
|
||||
POSTDISPLAY="$RBUFFER"
|
||||
|
||||
# Clip the buffer at the cursor
|
||||
BUFFER="$LBUFFER"
|
||||
else
|
||||
# Restore the original buffer
|
||||
BUFFER="$original_buffer"
|
||||
fi
|
||||
}
|
||||
|
||||
for action in clear modify accept partial_accept execute; do
|
||||
eval "_zsh_autosuggest_widget_$action() {
|
||||
_zsh_autosuggest_highlight_reset
|
||||
_zsh_autosuggest_$action \$@
|
||||
_zsh_autosuggest_highlight_apply
|
||||
}"
|
||||
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
|
||||
73
test/highlight_test.zsh
Normal file
73
test/highlight_test.zsh
Normal file
@@ -0,0 +1,73 @@
|
||||
#!/usr/bin/env zsh
|
||||
|
||||
source "${0:a:h}/test_helper.zsh"
|
||||
|
||||
oneTimeSetUp() {
|
||||
source_autosuggestions
|
||||
}
|
||||
|
||||
testHighlightDefaultStyle() {
|
||||
assertEquals \
|
||||
'fg=8' \
|
||||
"$ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE"
|
||||
}
|
||||
|
||||
testHighlightApplyWithSuggestion() {
|
||||
local orig_style=ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE
|
||||
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=4'
|
||||
|
||||
BUFFER='ec'
|
||||
POSTDISPLAY='ho hello'
|
||||
region_highlight=('0 2 fg=1')
|
||||
|
||||
_zsh_autosuggest_highlight_apply
|
||||
|
||||
assertEquals \
|
||||
'highlight did not use correct style' \
|
||||
"0 2 fg=1 2 10 $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" \
|
||||
"$region_highlight"
|
||||
|
||||
assertEquals \
|
||||
'higlight was not saved to be removed later' \
|
||||
"2 10 $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" \
|
||||
"$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT"
|
||||
|
||||
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE=orig_style
|
||||
}
|
||||
|
||||
testHighlightApplyWithoutSuggestion() {
|
||||
BUFFER='echo hello'
|
||||
POSTDISPLAY=''
|
||||
region_highlight=('0 4 fg=1')
|
||||
|
||||
_zsh_autosuggest_highlight_apply
|
||||
|
||||
assertEquals \
|
||||
'region_highlight was modified' \
|
||||
'0 4 fg=1' \
|
||||
"$region_highlight"
|
||||
|
||||
assertNull \
|
||||
'last highlight region was not cleared' \
|
||||
"$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT"
|
||||
}
|
||||
|
||||
testHighlightReset() {
|
||||
BUFFER='ec'
|
||||
POSTDISPLAY='ho hello'
|
||||
region_highlight=('0 1 fg=1' '2 10 fg=8' '1 2 fg=1')
|
||||
_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT='2 10 fg=8'
|
||||
|
||||
_zsh_autosuggest_highlight_reset
|
||||
|
||||
assertEquals \
|
||||
'last highlight region was not removed' \
|
||||
'0 1 fg=1 1 2 fg=1' \
|
||||
"$region_highlight"
|
||||
|
||||
assertNull \
|
||||
'last highlight variable was not cleared' \
|
||||
"$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT"
|
||||
}
|
||||
|
||||
run_tests "$0"
|
||||
114
test/strategies/default_test.zsh
Executable file
114
test/strategies/default_test.zsh
Executable file
@@ -0,0 +1,114 @@
|
||||
#!/usr/bin/env zsh
|
||||
|
||||
source "${0:a:h}/../test_helper.zsh"
|
||||
|
||||
oneTimeSetUp() {
|
||||
source_autosuggestions
|
||||
}
|
||||
|
||||
testNoMatch() {
|
||||
set_history <<-'EOF'
|
||||
ls foo
|
||||
ls bar
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'foo' \
|
||||
''
|
||||
|
||||
assertSuggestion \
|
||||
'ls q' \
|
||||
''
|
||||
}
|
||||
|
||||
testBasicMatches() {
|
||||
set_history <<-'EOF'
|
||||
ls foo
|
||||
ls bar
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'ls f' \
|
||||
'ls foo'
|
||||
|
||||
assertSuggestion \
|
||||
'ls b' \
|
||||
'ls bar'
|
||||
}
|
||||
|
||||
testMostRecentMatch() {
|
||||
set_history <<-'EOF'
|
||||
ls foo
|
||||
cd bar
|
||||
ls baz
|
||||
cd quux
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'ls' \
|
||||
'ls baz'
|
||||
|
||||
assertSuggestion \
|
||||
'cd' \
|
||||
'cd quux'
|
||||
}
|
||||
|
||||
testBackslash() {
|
||||
set_history <<-'EOF'
|
||||
echo "hello\nworld"
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'echo "hello\' \
|
||||
'echo "hello\nworld"'
|
||||
}
|
||||
|
||||
testDoubleBackslash() {
|
||||
set_history <<-'EOF'
|
||||
echo "\\"
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'echo "\\' \
|
||||
'echo "\\"'
|
||||
}
|
||||
|
||||
testTilde() {
|
||||
set_history <<-'EOF'
|
||||
cd ~/something
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'cd' \
|
||||
'cd ~/something'
|
||||
|
||||
assertSuggestion \
|
||||
'cd ~' \
|
||||
'cd ~/something'
|
||||
|
||||
assertSuggestion \
|
||||
'cd ~/s' \
|
||||
'cd ~/something'
|
||||
}
|
||||
|
||||
testParentheses() {
|
||||
set_history <<-'EOF'
|
||||
echo "$(ls foo)"
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'echo "$(' \
|
||||
'echo "$(ls foo)"'
|
||||
}
|
||||
|
||||
testSquareBrackets() {
|
||||
set_history <<-'EOF'
|
||||
echo "$history[123]"
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'echo "$history[' \
|
||||
'echo "$history[123]"'
|
||||
}
|
||||
|
||||
run_tests "$0"
|
||||
132
test/strategies/match_prev_cmd_test.zsh
Executable file
132
test/strategies/match_prev_cmd_test.zsh
Executable file
@@ -0,0 +1,132 @@
|
||||
#!/usr/bin/env zsh
|
||||
|
||||
source "${0:a:h}/../test_helper.zsh"
|
||||
|
||||
oneTimeSetUp() {
|
||||
source_autosuggestions
|
||||
|
||||
ZSH_AUTOSUGGEST_STRATEGY=match_prev_cmd
|
||||
}
|
||||
|
||||
testNoMatch() {
|
||||
set_history <<-'EOF'
|
||||
ls foo
|
||||
ls bar
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'foo' \
|
||||
''
|
||||
|
||||
assertSuggestion \
|
||||
'ls q' \
|
||||
''
|
||||
}
|
||||
|
||||
testBasicMatches() {
|
||||
set_history <<-'EOF'
|
||||
ls foo
|
||||
ls bar
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'ls f' \
|
||||
'ls foo'
|
||||
|
||||
assertSuggestion \
|
||||
'ls b' \
|
||||
'ls bar'
|
||||
}
|
||||
|
||||
testMostRecentMatch() {
|
||||
set_history <<-'EOF'
|
||||
ls foo
|
||||
cd bar
|
||||
ls baz
|
||||
cd quux
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'ls' \
|
||||
'ls baz'
|
||||
|
||||
assertSuggestion \
|
||||
'cd' \
|
||||
'cd quux'
|
||||
}
|
||||
|
||||
testBackslash() {
|
||||
set_history <<-'EOF'
|
||||
echo "hello\nworld"
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'echo "hello\' \
|
||||
'echo "hello\nworld"'
|
||||
}
|
||||
|
||||
testDoubleBackslash() {
|
||||
set_history <<-'EOF'
|
||||
echo "\\"
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'echo "\\' \
|
||||
'echo "\\"'
|
||||
}
|
||||
|
||||
testTilde() {
|
||||
set_history <<-'EOF'
|
||||
cd ~/something
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'cd' \
|
||||
'cd ~/something'
|
||||
|
||||
assertSuggestion \
|
||||
'cd ~' \
|
||||
'cd ~/something'
|
||||
|
||||
assertSuggestion \
|
||||
'cd ~/s' \
|
||||
'cd ~/something'
|
||||
}
|
||||
|
||||
testParentheses() {
|
||||
set_history <<-'EOF'
|
||||
echo "$(ls foo)"
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'echo "$(' \
|
||||
'echo "$(ls foo)"'
|
||||
}
|
||||
|
||||
testSquareBrackets() {
|
||||
set_history <<-'EOF'
|
||||
echo "$history[123]"
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'echo "$history[' \
|
||||
'echo "$history[123]"'
|
||||
}
|
||||
|
||||
testMatchMostRecentAfterPreviousCmd() {
|
||||
set_history <<-'EOF'
|
||||
echo what
|
||||
ls foo
|
||||
ls bar
|
||||
echo what
|
||||
ls baz
|
||||
ls quux
|
||||
echo what
|
||||
EOF
|
||||
|
||||
assertSuggestion \
|
||||
'ls' \
|
||||
'ls baz'
|
||||
}
|
||||
|
||||
run_tests "$0"
|
||||
72
test/suggestion_test.zsh
Normal file
72
test/suggestion_test.zsh
Normal file
@@ -0,0 +1,72 @@
|
||||
#!/usr/bin/env zsh
|
||||
|
||||
source "${0:a:h}/test_helper.zsh"
|
||||
|
||||
oneTimeSetUp() {
|
||||
source_autosuggestions
|
||||
}
|
||||
|
||||
testEscapeCommand() {
|
||||
assertEquals \
|
||||
'Did not escape single backslash' \
|
||||
'\\' \
|
||||
"$(_zsh_autosuggest_escape_command '\')"
|
||||
|
||||
assertEquals \
|
||||
'Did not escape two backslashes' \
|
||||
'\\\\' \
|
||||
"$(_zsh_autosuggest_escape_command '\\')"
|
||||
|
||||
assertEquals \
|
||||
'Did not escape parentheses' \
|
||||
'\(\)' \
|
||||
"$(_zsh_autosuggest_escape_command '()')"
|
||||
|
||||
assertEquals \
|
||||
'Did not escape square brackets' \
|
||||
'\[\]' \
|
||||
"$(_zsh_autosuggest_escape_command '[]')"
|
||||
|
||||
assertEquals \
|
||||
'Did not escape pipe' \
|
||||
'\|' \
|
||||
"$(_zsh_autosuggest_escape_command '|')"
|
||||
|
||||
assertEquals \
|
||||
'Did not escape star' \
|
||||
'\*' \
|
||||
"$(_zsh_autosuggest_escape_command '*')"
|
||||
|
||||
assertEquals \
|
||||
'Did not escape question mark' \
|
||||
'\?' \
|
||||
"$(_zsh_autosuggest_escape_command '?')"
|
||||
}
|
||||
|
||||
testPrevCommand() {
|
||||
set_history <<-'EOF'
|
||||
ls foo
|
||||
ls bar
|
||||
ls baz
|
||||
EOF
|
||||
|
||||
assertEquals \
|
||||
'Did not output the last command' \
|
||||
'ls baz' \
|
||||
"$(_zsh_autosuggest_prev_command)"
|
||||
|
||||
set_history <<-'EOF'
|
||||
ls foo
|
||||
ls bar
|
||||
ls baz
|
||||
ls quux
|
||||
ls foobar
|
||||
EOF
|
||||
|
||||
assertEquals \
|
||||
'Did not output the last command' \
|
||||
'ls foobar' \
|
||||
"$(_zsh_autosuggest_prev_command)"
|
||||
}
|
||||
|
||||
run_tests "$0"
|
||||
60
test/test_helper.zsh
Normal file
60
test/test_helper.zsh
Normal file
@@ -0,0 +1,60 @@
|
||||
DIR="${0:a:h}"
|
||||
ROOT_DIR="$DIR/.."
|
||||
VENDOR_DIR="$ROOT_DIR/vendor"
|
||||
|
||||
# Use stub.sh for stubbing/mocking
|
||||
source "$VENDOR_DIR/stub.sh/stub.sh"
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Helper Functions #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Source the autosuggestions plugin file
|
||||
source_autosuggestions() {
|
||||
source "$ROOT_DIR/zsh-autosuggestions.zsh"
|
||||
}
|
||||
|
||||
# Set history list from stdin
|
||||
set_history() {
|
||||
# Make a tmp file in shunit's tmp dir
|
||||
local tmp=$(mktemp "$SHUNIT_TMPDIR/hist.XXX")
|
||||
|
||||
# Write from stdin to the tmp file
|
||||
> "$tmp"
|
||||
|
||||
# Write an extra line to simulate history active mode
|
||||
# See https://github.com/zsh-users/zsh/blob/ca3bc0d95d7deab4f5381f12b15047de748c0814/Src/hist.c#L69-L82
|
||||
echo >> "$tmp"
|
||||
|
||||
# Clear history and re-read from the tmp file
|
||||
fc -P; fc -p; fc -R "$tmp"
|
||||
|
||||
rm "$tmp"
|
||||
}
|
||||
|
||||
# Should be called at the bottom of every test suite file
|
||||
# Pass in the name of the test script ($0) for shunit
|
||||
run_tests() {
|
||||
local test_script="$1"
|
||||
shift
|
||||
|
||||
# Required for shunit to work with zsh
|
||||
setopt localoptions shwordsplit
|
||||
SHUNIT_PARENT="$test_script"
|
||||
|
||||
source "$VENDOR_DIR/shunit2/2.1.6/src/shunit2"
|
||||
}
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Custom Assertions #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
assertSuggestion() {
|
||||
local prefix="$1"
|
||||
local expected_suggestion="$2"
|
||||
|
||||
assertEquals \
|
||||
"Did not get correct suggestion for prefix:<$prefix>" \
|
||||
"$expected_suggestion" \
|
||||
"$(_zsh_autosuggest_suggestion "$prefix")"
|
||||
}
|
||||
209
test/widgets_test.zsh
Normal file
209
test/widgets_test.zsh
Normal file
@@ -0,0 +1,209 @@
|
||||
#!/usr/bin/env zsh
|
||||
|
||||
source "${0:a:h}/test_helper.zsh"
|
||||
|
||||
oneTimeSetUp() {
|
||||
source_autosuggestions
|
||||
}
|
||||
|
||||
testWidgetFunctionClear() {
|
||||
BUFFER='ec'
|
||||
POSTDISPLAY='ho hello'
|
||||
|
||||
_zsh_autosuggest_clear 'original-widget'
|
||||
|
||||
assertEquals \
|
||||
'BUFFER was modified' \
|
||||
'ec' \
|
||||
"$BUFFER"
|
||||
|
||||
assertNull \
|
||||
'POSTDISPLAY was not cleared' \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetFunctionModify() {
|
||||
BUFFER=''
|
||||
POSTDISPLAY=''
|
||||
|
||||
stub_and_eval \
|
||||
_zsh_autosuggest_invoke_original_widget \
|
||||
'BUFFER+="e"'
|
||||
|
||||
stub_and_echo \
|
||||
_zsh_autosuggest_suggestion \
|
||||
'echo hello'
|
||||
|
||||
_zsh_autosuggest_modify 'original-widget'
|
||||
|
||||
assertTrue \
|
||||
'original widget not invoked' \
|
||||
'stub_called _zsh_autosuggest_invoke_original_widget'
|
||||
|
||||
assertEquals \
|
||||
'BUFFER was not modified' \
|
||||
'e' \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
'POSTDISPLAY does not contain suggestion' \
|
||||
'cho hello' \
|
||||
"$POSTDISPLAY"
|
||||
|
||||
restore _zsh_autosuggest_invoke_original_widget
|
||||
restore _zsh_autosuggest_suggestion
|
||||
}
|
||||
|
||||
testWidgetFunctionAcceptCursorAtEnd() {
|
||||
BUFFER='echo'
|
||||
POSTDISPLAY=' hello'
|
||||
CURSOR=4
|
||||
|
||||
stub _zsh_autosuggest_invoke_original_widget
|
||||
|
||||
_zsh_autosuggest_accept 'original-widget'
|
||||
|
||||
assertTrue \
|
||||
'original widget not invoked' \
|
||||
'stub_called _zsh_autosuggest_invoke_original_widget'
|
||||
|
||||
assertEquals \
|
||||
'BUFFER was not modified' \
|
||||
'echo hello' \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
'POSTDISPLAY was not cleared' \
|
||||
'' \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetFunctionAcceptCursorNotAtEnd() {
|
||||
BUFFER='echo'
|
||||
POSTDISPLAY=' hello'
|
||||
CURSOR=2
|
||||
|
||||
stub _zsh_autosuggest_invoke_original_widget
|
||||
|
||||
_zsh_autosuggest_accept 'original-widget'
|
||||
|
||||
assertTrue \
|
||||
'original widget not invoked' \
|
||||
'stub_called _zsh_autosuggest_invoke_original_widget'
|
||||
|
||||
assertEquals \
|
||||
'BUFFER was modified' \
|
||||
'echo' \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
'POSTDISPLAY was modified' \
|
||||
' hello' \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetFunctionPartialAcceptCursorMovesOutOfBuffer() {
|
||||
BUFFER='ec'
|
||||
POSTDISPLAY='ho hello'
|
||||
CURSOR=1
|
||||
|
||||
stub_and_eval \
|
||||
_zsh_autosuggest_invoke_original_widget \
|
||||
'CURSOR=5; LBUFFER="echo "; RBUFFER="hello"'
|
||||
|
||||
_zsh_autosuggest_partial_accept 'original-widget'
|
||||
|
||||
assertTrue \
|
||||
'original widget not invoked' \
|
||||
'stub_called _zsh_autosuggest_invoke_original_widget'
|
||||
|
||||
assertEquals \
|
||||
'BUFFER was not modified correctly' \
|
||||
'echo ' \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
'POSTDISPLAY was not modified correctly' \
|
||||
'hello' \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetFunctionPartialAcceptCursorStaysInBuffer() {
|
||||
BUFFER='echo hello'
|
||||
POSTDISPLAY=' world'
|
||||
CURSOR=1
|
||||
|
||||
stub_and_eval \
|
||||
_zsh_autosuggest_invoke_original_widget \
|
||||
'CURSOR=5; LBUFFER="echo "; RBUFFER="hello"'
|
||||
|
||||
_zsh_autosuggest_partial_accept 'original-widget'
|
||||
|
||||
assertTrue \
|
||||
'original widget not invoked' \
|
||||
'stub_called _zsh_autosuggest_invoke_original_widget'
|
||||
|
||||
assertEquals \
|
||||
'BUFFER was modified' \
|
||||
'echo hello' \
|
||||
"$BUFFER"
|
||||
|
||||
assertEquals \
|
||||
'POSTDISPLAY was modified' \
|
||||
' world' \
|
||||
"$POSTDISPLAY"
|
||||
}
|
||||
|
||||
testWidgetAccept() {
|
||||
stub _zsh_autosuggest_highlight_reset
|
||||
stub _zsh_autosuggest_accept
|
||||
stub _zsh_autosuggest_highlight_apply
|
||||
|
||||
# Call the function pointed to by the widget since we can't call
|
||||
# the widget itself when zle is not active
|
||||
${widgets[autosuggest-accept]#*:} 'original-widget'
|
||||
|
||||
assertTrue \
|
||||
'autosuggest-accept widget does not exist' \
|
||||
'zle -l autosuggest-accept'
|
||||
|
||||
assertTrue \
|
||||
'highlight_reset was not called' \
|
||||
'stub_called _zsh_autosuggest_highlight_reset'
|
||||
|
||||
assertTrue \
|
||||
'widget function was not called' \
|
||||
'stub_called _zsh_autosuggest_accept'
|
||||
|
||||
assertTrue \
|
||||
'highlight_apply was not called' \
|
||||
'stub_called _zsh_autosuggest_highlight_apply'
|
||||
}
|
||||
|
||||
testWidgetClear() {
|
||||
stub _zsh_autosuggest_highlight_reset
|
||||
stub _zsh_autosuggest_clear
|
||||
stub _zsh_autosuggest_highlight_apply
|
||||
|
||||
# Call the function pointed to by the widget since we can't call
|
||||
# the widget itself when zle is not active
|
||||
${widgets[autosuggest-clear]#*:} 'original-widget'
|
||||
|
||||
assertTrue \
|
||||
'autosuggest-clear widget does not exist' \
|
||||
'zle -l autosuggest-clear'
|
||||
|
||||
assertTrue \
|
||||
'highlight_reset was not called' \
|
||||
'stub_called _zsh_autosuggest_highlight_reset'
|
||||
|
||||
assertTrue \
|
||||
'widget function was not called' \
|
||||
'stub_called _zsh_autosuggest_clear'
|
||||
|
||||
assertTrue \
|
||||
'highlight_apply was not called' \
|
||||
'stub_called _zsh_autosuggest_highlight_apply'
|
||||
}
|
||||
|
||||
run_tests "$0"
|
||||
1
vendor/shunit2
vendored
Submodule
1
vendor/shunit2
vendored
Submodule
Submodule vendor/shunit2 added at 46973db9df
1
vendor/stub.sh
vendored
Submodule
1
vendor/stub.sh
vendored
Submodule
Submodule vendor/stub.sh added at bd6f3c4666
1
zsh-autosuggestions.plugin.zsh
Symbolic link
1
zsh-autosuggestions.plugin.zsh
Symbolic link
@@ -0,0 +1 @@
|
||||
zsh-autosuggestions.zsh
|
||||
418
zsh-autosuggestions.zsh
Normal file
418
zsh-autosuggestions.zsh
Normal file
@@ -0,0 +1,418 @@
|
||||
# Fish-like fast/unobtrusive autosuggestions for zsh.
|
||||
# https://github.com/zsh-users/zsh-autosuggestions
|
||||
# v0.3.0
|
||||
# Copyright (c) 2013 Thiago de Arruda
|
||||
# Copyright (c) 2016 Eric Freese
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person
|
||||
# obtaining a copy of this software and associated documentation
|
||||
# files (the "Software"), to deal in the Software without
|
||||
# restriction, including without limitation the rights to use,
|
||||
# copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
# copies of the Software, and to permit persons to whom the
|
||||
# Software is furnished to do so, subject to the following
|
||||
# conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be
|
||||
# included in all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
# OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Global Configuration Variables #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Color to use when highlighting suggestion
|
||||
# Uses format of `region_highlight`
|
||||
# More info: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets
|
||||
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=8'
|
||||
|
||||
# Prefix to use when saving original versions of bound widgets
|
||||
ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
||||
|
||||
ZSH_AUTOSUGGEST_STRATEGY=default
|
||||
|
||||
# Widgets that clear the suggestion
|
||||
ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
|
||||
history-search-forward
|
||||
history-search-backward
|
||||
history-beginning-search-forward
|
||||
history-beginning-search-backward
|
||||
history-substring-search-up
|
||||
history-substring-search-down
|
||||
up-line-or-history
|
||||
down-line-or-history
|
||||
accept-line
|
||||
)
|
||||
|
||||
# Widgets that accept the entire suggestion
|
||||
ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=(
|
||||
forward-char
|
||||
end-of-line
|
||||
vi-forward-char
|
||||
vi-end-of-line
|
||||
)
|
||||
|
||||
# Widgets that accept the entire suggestion and execute it
|
||||
ZSH_AUTOSUGGEST_EXECUTE_WIDGETS=(
|
||||
)
|
||||
|
||||
# Widgets that accept the suggestion as far as the cursor moves
|
||||
ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
|
||||
forward-word
|
||||
vi-forward-word
|
||||
vi-forward-word-end
|
||||
vi-forward-blank-word
|
||||
vi-forward-blank-word-end
|
||||
)
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Handle Deprecated Variables/Widgets #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
_zsh_autosuggest_deprecated_warning() {
|
||||
>&2 echo "zsh-autosuggestions: $@"
|
||||
}
|
||||
|
||||
_zsh_autosuggest_check_deprecated_config() {
|
||||
if [ -n "$AUTOSUGGESTION_HIGHLIGHT_COLOR" ]; then
|
||||
_zsh_autosuggest_deprecated_warning "AUTOSUGGESTION_HIGHLIGHT_COLOR is deprecated. Use ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE instead."
|
||||
[ -z "$ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE" ] && ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE=$AUTOSUGGESTION_HIGHLIGHT_STYLE
|
||||
unset AUTOSUGGESTION_HIGHLIGHT_STYLE
|
||||
fi
|
||||
|
||||
if [ -n "$AUTOSUGGESTION_HIGHLIGHT_CURSOR" ]; then
|
||||
_zsh_autosuggest_deprecated_warning "AUTOSUGGESTION_HIGHLIGHT_CURSOR is deprecated."
|
||||
unset AUTOSUGGESTION_HIGHLIGHT_CURSOR
|
||||
fi
|
||||
|
||||
if [ -n "$AUTOSUGGESTION_ACCEPT_RIGHT_ARROW" ]; then
|
||||
_zsh_autosuggest_deprecated_warning "AUTOSUGGESTION_ACCEPT_RIGHT_ARROW is deprecated. The right arrow now accepts the suggestion by default."
|
||||
unset AUTOSUGGESTION_ACCEPT_RIGHT_ARROW
|
||||
fi
|
||||
}
|
||||
|
||||
_zsh_autosuggest_deprecated_start_widget() {
|
||||
_zsh_autosuggest_deprecated_warning "The autosuggest-start widget is deprecated. For more info, see the README at https://github.com/zsh-users/zsh-autosuggestions."
|
||||
zle -D autosuggest-start
|
||||
eval "zle-line-init() {
|
||||
$(echo $functions[${widgets[zle-line-init]#*:}] | sed -e 's/zle autosuggest-start//g')
|
||||
}"
|
||||
}
|
||||
|
||||
zle -N autosuggest-start _zsh_autosuggest_deprecated_start_widget
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Widget Helpers #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Bind a single widget to an autosuggest widget, saving a reference to the original widget
|
||||
_zsh_autosuggest_bind_widget() {
|
||||
local widget=$1
|
||||
local autosuggest_action=$2
|
||||
local prefix=$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX
|
||||
|
||||
# Save a reference to the original widget
|
||||
case $widgets[$widget] in
|
||||
# Already bound
|
||||
user:_zsh_autosuggest_(bound|orig)_*);;
|
||||
|
||||
# User-defined widget
|
||||
user:*)
|
||||
zle -N $prefix$widget ${widgets[$widget]#*:}
|
||||
;;
|
||||
|
||||
# Built-in widget
|
||||
builtin)
|
||||
eval "_zsh_autosuggest_orig_$widget() { zle .$widget }"
|
||||
zle -N $prefix$widget _zsh_autosuggest_orig_$widget
|
||||
;;
|
||||
|
||||
# Completion widget
|
||||
completion:*)
|
||||
eval "zle -C $prefix$widget ${${widgets[$widget]#*:}/:/ }"
|
||||
;;
|
||||
esac
|
||||
|
||||
# Pass the original widget's name explicitly into the autosuggest
|
||||
# function. Use this passed in widget name to call the original
|
||||
# widget instead of relying on the $WIDGET variable being set
|
||||
# correctly. $WIDGET cannot be trusted because other plugins call
|
||||
# zle without the `-w` flag (e.g. `zle self-insert` instead of
|
||||
# `zle self-insert -w`).
|
||||
eval "_zsh_autosuggest_bound_$widget() {
|
||||
_zsh_autosuggest_widget_$autosuggest_action $prefix$widget \$@
|
||||
}"
|
||||
|
||||
# Create the bound widget
|
||||
zle -N $widget _zsh_autosuggest_bound_$widget
|
||||
}
|
||||
|
||||
# Map all configured widgets to the right autosuggest widgets
|
||||
_zsh_autosuggest_bind_widgets() {
|
||||
local widget;
|
||||
|
||||
# Find every widget we might want to bind and bind it appropriately
|
||||
for widget in ${${(f)"$(builtin zle -la)"}:#(.*|_*|orig-*|autosuggest-*|$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX*|zle-line-*|run-help|which-command|beep|set-local-history|yank)}; do
|
||||
if [ ${ZSH_AUTOSUGGEST_CLEAR_WIDGETS[(r)$widget]} ]; then
|
||||
_zsh_autosuggest_bind_widget $widget clear
|
||||
elif [ ${ZSH_AUTOSUGGEST_ACCEPT_WIDGETS[(r)$widget]} ]; then
|
||||
_zsh_autosuggest_bind_widget $widget accept
|
||||
elif [ ${ZSH_AUTOSUGGEST_EXECUTE_WIDGETS[(r)$widget]} ]; then
|
||||
_zsh_autosuggest_bind_widget $widget execute
|
||||
elif [ ${ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS[(r)$widget]} ]; then
|
||||
_zsh_autosuggest_bind_widget $widget partial_accept
|
||||
else
|
||||
# Assume any unspecified widget might modify the buffer
|
||||
_zsh_autosuggest_bind_widget $widget modify
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
# Given the name of an original widget and args, invoke it, if it exists
|
||||
_zsh_autosuggest_invoke_original_widget() {
|
||||
# Do nothing unless called with at least one arg
|
||||
[ $# -gt 0 ] || return
|
||||
|
||||
local original_widget_name="$1"
|
||||
|
||||
shift
|
||||
|
||||
if [ $widgets[$original_widget_name] ]; then
|
||||
zle $original_widget_name -- $@
|
||||
fi
|
||||
}
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Highlighting #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# If there was a highlight, remove it
|
||||
_zsh_autosuggest_highlight_reset() {
|
||||
if [ -n "$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT" ]; then
|
||||
region_highlight=("${(@)region_highlight:#$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT}")
|
||||
unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
|
||||
fi
|
||||
}
|
||||
|
||||
# If there's a suggestion, highlight it
|
||||
_zsh_autosuggest_highlight_apply() {
|
||||
if [ $#POSTDISPLAY -gt 0 ]; then
|
||||
_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT="$#BUFFER $(($#BUFFER + $#POSTDISPLAY)) $ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE"
|
||||
region_highlight+=("$_ZSH_AUTOSUGGEST_LAST_HIGHLIGHT")
|
||||
else
|
||||
unset _ZSH_AUTOSUGGEST_LAST_HIGHLIGHT
|
||||
fi
|
||||
}
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Autosuggest Widget Implementations #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Clear the suggestion
|
||||
_zsh_autosuggest_clear() {
|
||||
# Remove the suggestion
|
||||
unset POSTDISPLAY
|
||||
|
||||
_zsh_autosuggest_invoke_original_widget $@
|
||||
}
|
||||
|
||||
# Modify the buffer and get a new suggestion
|
||||
_zsh_autosuggest_modify() {
|
||||
# Original widget modifies the buffer
|
||||
_zsh_autosuggest_invoke_original_widget $@
|
||||
|
||||
# Get a new suggestion if the buffer is not empty after modification
|
||||
local suggestion
|
||||
if [ $#BUFFER -gt 0 ]; then
|
||||
suggestion="$(_zsh_autosuggest_suggestion "$BUFFER")"
|
||||
fi
|
||||
|
||||
# Add the suggestion to the POSTDISPLAY
|
||||
if [ -n "$suggestion" ]; then
|
||||
POSTDISPLAY="${suggestion#$BUFFER}"
|
||||
else
|
||||
unset POSTDISPLAY
|
||||
fi
|
||||
}
|
||||
|
||||
# Accept the entire suggestion
|
||||
_zsh_autosuggest_accept() {
|
||||
# Only accept if the cursor is at the end of the buffer
|
||||
if [ $CURSOR -eq $#BUFFER ]; then
|
||||
# Add the suggestion to the buffer
|
||||
BUFFER="$BUFFER$POSTDISPLAY"
|
||||
|
||||
# Remove the suggestion
|
||||
unset POSTDISPLAY
|
||||
|
||||
# Move the cursor to the end of the buffer
|
||||
CURSOR=${#BUFFER}
|
||||
fi
|
||||
|
||||
_zsh_autosuggest_invoke_original_widget $@
|
||||
}
|
||||
|
||||
# Accept the entire suggestion and execute it
|
||||
_zsh_autosuggest_execute() {
|
||||
# Add the suggestion to the buffer
|
||||
BUFFER="$BUFFER$POSTDISPLAY"
|
||||
|
||||
# Remove the suggestion
|
||||
unset POSTDISPLAY
|
||||
|
||||
# Call the original `accept-line` to handle syntax highlighting or
|
||||
# other potential custom behavior
|
||||
_zsh_autosuggest_invoke_original_widget "accept-line"
|
||||
}
|
||||
|
||||
# Partially accept the suggestion
|
||||
_zsh_autosuggest_partial_accept() {
|
||||
# Save the contents of the buffer so we can restore later if needed
|
||||
local original_buffer="$BUFFER"
|
||||
|
||||
# Temporarily accept the suggestion.
|
||||
BUFFER="$BUFFER$POSTDISPLAY"
|
||||
|
||||
# Original widget moves the cursor
|
||||
_zsh_autosuggest_invoke_original_widget $@
|
||||
|
||||
# If we've moved past the end of the original buffer
|
||||
if [ $CURSOR -gt $#original_buffer ]; then
|
||||
# Set POSTDISPLAY to text right of the cursor
|
||||
POSTDISPLAY="$RBUFFER"
|
||||
|
||||
# Clip the buffer at the cursor
|
||||
BUFFER="$LBUFFER"
|
||||
else
|
||||
# Restore the original buffer
|
||||
BUFFER="$original_buffer"
|
||||
fi
|
||||
}
|
||||
|
||||
for action in clear modify accept partial_accept execute; do
|
||||
eval "_zsh_autosuggest_widget_$action() {
|
||||
_zsh_autosuggest_highlight_reset
|
||||
_zsh_autosuggest_$action \$@
|
||||
_zsh_autosuggest_highlight_apply
|
||||
}"
|
||||
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
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Suggestion #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Delegate to the selected strategy to determine a suggestion
|
||||
_zsh_autosuggest_suggestion() {
|
||||
local prefix="$1"
|
||||
local strategy_function="_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY"
|
||||
|
||||
if [ -n "$functions[$strategy_function]" ]; then
|
||||
echo -E "$($strategy_function "$prefix")"
|
||||
fi
|
||||
}
|
||||
|
||||
_zsh_autosuggest_escape_command() {
|
||||
setopt localoptions EXTENDED_GLOB
|
||||
|
||||
# Escape special chars in the string (requires EXTENDED_GLOB)
|
||||
echo -E "${1//(#m)[\\()\[\]|*?]/\\$MATCH}"
|
||||
}
|
||||
|
||||
# Get the previously executed command
|
||||
_zsh_autosuggest_prev_command() {
|
||||
echo -E "${history[$((HISTCMD-1))]}"
|
||||
}
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Default Suggestion Strategy #
|
||||
#--------------------------------------------------------------------#
|
||||
# Suggests the most recent history item that matches the given
|
||||
# prefix.
|
||||
#
|
||||
|
||||
_zsh_autosuggest_strategy_default() {
|
||||
local prefix="$(_zsh_autosuggest_escape_command "$1")"
|
||||
|
||||
# Get the keys of the history items that match
|
||||
local -a histkeys
|
||||
histkeys=(${(k)history[(r)$prefix*]})
|
||||
|
||||
# Echo the value of the first key
|
||||
echo -E "${history[$histkeys[1]]}"
|
||||
}
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Match Previous Command Suggestion Strategy #
|
||||
#--------------------------------------------------------------------#
|
||||
# Suggests the most recent history item that matches the given
|
||||
# prefix and whose preceding history item also matches the most
|
||||
# recently executed command.
|
||||
#
|
||||
# For example, suppose your history has the following entries:
|
||||
# - pwd
|
||||
# - ls foo
|
||||
# - ls bar
|
||||
# - pwd
|
||||
#
|
||||
# Given the history list above, when you type 'ls', the suggestion
|
||||
# will be 'ls foo' rather than 'ls bar' because your most recently
|
||||
# executed command (pwd) was previously followed by 'ls foo'.
|
||||
#
|
||||
|
||||
_zsh_autosuggest_strategy_match_prev_cmd() {
|
||||
local prefix="$(_zsh_autosuggest_escape_command "$1")"
|
||||
|
||||
# Get all history event numbers that correspond to history
|
||||
# entries that match pattern $prefix*
|
||||
local history_match_keys
|
||||
history_match_keys=(${(k)history[(R)$prefix*]})
|
||||
|
||||
# By default we use the first history number (most recent history entry)
|
||||
local histkey="${history_match_keys[1]}"
|
||||
|
||||
# Get the previously executed command
|
||||
local prev_cmd="$(_zsh_autosuggest_prev_command)"
|
||||
prev_cmd="$(_zsh_autosuggest_escape_command "$prev_cmd")"
|
||||
|
||||
# Iterate up to the first 200 history event numbers that match $prefix
|
||||
for key in "${(@)history_match_keys[1,200]}"; do
|
||||
# Stop if we ran out of history
|
||||
[[ $key -gt 1 ]] || break
|
||||
|
||||
# See if the history entry preceding the suggestion matches the
|
||||
# previous command, and use it if it does
|
||||
if [[ "${history[$((key - 1))]}" == "$prev_cmd" ]]; then
|
||||
histkey="$key"
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
# Echo the matched history entry
|
||||
echo -E "$history[$histkey]"
|
||||
}
|
||||
|
||||
|
||||
#--------------------------------------------------------------------#
|
||||
# Start #
|
||||
#--------------------------------------------------------------------#
|
||||
|
||||
# Start the autosuggestion widgets
|
||||
_zsh_autosuggest_start() {
|
||||
_zsh_autosuggest_check_deprecated_config
|
||||
_zsh_autosuggest_bind_widgets
|
||||
}
|
||||
|
||||
autoload -Uz add-zsh-hook
|
||||
add-zsh-hook precmd _zsh_autosuggest_start
|
||||
Reference in New Issue
Block a user