mirror of
https://github.com/zsh-users/zsh-autosuggestions.git
synced 2025-12-06 15:20:40 +01:00
Compare commits
94 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
733abd4af0 | ||
|
|
152d2c6b31 | ||
|
|
528e338e57 | ||
|
|
937d6fc241 | ||
|
|
b9fee8a324 | ||
|
|
db290c518b | ||
|
|
d8ba53678e | ||
|
|
4cd210b70d | ||
|
|
586b51366b | ||
|
|
e405afab29 | ||
|
|
a5dc4a8db4 | ||
|
|
543f2b5477 | ||
|
|
a36a9aca44 | ||
|
|
cbf0e24b18 | ||
|
|
f94e667f59 | ||
|
|
3ee91c731c | ||
|
|
0b13f663da | ||
|
|
4a82ff1ead | ||
|
|
f76472272e | ||
|
|
50579b3371 | ||
|
|
66b842579a | ||
|
|
aee1b10db6 | ||
|
|
ebc2c07ac8 | ||
|
|
e937e89267 | ||
|
|
11251d97ca | ||
|
|
41657e3565 | ||
|
|
70f36c007d | ||
|
|
a7f0106b31 | ||
|
|
286656635c | ||
|
|
0d994d4732 | ||
|
|
9e4d3c337f | ||
|
|
f0f1332e6b | ||
|
|
a78ea16c50 | ||
|
|
62f5f14f2f | ||
|
|
4540304fa0 | ||
|
|
df6f6f9ff4 | ||
|
|
4097d6e0ae | ||
|
|
822a1f30e0 | ||
|
|
0f80f9511d | ||
|
|
4838222dde | ||
|
|
35c286de9a | ||
|
|
be6b22b864 | ||
|
|
69d7fa14d3 | ||
|
|
e61442161e | ||
|
|
4b28d92e01 | ||
|
|
b512a1b040 | ||
|
|
affe7c687e | ||
|
|
fa5d9c0ff5 | ||
|
|
681ffc7b28 | ||
|
|
b8bf86f6ab | ||
|
|
7ab2124904 | ||
|
|
88fe824ddf | ||
|
|
93877f6b76 | ||
|
|
0ee5b0a5c9 | ||
|
|
bd1fd97738 | ||
|
|
ebaf409002 | ||
|
|
2d0ae6044c | ||
|
|
106bf02d49 | ||
|
|
f1c3b98774 | ||
|
|
4869a757c8 | ||
|
|
302bd7c059 | ||
|
|
245f5d2ba2 | ||
|
|
8ae0283c90 | ||
|
|
07b37fd9ce | ||
|
|
7c83775bc7 | ||
|
|
e97d132b3b | ||
|
|
c0315e96d8 | ||
|
|
5529102afc | ||
|
|
dad6be4d5e | ||
|
|
7d968869e3 | ||
|
|
8593624996 | ||
|
|
1ec43c7291 | ||
|
|
43a011026f | ||
|
|
cd81522b30 | ||
|
|
4a268da1df | ||
|
|
d7171232c3 | ||
|
|
faf0f9a698 | ||
|
|
9cb0101512 | ||
|
|
b0ffc34fb8 | ||
|
|
4e466f0e4e | ||
|
|
bcbdad83e9 | ||
|
|
949c374195 | ||
|
|
973205005c | ||
|
|
7d19f8f9b2 | ||
|
|
cf458d2a3b | ||
|
|
3dbd9afaec | ||
|
|
6ffaec725a | ||
|
|
0a548c62f4 | ||
|
|
4cca26ec84 | ||
|
|
f63afd5969 | ||
|
|
c5551daabc | ||
|
|
82b08e2dc8 | ||
|
|
5549b68e6e | ||
|
|
63789e96b5 |
16
.circleci/config.yml
Normal file
16
.circleci/config.yml
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
version: 2
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
parallelism: 4
|
||||||
|
shell: /bin/bash --login
|
||||||
|
docker:
|
||||||
|
- image: ericfreese/zsh-autosuggestions-test:latest
|
||||||
|
command: /sbin/init
|
||||||
|
steps:
|
||||||
|
- checkout
|
||||||
|
- run:
|
||||||
|
name: Running tests
|
||||||
|
command: |
|
||||||
|
for v in $(grep "^[^#]" ZSH_VERSIONS | awk "(NR + $CIRCLE_NODE_INDEX) % $CIRCLE_NODE_TOTAL == 0"); do
|
||||||
|
TEST_ZSH_BIN=zsh-$v make test || exit 1
|
||||||
|
done
|
||||||
@@ -1 +1 @@
|
|||||||
2.3.1
|
2.5.3
|
||||||
|
|||||||
20
CHANGELOG.md
20
CHANGELOG.md
@@ -1,5 +1,25 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## v0.5.2
|
||||||
|
- Allow disabling automatic widget re-binding for better performance (#418)
|
||||||
|
- Fix async suggestions when `SH_WORD_SPLIT` is set
|
||||||
|
- Refactor async mode to use process substitution instead of zpty (#417)
|
||||||
|
|
||||||
|
## v0.5.1
|
||||||
|
- Speed up widget rebinding (#413)
|
||||||
|
- Clean up global variable creations (#403)
|
||||||
|
- Respect user's set options when running original widget (#402)
|
||||||
|
|
||||||
|
## v0.5.0
|
||||||
|
- Don't overwrite config with default values (#335)
|
||||||
|
- Support fallback strategies by supplying array to suggestion config var
|
||||||
|
- Rename "default" suggestion strategy to "history" to name it based on what it actually does
|
||||||
|
- Reset opts in some functions affected by `GLOB_SUBST` (#334)
|
||||||
|
- Support widgets starting with dashes (ex: `-a-widget`) (#337)
|
||||||
|
- Skip async tests in zsh versions less than 5.0.8 because of reliability issues
|
||||||
|
- Fix handling of newline + carriage return in async pty (#333)
|
||||||
|
|
||||||
|
|
||||||
## v0.4.3
|
## v0.4.3
|
||||||
- Avoid bell when accepting suggestions with `autosuggest-accept` (#228)
|
- Avoid bell when accepting suggestions with `autosuggest-accept` (#228)
|
||||||
- Don't fetch suggestions after [up,down]-line-or-beginning-search (#227, #241)
|
- Don't fetch suggestions after [up,down]-line-or-beginning-search (#227, #241)
|
||||||
|
|||||||
20
Dockerfile
Normal file
20
Dockerfile
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
FROM ruby:2.5.3-alpine
|
||||||
|
|
||||||
|
RUN apk add --no-cache autoconf
|
||||||
|
RUN apk add --no-cache libtool
|
||||||
|
RUN apk add --no-cache libcap-dev
|
||||||
|
RUN apk add --no-cache pcre-dev
|
||||||
|
RUN apk add --no-cache curl
|
||||||
|
RUN apk add --no-cache build-base
|
||||||
|
RUN apk add --no-cache ncurses-dev
|
||||||
|
RUN apk add --no-cache tmux
|
||||||
|
|
||||||
|
WORKDIR /zsh-autosuggestions
|
||||||
|
|
||||||
|
ADD ZSH_VERSIONS /zsh-autosuggestions/ZSH_VERSIONS
|
||||||
|
ADD install_test_zsh.sh /zsh-autosuggestions/install_test_zsh.sh
|
||||||
|
RUN ./install_test_zsh.sh
|
||||||
|
|
||||||
|
ADD Gemfile /zsh-autosuggestions/Gemfile
|
||||||
|
ADD Gemfile.lock /zsh-autosuggestions/Gemfile.lock
|
||||||
|
RUN bundle install
|
||||||
12
INSTALL.md
12
INSTALL.md
@@ -16,6 +16,16 @@
|
|||||||
|
|
||||||
3. Start a new terminal session.
|
3. Start a new terminal session.
|
||||||
|
|
||||||
|
### Antigen
|
||||||
|
|
||||||
|
1. Add the following to your `.zshrc`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
antigen bundle zsh-users/zsh-autosuggestions
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Start a new terminal session.
|
||||||
|
|
||||||
### Oh My Zsh
|
### Oh My Zsh
|
||||||
|
|
||||||
1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`)
|
1. Clone this repository into `$ZSH_CUSTOM/plugins` (by default `~/.oh-my-zsh/custom/plugins`)
|
||||||
@@ -24,7 +34,7 @@
|
|||||||
git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
|
git clone https://github.com/zsh-users/zsh-autosuggestions ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-autosuggestions
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Add the plugin to the list of plugins for Oh My Zsh to load:
|
2. Add the plugin to the list of plugins for Oh My Zsh to load (inside `~/.zshrc`):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
plugins=(zsh-autosuggestions)
|
plugins=(zsh-autosuggestions)
|
||||||
|
|||||||
2
Makefile
2
Makefile
@@ -4,11 +4,11 @@ SRC_FILES := \
|
|||||||
$(SRC_DIR)/setup.zsh \
|
$(SRC_DIR)/setup.zsh \
|
||||||
$(SRC_DIR)/config.zsh \
|
$(SRC_DIR)/config.zsh \
|
||||||
$(SRC_DIR)/util.zsh \
|
$(SRC_DIR)/util.zsh \
|
||||||
$(SRC_DIR)/features.zsh \
|
|
||||||
$(SRC_DIR)/bind.zsh \
|
$(SRC_DIR)/bind.zsh \
|
||||||
$(SRC_DIR)/highlight.zsh \
|
$(SRC_DIR)/highlight.zsh \
|
||||||
$(SRC_DIR)/widgets.zsh \
|
$(SRC_DIR)/widgets.zsh \
|
||||||
$(SRC_DIR)/strategies/*.zsh \
|
$(SRC_DIR)/strategies/*.zsh \
|
||||||
|
$(SRC_DIR)/fetch.zsh \
|
||||||
$(SRC_DIR)/async.zsh \
|
$(SRC_DIR)/async.zsh \
|
||||||
$(SRC_DIR)/start.zsh
|
$(SRC_DIR)/start.zsh
|
||||||
|
|
||||||
|
|||||||
30
README.md
30
README.md
@@ -27,7 +27,7 @@ If you invoke the `forward-word` widget, it will partially accept the suggestion
|
|||||||
|
|
||||||
## Configuration
|
## 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).
|
You may want to override the default global config variables. 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).
|
**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).
|
||||||
|
|
||||||
@@ -39,10 +39,10 @@ Set `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` to configure the style that the suggestion
|
|||||||
|
|
||||||
### Suggestion Strategy
|
### Suggestion Strategy
|
||||||
|
|
||||||
Set `ZSH_AUTOSUGGEST_STRATEGY` to choose the strategy for generating suggestions. There are currently two 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 two built-in strategies to choose from:
|
||||||
|
|
||||||
- `default`: Chooses the most recent match.
|
- `history`: Chooses the most recent match from history.
|
||||||
- `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)). 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`.
|
||||||
|
|
||||||
|
|
||||||
### Widget Mapping
|
### Widget Mapping
|
||||||
@@ -63,11 +63,15 @@ Widgets that modify the buffer and are not found in any of these arrays will fet
|
|||||||
### Disabling suggestion for large buffers
|
### Disabling suggestion for large buffers
|
||||||
|
|
||||||
Set `ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE` to an integer value to disable autosuggestion for large buffers. The default is unset, which means that autosuggestion will be tried for any buffer size. Recommended value is 20.
|
Set `ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE` to an integer value to disable autosuggestion for large buffers. The default is unset, which means that autosuggestion will be tried for any buffer size. Recommended value is 20.
|
||||||
This can be useful when pasting large amount of text in the terminal, to avoid triggering autosuggestion for too long strings.
|
This can be useful when pasting large amount of text in the terminal, to avoid triggering autosuggestion for strings that are too long.
|
||||||
|
|
||||||
### Enable Asynchronous Mode
|
### Enable Asynchronous Mode
|
||||||
|
|
||||||
As of `v0.4.0`, suggestions can be fetched asynchronously using the `zsh/zpty` module. To enable this behavior, set the `ZSH_AUTOSUGGEST_USE_ASYNC` variable (it can be set to anything).
|
As of `v0.4.0`, suggestions can be fetched asynchronously. To enable this behavior, set the `ZSH_AUTOSUGGEST_USE_ASYNC` variable (it can be set to anything).
|
||||||
|
|
||||||
|
### Disabling automatic widget re-binding
|
||||||
|
|
||||||
|
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`.
|
||||||
|
|
||||||
|
|
||||||
### Key Bindings
|
### Key Bindings
|
||||||
@@ -139,6 +143,20 @@ Tests are written in ruby using the [`rspec`](http://rspec.info/) framework. The
|
|||||||
|
|
||||||
Test files live in `spec/`. To run the tests, run `make test`. To run a specific test, run `TESTS=spec/some_spec.rb make test`. You can also specify a `zsh` binary to use by setting the `TEST_ZSH_BIN` environment variable (ex: `TEST_ZSH_BIN=/bin/zsh make test`).
|
Test files live in `spec/`. To run the tests, run `make test`. To run a specific test, run `TESTS=spec/some_spec.rb make test`. You can also specify a `zsh` binary to use by setting the `TEST_ZSH_BIN` environment variable (ex: `TEST_ZSH_BIN=/bin/zsh make test`).
|
||||||
|
|
||||||
|
A docker image for testing is available [on docker hub](https://hub.docker.com/r/ericfreese/zsh-autosuggestions-test). It comes with ruby, the bundler dependencies, and all supported versions of zsh installed.
|
||||||
|
|
||||||
|
Pull the docker image with:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker pull ericfreese/zsh-autosuggestions-test
|
||||||
|
```
|
||||||
|
|
||||||
|
To run the tests for a specific version of zsh (where `<version>` below is substituted with the contents of a line from the [`ZSH_VERSIONS`](ZSH_VERSIONS) file):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker run -it -e TEST_ZSH_BIN=zsh-<version> -v $PWD:/zsh-autosuggestions zsh-autosuggestions-test make test
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
16
ZSH_VERSIONS
Normal file
16
ZSH_VERSIONS
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# Zsh releases to run tests against
|
||||||
|
# See https://github.com/zsh-users/zsh/releases
|
||||||
|
#
|
||||||
|
# When modifying this file, rebuild and push docker image:
|
||||||
|
# $ docker build -t ericfreese/zsh-autosuggestions-test .
|
||||||
|
# $ docker push ericfreese/zsh-autosuggestions-test
|
||||||
|
4.3.11
|
||||||
|
5.0.2
|
||||||
|
5.0.8
|
||||||
|
5.1.1
|
||||||
|
5.2
|
||||||
|
5.3.1
|
||||||
|
5.4.2
|
||||||
|
5.5.1
|
||||||
|
5.6.2
|
||||||
|
5.7.1
|
||||||
12
circle.yml
12
circle.yml
@@ -1,12 +0,0 @@
|
|||||||
machine:
|
|
||||||
environment:
|
|
||||||
ZSH_VERSIONS: zsh-dev/4.3.11 zsh/5.0.2 zsh/5.0.8 zsh/5.1.1 zsh/5.2 zsh/5.3.1 zsh/5.4.2 zsh/5.5.1
|
|
||||||
|
|
||||||
dependencies:
|
|
||||||
pre:
|
|
||||||
- for v in $(echo $ZSH_VERSIONS | awk "{ for (i=$((1+CIRCLE_NODE_INDEX));i<=NF;i+=$CIRCLE_NODE_TOTAL) print \$i }"); do wget https://sourceforge.net/projects/zsh/files/$v/zsh-${v#*/}.tar.gz && tar xzf zsh-${v#*/}.tar.gz && pushd zsh-${v#*/} && ./configure && sudo make install && popd || exit 1; done
|
|
||||||
|
|
||||||
test:
|
|
||||||
override:
|
|
||||||
- for v in $(echo $ZSH_VERSIONS | awk "{ for (i=$((1+CIRCLE_NODE_INDEX));i<=NF;i+=$CIRCLE_NODE_TOTAL) print \$i }"); do TEST_ZSH_BIN=/usr/local/bin/zsh-${v#*/} make test || exit 1; done:
|
|
||||||
parallel: true
|
|
||||||
26
install_test_zsh.sh
Executable file
26
install_test_zsh.sh
Executable file
@@ -0,0 +1,26 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
|
||||||
|
set -ex
|
||||||
|
|
||||||
|
for v in $(grep "^[^#]" ZSH_VERSIONS); do
|
||||||
|
mkdir zsh-$v
|
||||||
|
cd zsh-$v
|
||||||
|
|
||||||
|
curl -L https://api.github.com/repos/zsh-users/zsh/tarball/zsh-$v | tar xz --strip=1
|
||||||
|
|
||||||
|
./Util/preconfig
|
||||||
|
./configure --enable-pcre \
|
||||||
|
--enable-cap \
|
||||||
|
--enable-multibyte \
|
||||||
|
--with-term-lib='ncursesw tinfo' \
|
||||||
|
--with-tcsetpgrp \
|
||||||
|
--program-suffix="-$v"
|
||||||
|
|
||||||
|
make install.bin
|
||||||
|
make install.modules
|
||||||
|
make install.fns
|
||||||
|
|
||||||
|
cd ..
|
||||||
|
|
||||||
|
rm -rf zsh-$v
|
||||||
|
done
|
||||||
@@ -27,13 +27,19 @@ context 'with asynchronous suggestions enabled' do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe 'exiting a subshell' do
|
describe 'pressing ^C after fetching a suggestion' do
|
||||||
it 'should not cause error messages to be printed' do
|
before do
|
||||||
session.run_command('$(exit)')
|
skip 'Workaround does not work below v5.0.8' if session.zsh_version < Gem::Version.new('5.0.8')
|
||||||
|
end
|
||||||
|
|
||||||
sleep 1
|
it 'terminates the prompt and begins a new one' do
|
||||||
|
session.send_keys('e')
|
||||||
|
sleep 0.1
|
||||||
|
session.send_keys('C-c')
|
||||||
|
sleep 0.1
|
||||||
|
session.send_keys('echo')
|
||||||
|
|
||||||
expect(session.content).to eq('$(exit)')
|
wait_for { session.content }.to eq("e\necho")
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
14
spec/integrations/auto_cd_spec.rb
Normal file
14
spec/integrations/auto_cd_spec.rb
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
describe 'with `AUTO_CD` option set' do
|
||||||
|
let(:after_sourcing) do
|
||||||
|
-> {
|
||||||
|
session.run_command('setopt AUTO_CD')
|
||||||
|
session.run_command('autoload compinit && compinit')
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'directory names are still completed' do
|
||||||
|
session.send_string('sr')
|
||||||
|
session.send_keys('C-i')
|
||||||
|
wait_for { session.content }.to eq('src/')
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
describe 'a running zpty command' do
|
|
||||||
let(:before_sourcing) { -> { session.run_command('zmodload zsh/zpty && zpty -b kitty cat') } }
|
|
||||||
|
|
||||||
it 'is not affected by running zsh-autosuggestions' do
|
|
||||||
sleep 1 # Give a little time for precmd hooks to run
|
|
||||||
session.run_command('zpty -t kitty; echo $?')
|
|
||||||
|
|
||||||
wait_for { session.content }.to end_with("\n0")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
12
spec/integrations/glob_subst_spec.rb
Normal file
12
spec/integrations/glob_subst_spec.rb
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
describe 'with `GLOB_SUBST` option set' do
|
||||||
|
let(:after_sourcing) do
|
||||||
|
-> {
|
||||||
|
session.run_command('setopt GLOB_SUBST')
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'error messages are not printed' do
|
||||||
|
session.send_string('[[')
|
||||||
|
wait_for { session.content }.to eq('[[')
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -2,7 +2,7 @@ describe 'using `zle -U`' do
|
|||||||
let(:before_sourcing) do
|
let(:before_sourcing) do
|
||||||
-> do
|
-> do
|
||||||
session.
|
session.
|
||||||
run_command('_zsh_autosuggest_strategy_test() { sleep 1; _zsh_autosuggest_strategy_default "$1" }').
|
run_command('_zsh_autosuggest_strategy_test() { sleep 1; _zsh_autosuggest_strategy_history "$1" }').
|
||||||
run_command('foo() { zle -U - "echo hello" }; zle -N foo; bindkey ^B foo')
|
run_command('foo() { zle -U - "echo hello" }; zle -N foo; bindkey ^B foo')
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
context 'when async suggestions are enabled' do
|
|
||||||
let(:options) { ["ZSH_AUTOSUGGEST_USE_ASYNC="] }
|
|
||||||
|
|
||||||
describe 'the zpty for async suggestions' do
|
|
||||||
it 'is created with the default name' do
|
|
||||||
session.run_command('zpty -t zsh_autosuggest_pty &>/dev/null; echo $?')
|
|
||||||
wait_for { session.content }.to end_with("\n0")
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when ZSH_AUTOSUGGEST_ASYNC_PTY_NAME is set' do
|
|
||||||
let(:options) { super() + ['ZSH_AUTOSUGGEST_ASYNC_PTY_NAME=foo_pty'] }
|
|
||||||
|
|
||||||
it 'is created with the specified name' do
|
|
||||||
session.run_command('zpty -t foo_pty &>/dev/null; echo $?')
|
|
||||||
wait_for { session.content }.to end_with("\n0")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -1,20 +1,55 @@
|
|||||||
describe 'a suggestion for a given prefix' do
|
describe 'a suggestion for a given prefix' do
|
||||||
let(:options) { ['_zsh_autosuggest_strategy_default() { suggestion="echo foo" }'] }
|
let(:history_strategy) { '_zsh_autosuggest_strategy_history() { suggestion="history" }' }
|
||||||
|
let(:foobar_strategy) { '_zsh_autosuggest_strategy_foobar() { [[ "foobar baz" = $1* ]] && suggestion="foobar baz" }' }
|
||||||
|
let(:foobaz_strategy) { '_zsh_autosuggest_strategy_foobaz() { [[ "foobaz bar" = $1* ]] && suggestion="foobaz bar" }' }
|
||||||
|
|
||||||
it 'is determined by calling the default strategy function' do
|
let(:after_sourcing) do
|
||||||
session.send_string('e')
|
-> do
|
||||||
wait_for { session.content }.to eq('echo foo')
|
session.run_command(history_strategy)
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when ZSH_AUTOSUGGEST_STRATEGY is set' do
|
it 'by default is determined by calling the `history` strategy function' do
|
||||||
let(:options) { [
|
session.send_string('h')
|
||||||
'_zsh_autosuggest_strategy_custom() { suggestion="echo foo" }',
|
wait_for { session.content }.to eq('history')
|
||||||
'ZSH_AUTOSUGGEST_STRATEGY=custom'
|
end
|
||||||
] }
|
|
||||||
|
|
||||||
it 'is determined by calling the specified strategy function' do
|
context 'when ZSH_AUTOSUGGEST_STRATEGY is set to an array' do
|
||||||
session.send_string('e')
|
let(:after_sourcing) do
|
||||||
wait_for { session.content }.to eq('echo foo')
|
-> do
|
||||||
|
session.
|
||||||
|
run_command(foobar_strategy).
|
||||||
|
run_command(foobaz_strategy).
|
||||||
|
run_command('ZSH_AUTOSUGGEST_STRATEGY=(foobar foobaz)')
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'is determined by the first strategy function to return a suggestion' do
|
||||||
|
session.send_string('foo')
|
||||||
|
wait_for { session.content }.to eq('foobar baz')
|
||||||
|
|
||||||
|
session.send_string('baz')
|
||||||
|
wait_for { session.content }.to eq('foobaz bar')
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
context 'when ZSH_AUTOSUGGEST_STRATEGY is set to a string' do
|
||||||
|
let(:after_sourcing) do
|
||||||
|
-> do
|
||||||
|
session.
|
||||||
|
run_command(foobar_strategy).
|
||||||
|
run_command(foobaz_strategy).
|
||||||
|
run_command('ZSH_AUTOSUGGEST_STRATEGY="foobar foobaz"')
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'is determined by the first strategy function to return a suggestion' do
|
||||||
|
session.send_string('foo')
|
||||||
|
wait_for { session.content }.to eq('foobar baz')
|
||||||
|
|
||||||
|
session.send_string('baz')
|
||||||
|
wait_for { session.content }.to eq('foobaz bar')
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -94,4 +94,27 @@ describe 'a modification to the widget lists' do
|
|||||||
wait_for { session.content(esc_seqs: true) }.to eq('echo hello')
|
wait_for { session.content(esc_seqs: true) }.to eq('echo hello')
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
context 'when manual rebind is enabled' do
|
||||||
|
let(:options) { ["ZSH_AUTOSUGGEST_MANUAL_REBIND=true"] }
|
||||||
|
|
||||||
|
it 'does not take effect until bind command is re-run' do
|
||||||
|
with_history('echo hello') do
|
||||||
|
session.send_string('e')
|
||||||
|
wait_for { session.content }.to eq('echo hello')
|
||||||
|
session.send_keys('C-b')
|
||||||
|
sleep 1
|
||||||
|
expect(session.content(esc_seqs: true)).not_to eq('echo hello')
|
||||||
|
|
||||||
|
session.send_keys('C-c')
|
||||||
|
session.run_command('_zsh_autosuggest_bind_widgets').clear_screen
|
||||||
|
wait_for { session.content }.to eq('')
|
||||||
|
|
||||||
|
session.send_string('e')
|
||||||
|
wait_for { session.content }.to eq('echo hello')
|
||||||
|
session.send_keys('C-b')
|
||||||
|
wait_for { session.content(esc_seqs: true) }.to eq('echo hello')
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -6,12 +6,14 @@ RSpec.shared_context 'terminal session' do
|
|||||||
let(:term_opts) { {} }
|
let(:term_opts) { {} }
|
||||||
let(:session) { TerminalSession.new(term_opts) }
|
let(:session) { TerminalSession.new(term_opts) }
|
||||||
let(:before_sourcing) { -> {} }
|
let(:before_sourcing) { -> {} }
|
||||||
|
let(:after_sourcing) { -> {} }
|
||||||
let(:options) { [] }
|
let(:options) { [] }
|
||||||
|
|
||||||
around do |example|
|
around do |example|
|
||||||
before_sourcing.call
|
before_sourcing.call
|
||||||
|
session.run_command(options.join('; '))
|
||||||
session.run_command((['source zsh-autosuggestions.zsh'] + options).join('; '))
|
session.run_command('source zsh-autosuggestions.zsh')
|
||||||
|
after_sourcing.call
|
||||||
session.clear_screen
|
session.clear_screen
|
||||||
|
|
||||||
example.run
|
example.run
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
require 'strategies/special_characters_helper'
|
require 'strategies/special_characters_helper'
|
||||||
|
|
||||||
describe 'the default suggestion strategy' do
|
describe 'the `history` suggestion strategy' do
|
||||||
it 'suggests the last matching history entry' do
|
it 'suggests the last matching history entry' do
|
||||||
with_history('ls foo', 'ls bar', 'echo baz') do
|
with_history('ls foo', 'ls bar', 'echo baz') do
|
||||||
session.send_string('ls')
|
session.send_string('ls')
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
require 'strategies/special_characters_helper'
|
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'] }
|
||||||
|
|
||||||
it 'suggests the last matching history entry after the previous command' do
|
it 'suggests the last matching history entry after the previous command' do
|
||||||
|
|||||||
@@ -18,6 +18,10 @@ class TerminalSession
|
|||||||
tmux_command("new-session -d -x #{opts[:width]} -y #{opts[:height]} '#{cmd}'")
|
tmux_command("new-session -d -x #{opts[:width]} -y #{opts[:height]} '#{cmd}'")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def zsh_version
|
||||||
|
@zsh_version ||= Gem::Version.new(`#{ZSH_BIN} -c 'echo -n $ZSH_VERSION'`)
|
||||||
|
end
|
||||||
|
|
||||||
def tmux_socket_name
|
def tmux_socket_name
|
||||||
@tmux_socket_name ||= SecureRandom.hex(6)
|
@tmux_socket_name ||= SecureRandom.hex(6)
|
||||||
end
|
end
|
||||||
|
|||||||
141
src/async.zsh
141
src/async.zsh
@@ -3,104 +3,67 @@
|
|||||||
# Async #
|
# Async #
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
|
|
||||||
# Zpty process is spawned running this function
|
zmodload zsh/system
|
||||||
_zsh_autosuggest_async_server() {
|
|
||||||
emulate -R zsh
|
|
||||||
|
|
||||||
# There is a bug in zpty module (fixed in zsh/master) by which a
|
|
||||||
# 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
|
|
||||||
# process immediately, before it has a chance to kill any other
|
|
||||||
# zpty processes.
|
|
||||||
zshexit() {
|
|
||||||
kill -KILL $$
|
|
||||||
sleep 1 # Block for long enough for the signal to come through
|
|
||||||
}
|
|
||||||
|
|
||||||
# Output only newlines (not carriage return + newline)
|
|
||||||
stty -onlcr
|
|
||||||
|
|
||||||
# Silence any error messages
|
|
||||||
exec 2>/dev/null
|
|
||||||
|
|
||||||
local last_pid
|
|
||||||
|
|
||||||
while IFS='' read -r -d $'\0' query; do
|
|
||||||
# Kill last bg process
|
|
||||||
kill -KILL $last_pid &>/dev/null
|
|
||||||
|
|
||||||
# Run suggestion search in the background
|
|
||||||
(
|
|
||||||
local suggestion
|
|
||||||
_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY "$query"
|
|
||||||
echo -n -E "$suggestion"$'\0'
|
|
||||||
) &
|
|
||||||
|
|
||||||
last_pid=$!
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_async_request() {
|
_zsh_autosuggest_async_request() {
|
||||||
# Write the query to the zpty process to fetch a suggestion
|
typeset -g _ZSH_AUTOSUGGEST_ASYNC_FD _ZSH_AUTOSUGGEST_CHILD_PID
|
||||||
zpty -w -n $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME "${1}"$'\0'
|
|
||||||
|
# If we've got a pending request, cancel it
|
||||||
|
if [[ -n "$_ZSH_AUTOSUGGEST_ASYNC_FD" ]] && { true <&$_ZSH_AUTOSUGGEST_ASYNC_FD } 2>/dev/null; then
|
||||||
|
# Close the file descriptor and remove the handler
|
||||||
|
exec {_ZSH_AUTOSUGGEST_ASYNC_FD}<&-
|
||||||
|
zle -F $_ZSH_AUTOSUGGEST_ASYNC_FD
|
||||||
|
|
||||||
|
# Zsh will make a new process group for the child process only if job
|
||||||
|
# control is enabled (MONITOR option)
|
||||||
|
if [[ -o MONITOR ]]; then
|
||||||
|
# Send the signal to the process group to kill any processes that may
|
||||||
|
# have been forked by the suggestion strategy
|
||||||
|
kill -TERM -$_ZSH_AUTOSUGGEST_CHILD_PID 2>/dev/null
|
||||||
|
else
|
||||||
|
# Kill just the child process since it wasn't placed in a new process
|
||||||
|
# group. If the suggestion strategy forked any child processes they may
|
||||||
|
# be orphaned and left behind.
|
||||||
|
kill -TERM $_ZSH_AUTOSUGGEST_CHILD_PID 2>/dev/null
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Fork a process to fetch a suggestion and open a pipe to read from it
|
||||||
|
exec {_ZSH_AUTOSUGGEST_ASYNC_FD}< <(
|
||||||
|
# Tell parent process our pid
|
||||||
|
echo $sysparams[pid]
|
||||||
|
|
||||||
|
# Fetch and print the suggestion
|
||||||
|
local suggestion
|
||||||
|
_zsh_autosuggest_fetch_suggestion "$1"
|
||||||
|
echo -nE "$suggestion"
|
||||||
|
)
|
||||||
|
|
||||||
|
# There's a weird bug here where ^C stops working unless we force a fork
|
||||||
|
# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
|
||||||
|
command true
|
||||||
|
|
||||||
|
# Read the pid from the child process
|
||||||
|
read _ZSH_AUTOSUGGEST_CHILD_PID <&$_ZSH_AUTOSUGGEST_ASYNC_FD
|
||||||
|
|
||||||
|
# When the fd is readable, call the response handler
|
||||||
|
zle -F "$_ZSH_AUTOSUGGEST_ASYNC_FD" _zsh_autosuggest_async_response
|
||||||
}
|
}
|
||||||
|
|
||||||
# Called when new data is ready to be read from the pty
|
# Called when new data is ready to be read from the pipe
|
||||||
# First arg will be fd ready for reading
|
# First arg will be fd ready for reading
|
||||||
# Second arg will be passed in case of error
|
# Second arg will be passed in case of error
|
||||||
_zsh_autosuggest_async_response() {
|
_zsh_autosuggest_async_response() {
|
||||||
setopt LOCAL_OPTIONS EXTENDED_GLOB
|
emulate -L zsh
|
||||||
|
|
||||||
local suggestion
|
if [[ -z "$2" || "$2" == "hup" ]]; then
|
||||||
|
# Read everything from the fd and give it as a suggestion
|
||||||
|
zle autosuggest-suggest -- "$(cat <&$1)"
|
||||||
|
|
||||||
zpty -rt $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME suggestion '*'$'\0' 2>/dev/null
|
# Close the fd
|
||||||
zle autosuggest-suggest -- "${suggestion%%$'\0'##}"
|
exec {1}<&-
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_async_pty_create() {
|
|
||||||
# With newer versions of zsh, REPLY stores the fd to read from
|
|
||||||
typeset -h REPLY
|
|
||||||
|
|
||||||
# If we won't get a fd back from zpty, try to guess it
|
|
||||||
if (( ! $_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD )); then
|
|
||||||
integer -l zptyfd
|
|
||||||
exec {zptyfd}>&1 # Open a new file descriptor (above 10).
|
|
||||||
exec {zptyfd}>&- # Close it so it's free to be used by zpty.
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Fork a zpty process running the server function
|
# Always remove the handler
|
||||||
zpty -b $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME _zsh_autosuggest_async_server
|
zle -F "$1"
|
||||||
|
|
||||||
# Store the fd so we can remove the handler later
|
|
||||||
if (( REPLY )); then
|
|
||||||
_ZSH_AUTOSUGGEST_PTY_FD=$REPLY
|
|
||||||
else
|
|
||||||
_ZSH_AUTOSUGGEST_PTY_FD=$zptyfd
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Set up input handler from the zpty
|
|
||||||
zle -F $_ZSH_AUTOSUGGEST_PTY_FD _zsh_autosuggest_async_response
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_async_pty_destroy() {
|
|
||||||
# Remove the input handler
|
|
||||||
zle -F $_ZSH_AUTOSUGGEST_PTY_FD &>/dev/null
|
|
||||||
|
|
||||||
# Destroy the zpty
|
|
||||||
zpty -d $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME &>/dev/null
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_async_pty_recreate() {
|
|
||||||
_zsh_autosuggest_async_pty_destroy
|
|
||||||
_zsh_autosuggest_async_pty_create
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_async_start() {
|
|
||||||
typeset -g _ZSH_AUTOSUGGEST_PTY_FD
|
|
||||||
|
|
||||||
_zsh_autosuggest_feature_detect_zpty_returns_fd
|
|
||||||
_zsh_autosuggest_async_pty_recreate
|
|
||||||
|
|
||||||
# We recreate the pty to get a fresh list of history events
|
|
||||||
add-zsh-hook precmd _zsh_autosuggest_async_pty_recreate
|
|
||||||
}
|
}
|
||||||
|
|||||||
33
src/bind.zsh
33
src/bind.zsh
@@ -4,21 +4,8 @@
|
|||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
|
|
||||||
_zsh_autosuggest_incr_bind_count() {
|
_zsh_autosuggest_incr_bind_count() {
|
||||||
if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then
|
typeset -gi bind_count=$((_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]+1))
|
||||||
((_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]++))
|
_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=$bind_count
|
||||||
else
|
|
||||||
_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=1
|
|
||||||
fi
|
|
||||||
|
|
||||||
typeset -gi bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_get_bind_count() {
|
|
||||||
if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then
|
|
||||||
typeset -gi bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]
|
|
||||||
else
|
|
||||||
typeset -gi bind_count=0
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Bind a single widget to an autosuggest widget, saving a reference to the original widget
|
# Bind a single widget to an autosuggest widget, saving a reference to the original widget
|
||||||
@@ -34,30 +21,30 @@ _zsh_autosuggest_bind_widget() {
|
|||||||
# Save a reference to the original widget
|
# Save a reference to the original widget
|
||||||
case $widgets[$widget] in
|
case $widgets[$widget] in
|
||||||
# Already bound
|
# Already bound
|
||||||
user:_zsh_autosuggest_(bound|orig)_*);;
|
user:_zsh_autosuggest_(bound|orig)_*)
|
||||||
|
bind_count=$((_ZSH_AUTOSUGGEST_BIND_COUNTS[$widget]))
|
||||||
|
;;
|
||||||
|
|
||||||
# User-defined widget
|
# User-defined widget
|
||||||
user:*)
|
user:*)
|
||||||
_zsh_autosuggest_incr_bind_count $widget
|
_zsh_autosuggest_incr_bind_count $widget
|
||||||
zle -N $prefix${bind_count}-$widget ${widgets[$widget]#*:}
|
zle -N $prefix$bind_count-$widget ${widgets[$widget]#*:}
|
||||||
;;
|
;;
|
||||||
|
|
||||||
# Built-in widget
|
# Built-in widget
|
||||||
builtin)
|
builtin)
|
||||||
_zsh_autosuggest_incr_bind_count $widget
|
_zsh_autosuggest_incr_bind_count $widget
|
||||||
eval "_zsh_autosuggest_orig_${(q)widget}() { zle .${(q)widget} }"
|
eval "_zsh_autosuggest_orig_${(q)widget}() { zle .${(q)widget} }"
|
||||||
zle -N $prefix${bind_count}-$widget _zsh_autosuggest_orig_$widget
|
zle -N $prefix$bind_count-$widget _zsh_autosuggest_orig_$widget
|
||||||
;;
|
;;
|
||||||
|
|
||||||
# Completion widget
|
# Completion widget
|
||||||
completion:*)
|
completion:*)
|
||||||
_zsh_autosuggest_incr_bind_count $widget
|
_zsh_autosuggest_incr_bind_count $widget
|
||||||
eval "zle -C $prefix${bind_count}-${(q)widget} ${${(s.:.)widgets[$widget]}[2,3]}"
|
eval "zle -C $prefix$bind_count-${(q)widget} ${${(s.:.)widgets[$widget]}[2,3]}"
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
_zsh_autosuggest_get_bind_count $widget
|
|
||||||
|
|
||||||
# Pass the original widget's name explicitly into the autosuggest
|
# Pass the original widget's name explicitly into the autosuggest
|
||||||
# function. Use this passed in widget name to call the original
|
# function. Use this passed in widget name to call the original
|
||||||
# widget instead of relying on the $WIDGET variable being set
|
# widget instead of relying on the $WIDGET variable being set
|
||||||
@@ -69,11 +56,13 @@ _zsh_autosuggest_bind_widget() {
|
|||||||
}"
|
}"
|
||||||
|
|
||||||
# Create the bound widget
|
# Create the bound widget
|
||||||
zle -N $widget _zsh_autosuggest_bound_${bind_count}_$widget
|
zle -N -- $widget _zsh_autosuggest_bound_${bind_count}_$widget
|
||||||
}
|
}
|
||||||
|
|
||||||
# Map all configured widgets to the right autosuggest widgets
|
# Map all configured widgets to the right autosuggest widgets
|
||||||
_zsh_autosuggest_bind_widgets() {
|
_zsh_autosuggest_bind_widgets() {
|
||||||
|
emulate -L zsh
|
||||||
|
|
||||||
local widget
|
local widget
|
||||||
local ignore_widgets
|
local ignore_widgets
|
||||||
|
|
||||||
|
|||||||
@@ -6,15 +6,24 @@
|
|||||||
# Color to use when highlighting suggestion
|
# Color to use when highlighting suggestion
|
||||||
# Uses format of `region_highlight`
|
# Uses format of `region_highlight`
|
||||||
# More info: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets
|
# More info: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets
|
||||||
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=8'
|
(( ! ${+ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE} )) &&
|
||||||
|
typeset -g ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=8'
|
||||||
|
|
||||||
# Prefix to use when saving original versions of bound widgets
|
# Prefix to use when saving original versions of bound widgets
|
||||||
ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
(( ! ${+ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX} )) &&
|
||||||
|
typeset -g ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
||||||
|
|
||||||
ZSH_AUTOSUGGEST_STRATEGY=default
|
# Strategies to use to fetch a suggestion
|
||||||
|
# Will try each strategy in order until a suggestion is returned
|
||||||
|
(( ! ${+ZSH_AUTOSUGGEST_STRATEGY} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_STRATEGY
|
||||||
|
ZSH_AUTOSUGGEST_STRATEGY=(history)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that clear the suggestion
|
# Widgets that clear the suggestion
|
||||||
ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_CLEAR_WIDGETS} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_CLEAR_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
|
||||||
history-search-forward
|
history-search-forward
|
||||||
history-search-backward
|
history-search-backward
|
||||||
history-beginning-search-forward
|
history-beginning-search-forward
|
||||||
@@ -26,23 +35,32 @@ ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
|
|||||||
up-line-or-history
|
up-line-or-history
|
||||||
down-line-or-history
|
down-line-or-history
|
||||||
accept-line
|
accept-line
|
||||||
)
|
)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that accept the entire suggestion
|
# Widgets that accept the entire suggestion
|
||||||
ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_ACCEPT_WIDGETS} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_ACCEPT_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=(
|
||||||
forward-char
|
forward-char
|
||||||
end-of-line
|
end-of-line
|
||||||
vi-forward-char
|
vi-forward-char
|
||||||
vi-end-of-line
|
vi-end-of-line
|
||||||
vi-add-eol
|
vi-add-eol
|
||||||
)
|
)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that accept the entire suggestion and execute it
|
# Widgets that accept the entire suggestion and execute it
|
||||||
ZSH_AUTOSUGGEST_EXECUTE_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_EXECUTE_WIDGETS} )) && {
|
||||||
)
|
typeset -ga ZSH_AUTOSUGGEST_EXECUTE_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_EXECUTE_WIDGETS=(
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that accept the suggestion as far as the cursor moves
|
# Widgets that accept the suggestion as far as the cursor moves
|
||||||
ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
|
||||||
forward-word
|
forward-word
|
||||||
emacs-forward-word
|
emacs-forward-word
|
||||||
vi-forward-word
|
vi-forward-word
|
||||||
@@ -51,10 +69,13 @@ ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
|
|||||||
vi-forward-blank-word-end
|
vi-forward-blank-word-end
|
||||||
vi-find-next-char
|
vi-find-next-char
|
||||||
vi-find-next-char-skip
|
vi-find-next-char-skip
|
||||||
)
|
)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that should be ignored (globbing supported but must be escaped)
|
# Widgets that should be ignored (globbing supported but must be escaped)
|
||||||
ZSH_AUTOSUGGEST_IGNORE_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_IGNORE_WIDGETS} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_IGNORE_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_IGNORE_WIDGETS=(
|
||||||
orig-\*
|
orig-\*
|
||||||
beep
|
beep
|
||||||
run-help
|
run-help
|
||||||
@@ -62,10 +83,5 @@ ZSH_AUTOSUGGEST_IGNORE_WIDGETS=(
|
|||||||
which-command
|
which-command
|
||||||
yank
|
yank
|
||||||
yank-pop
|
yank-pop
|
||||||
)
|
)
|
||||||
|
}
|
||||||
# Max size of buffer to trigger autosuggestion. Leave undefined for no upper bound.
|
|
||||||
ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE=
|
|
||||||
|
|
||||||
# Pty name for calculating autosuggestions asynchronously
|
|
||||||
ZSH_AUTOSUGGEST_ASYNC_PTY_NAME=zsh_autosuggest_pty
|
|
||||||
|
|||||||
@@ -1,19 +0,0 @@
|
|||||||
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
# Feature Detection #
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
|
|
||||||
_zsh_autosuggest_feature_detect_zpty_returns_fd() {
|
|
||||||
typeset -g _ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD
|
|
||||||
typeset -h REPLY
|
|
||||||
|
|
||||||
zpty zsh_autosuggest_feature_detect '{ zshexit() { kill -KILL $$; sleep 1 } }'
|
|
||||||
|
|
||||||
if (( REPLY )); then
|
|
||||||
_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD=1
|
|
||||||
else
|
|
||||||
_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD=0
|
|
||||||
fi
|
|
||||||
|
|
||||||
zpty -d zsh_autosuggest_feature_detect
|
|
||||||
}
|
|
||||||
24
src/fetch.zsh
Normal file
24
src/fetch.zsh
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
# Fetch Suggestion #
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
# Loops through all specified strategies and returns a suggestion
|
||||||
|
# from the first strategy to provide one.
|
||||||
|
#
|
||||||
|
|
||||||
|
_zsh_autosuggest_fetch_suggestion() {
|
||||||
|
typeset -g suggestion
|
||||||
|
local -a strategies
|
||||||
|
local strategy
|
||||||
|
|
||||||
|
# Ensure we are working with an array
|
||||||
|
strategies=(${=ZSH_AUTOSUGGEST_STRATEGY})
|
||||||
|
|
||||||
|
for strategy in $strategies; do
|
||||||
|
# Try to get a suggestion from this strategy
|
||||||
|
_zsh_autosuggest_strategy_$strategy "$1"
|
||||||
|
|
||||||
|
# Break once we've found a suggestion
|
||||||
|
[[ -n "$suggestion" ]] && break
|
||||||
|
done
|
||||||
|
}
|
||||||
@@ -5,19 +5,17 @@
|
|||||||
|
|
||||||
# Start the autosuggestion widgets
|
# Start the autosuggestion widgets
|
||||||
_zsh_autosuggest_start() {
|
_zsh_autosuggest_start() {
|
||||||
|
# By default we re-bind widgets on every precmd to ensure we wrap other
|
||||||
|
# wrappers. Specifically, highlighting breaks if our widgets are wrapped by
|
||||||
|
# zsh-syntax-highlighting widgets. This also allows modifications to the
|
||||||
|
# widget list variables to take effect on the next precmd. However this has
|
||||||
|
# a decent performance hit, so users can set ZSH_AUTOSUGGEST_MANUAL_REBIND
|
||||||
|
# to disable the automatic re-binding.
|
||||||
|
if (( ${+ZSH_AUTOSUGGEST_MANUAL_REBIND} )); then
|
||||||
add-zsh-hook -d precmd _zsh_autosuggest_start
|
add-zsh-hook -d precmd _zsh_autosuggest_start
|
||||||
|
fi
|
||||||
|
|
||||||
_zsh_autosuggest_bind_widgets
|
_zsh_autosuggest_bind_widgets
|
||||||
|
|
||||||
# Re-bind widgets on every precmd to ensure we wrap other wrappers.
|
|
||||||
# Specifically, highlighting breaks if our widgets are wrapped by
|
|
||||||
# zsh-syntax-highlighting widgets. This also allows modifications
|
|
||||||
# to the widget list variables to take effect on the next precmd.
|
|
||||||
add-zsh-hook precmd _zsh_autosuggest_bind_widgets
|
|
||||||
|
|
||||||
if [[ -n "${ZSH_AUTOSUGGEST_USE_ASYNC+x}" ]]; then
|
|
||||||
_zsh_autosuggest_async_start
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Start the autosuggestion widgets on the next precmd
|
# Start the autosuggestion widgets on the next precmd
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Default Suggestion Strategy #
|
# History Suggestion Strategy #
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Suggests the most recent history item that matches the given
|
# Suggests the most recent history item that matches the given
|
||||||
# prefix.
|
# prefix.
|
||||||
#
|
#
|
||||||
|
|
||||||
_zsh_autosuggest_strategy_default() {
|
_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
|
||||||
|
|
||||||
@@ -53,6 +53,8 @@ _zsh_autosuggest_modify() {
|
|||||||
_zsh_autosuggest_invoke_original_widget $@
|
_zsh_autosuggest_invoke_original_widget $@
|
||||||
retval=$?
|
retval=$?
|
||||||
|
|
||||||
|
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"
|
||||||
@@ -83,7 +85,7 @@ _zsh_autosuggest_modify() {
|
|||||||
|
|
||||||
# Get a new suggestion if the buffer is not empty after modification
|
# Get a new suggestion if the buffer is not empty after modification
|
||||||
if (( $#BUFFER > 0 )); then
|
if (( $#BUFFER > 0 )); then
|
||||||
if [[ -z "$ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" ]] || (( $#BUFFER <= $ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE )); then
|
if (( ! ${+ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE} )) || (( $#BUFFER <= $ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE )); then
|
||||||
_zsh_autosuggest_fetch
|
_zsh_autosuggest_fetch
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
@@ -93,17 +95,19 @@ _zsh_autosuggest_modify() {
|
|||||||
|
|
||||||
# Fetch a new suggestion based on what's currently in the buffer
|
# Fetch a new suggestion based on what's currently in the buffer
|
||||||
_zsh_autosuggest_fetch() {
|
_zsh_autosuggest_fetch() {
|
||||||
if zpty -t "$ZSH_AUTOSUGGEST_ASYNC_PTY_NAME" &>/dev/null; then
|
if (( ${+ZSH_AUTOSUGGEST_USE_ASYNC} )); then
|
||||||
_zsh_autosuggest_async_request "$BUFFER"
|
_zsh_autosuggest_async_request "$BUFFER"
|
||||||
else
|
else
|
||||||
local suggestion
|
local suggestion
|
||||||
_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY "$BUFFER"
|
_zsh_autosuggest_fetch_suggestion "$BUFFER"
|
||||||
_zsh_autosuggest_suggest "$suggestion"
|
_zsh_autosuggest_suggest "$suggestion"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# Offer a suggestion
|
# Offer a suggestion
|
||||||
_zsh_autosuggest_suggest() {
|
_zsh_autosuggest_suggest() {
|
||||||
|
emulate -L zsh
|
||||||
|
|
||||||
local suggestion="$1"
|
local suggestion="$1"
|
||||||
|
|
||||||
if [[ -n "$suggestion" ]] && (( $#BUFFER )); then
|
if [[ -n "$suggestion" ]] && (( $#BUFFER )); then
|
||||||
@@ -186,7 +190,9 @@ _zsh_autosuggest_partial_accept() {
|
|||||||
return $retval
|
return $retval
|
||||||
}
|
}
|
||||||
|
|
||||||
for action in clear modify fetch suggest accept partial_accept execute enable disable toggle; do
|
() {
|
||||||
|
local action
|
||||||
|
for action in clear modify fetch suggest accept partial_accept execute enable disable toggle; do
|
||||||
eval "_zsh_autosuggest_widget_$action() {
|
eval "_zsh_autosuggest_widget_$action() {
|
||||||
local -i retval
|
local -i retval
|
||||||
|
|
||||||
@@ -201,13 +207,14 @@ for action in clear modify fetch suggest accept partial_accept execute enable di
|
|||||||
|
|
||||||
return \$retval
|
return \$retval
|
||||||
}"
|
}"
|
||||||
done
|
done
|
||||||
|
|
||||||
zle -N autosuggest-fetch _zsh_autosuggest_widget_fetch
|
zle -N autosuggest-fetch _zsh_autosuggest_widget_fetch
|
||||||
zle -N autosuggest-suggest _zsh_autosuggest_widget_suggest
|
zle -N autosuggest-suggest _zsh_autosuggest_widget_suggest
|
||||||
zle -N autosuggest-accept _zsh_autosuggest_widget_accept
|
zle -N autosuggest-accept _zsh_autosuggest_widget_accept
|
||||||
zle -N autosuggest-clear _zsh_autosuggest_widget_clear
|
zle -N autosuggest-clear _zsh_autosuggest_widget_clear
|
||||||
zle -N autosuggest-execute _zsh_autosuggest_widget_execute
|
zle -N autosuggest-execute _zsh_autosuggest_widget_execute
|
||||||
zle -N autosuggest-enable _zsh_autosuggest_widget_enable
|
zle -N autosuggest-enable _zsh_autosuggest_widget_enable
|
||||||
zle -N autosuggest-disable _zsh_autosuggest_widget_disable
|
zle -N autosuggest-disable _zsh_autosuggest_widget_disable
|
||||||
zle -N autosuggest-toggle _zsh_autosuggest_widget_toggle
|
zle -N autosuggest-toggle _zsh_autosuggest_widget_toggle
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Fish-like fast/unobtrusive autosuggestions for zsh.
|
# Fish-like fast/unobtrusive autosuggestions for zsh.
|
||||||
# https://github.com/zsh-users/zsh-autosuggestions
|
# https://github.com/zsh-users/zsh-autosuggestions
|
||||||
# v0.4.3
|
# v0.5.2
|
||||||
# Copyright (c) 2013 Thiago de Arruda
|
# Copyright (c) 2013 Thiago de Arruda
|
||||||
# Copyright (c) 2016-2018 Eric Freese
|
# Copyright (c) 2016-2018 Eric Freese
|
||||||
#
|
#
|
||||||
@@ -42,15 +42,24 @@ zmodload zsh/zpty
|
|||||||
# Color to use when highlighting suggestion
|
# Color to use when highlighting suggestion
|
||||||
# Uses format of `region_highlight`
|
# Uses format of `region_highlight`
|
||||||
# More info: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets
|
# More info: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Zle-Widgets
|
||||||
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=8'
|
(( ! ${+ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE} )) &&
|
||||||
|
typeset -g ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=8'
|
||||||
|
|
||||||
# Prefix to use when saving original versions of bound widgets
|
# Prefix to use when saving original versions of bound widgets
|
||||||
ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
(( ! ${+ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX} )) &&
|
||||||
|
typeset -g ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
||||||
|
|
||||||
ZSH_AUTOSUGGEST_STRATEGY=default
|
# Strategies to use to fetch a suggestion
|
||||||
|
# Will try each strategy in order until a suggestion is returned
|
||||||
|
(( ! ${+ZSH_AUTOSUGGEST_STRATEGY} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_STRATEGY
|
||||||
|
ZSH_AUTOSUGGEST_STRATEGY=(history)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that clear the suggestion
|
# Widgets that clear the suggestion
|
||||||
ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_CLEAR_WIDGETS} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_CLEAR_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
|
||||||
history-search-forward
|
history-search-forward
|
||||||
history-search-backward
|
history-search-backward
|
||||||
history-beginning-search-forward
|
history-beginning-search-forward
|
||||||
@@ -62,23 +71,32 @@ ZSH_AUTOSUGGEST_CLEAR_WIDGETS=(
|
|||||||
up-line-or-history
|
up-line-or-history
|
||||||
down-line-or-history
|
down-line-or-history
|
||||||
accept-line
|
accept-line
|
||||||
)
|
)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that accept the entire suggestion
|
# Widgets that accept the entire suggestion
|
||||||
ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_ACCEPT_WIDGETS} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_ACCEPT_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_ACCEPT_WIDGETS=(
|
||||||
forward-char
|
forward-char
|
||||||
end-of-line
|
end-of-line
|
||||||
vi-forward-char
|
vi-forward-char
|
||||||
vi-end-of-line
|
vi-end-of-line
|
||||||
vi-add-eol
|
vi-add-eol
|
||||||
)
|
)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that accept the entire suggestion and execute it
|
# Widgets that accept the entire suggestion and execute it
|
||||||
ZSH_AUTOSUGGEST_EXECUTE_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_EXECUTE_WIDGETS} )) && {
|
||||||
)
|
typeset -ga ZSH_AUTOSUGGEST_EXECUTE_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_EXECUTE_WIDGETS=(
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that accept the suggestion as far as the cursor moves
|
# Widgets that accept the suggestion as far as the cursor moves
|
||||||
ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
|
||||||
forward-word
|
forward-word
|
||||||
emacs-forward-word
|
emacs-forward-word
|
||||||
vi-forward-word
|
vi-forward-word
|
||||||
@@ -87,10 +105,13 @@ ZSH_AUTOSUGGEST_PARTIAL_ACCEPT_WIDGETS=(
|
|||||||
vi-forward-blank-word-end
|
vi-forward-blank-word-end
|
||||||
vi-find-next-char
|
vi-find-next-char
|
||||||
vi-find-next-char-skip
|
vi-find-next-char-skip
|
||||||
)
|
)
|
||||||
|
}
|
||||||
|
|
||||||
# Widgets that should be ignored (globbing supported but must be escaped)
|
# Widgets that should be ignored (globbing supported but must be escaped)
|
||||||
ZSH_AUTOSUGGEST_IGNORE_WIDGETS=(
|
(( ! ${+ZSH_AUTOSUGGEST_IGNORE_WIDGETS} )) && {
|
||||||
|
typeset -ga ZSH_AUTOSUGGEST_IGNORE_WIDGETS
|
||||||
|
ZSH_AUTOSUGGEST_IGNORE_WIDGETS=(
|
||||||
orig-\*
|
orig-\*
|
||||||
beep
|
beep
|
||||||
run-help
|
run-help
|
||||||
@@ -98,13 +119,8 @@ ZSH_AUTOSUGGEST_IGNORE_WIDGETS=(
|
|||||||
which-command
|
which-command
|
||||||
yank
|
yank
|
||||||
yank-pop
|
yank-pop
|
||||||
)
|
)
|
||||||
|
}
|
||||||
# Max size of buffer to trigger autosuggestion. Leave undefined for no upper bound.
|
|
||||||
ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE=
|
|
||||||
|
|
||||||
# Pty name for calculating autosuggestions asynchronously
|
|
||||||
ZSH_AUTOSUGGEST_ASYNC_PTY_NAME=zsh_autosuggest_pty
|
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Utility Functions #
|
# Utility Functions #
|
||||||
@@ -117,45 +133,13 @@ _zsh_autosuggest_escape_command() {
|
|||||||
echo -E "${1//(#m)[\"\'\\()\[\]|*?~]/\\$MATCH}"
|
echo -E "${1//(#m)[\"\'\\()\[\]|*?~]/\\$MATCH}"
|
||||||
}
|
}
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
# Feature Detection #
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
|
|
||||||
_zsh_autosuggest_feature_detect_zpty_returns_fd() {
|
|
||||||
typeset -g _ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD
|
|
||||||
typeset -h REPLY
|
|
||||||
|
|
||||||
zpty zsh_autosuggest_feature_detect '{ zshexit() { kill -KILL $$; sleep 1 } }'
|
|
||||||
|
|
||||||
if (( REPLY )); then
|
|
||||||
_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD=1
|
|
||||||
else
|
|
||||||
_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD=0
|
|
||||||
fi
|
|
||||||
|
|
||||||
zpty -d zsh_autosuggest_feature_detect
|
|
||||||
}
|
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Widget Helpers #
|
# Widget Helpers #
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
|
|
||||||
_zsh_autosuggest_incr_bind_count() {
|
_zsh_autosuggest_incr_bind_count() {
|
||||||
if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then
|
typeset -gi bind_count=$((_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]+1))
|
||||||
((_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]++))
|
_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=$bind_count
|
||||||
else
|
|
||||||
_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=1
|
|
||||||
fi
|
|
||||||
|
|
||||||
typeset -gi bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_get_bind_count() {
|
|
||||||
if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then
|
|
||||||
typeset -gi bind_count=$_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]
|
|
||||||
else
|
|
||||||
typeset -gi bind_count=0
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Bind a single widget to an autosuggest widget, saving a reference to the original widget
|
# Bind a single widget to an autosuggest widget, saving a reference to the original widget
|
||||||
@@ -171,30 +155,30 @@ _zsh_autosuggest_bind_widget() {
|
|||||||
# Save a reference to the original widget
|
# Save a reference to the original widget
|
||||||
case $widgets[$widget] in
|
case $widgets[$widget] in
|
||||||
# Already bound
|
# Already bound
|
||||||
user:_zsh_autosuggest_(bound|orig)_*);;
|
user:_zsh_autosuggest_(bound|orig)_*)
|
||||||
|
bind_count=$((_ZSH_AUTOSUGGEST_BIND_COUNTS[$widget]))
|
||||||
|
;;
|
||||||
|
|
||||||
# User-defined widget
|
# User-defined widget
|
||||||
user:*)
|
user:*)
|
||||||
_zsh_autosuggest_incr_bind_count $widget
|
_zsh_autosuggest_incr_bind_count $widget
|
||||||
zle -N $prefix${bind_count}-$widget ${widgets[$widget]#*:}
|
zle -N $prefix$bind_count-$widget ${widgets[$widget]#*:}
|
||||||
;;
|
;;
|
||||||
|
|
||||||
# Built-in widget
|
# Built-in widget
|
||||||
builtin)
|
builtin)
|
||||||
_zsh_autosuggest_incr_bind_count $widget
|
_zsh_autosuggest_incr_bind_count $widget
|
||||||
eval "_zsh_autosuggest_orig_${(q)widget}() { zle .${(q)widget} }"
|
eval "_zsh_autosuggest_orig_${(q)widget}() { zle .${(q)widget} }"
|
||||||
zle -N $prefix${bind_count}-$widget _zsh_autosuggest_orig_$widget
|
zle -N $prefix$bind_count-$widget _zsh_autosuggest_orig_$widget
|
||||||
;;
|
;;
|
||||||
|
|
||||||
# Completion widget
|
# Completion widget
|
||||||
completion:*)
|
completion:*)
|
||||||
_zsh_autosuggest_incr_bind_count $widget
|
_zsh_autosuggest_incr_bind_count $widget
|
||||||
eval "zle -C $prefix${bind_count}-${(q)widget} ${${(s.:.)widgets[$widget]}[2,3]}"
|
eval "zle -C $prefix$bind_count-${(q)widget} ${${(s.:.)widgets[$widget]}[2,3]}"
|
||||||
;;
|
;;
|
||||||
esac
|
esac
|
||||||
|
|
||||||
_zsh_autosuggest_get_bind_count $widget
|
|
||||||
|
|
||||||
# Pass the original widget's name explicitly into the autosuggest
|
# Pass the original widget's name explicitly into the autosuggest
|
||||||
# function. Use this passed in widget name to call the original
|
# function. Use this passed in widget name to call the original
|
||||||
# widget instead of relying on the $WIDGET variable being set
|
# widget instead of relying on the $WIDGET variable being set
|
||||||
@@ -206,11 +190,13 @@ _zsh_autosuggest_bind_widget() {
|
|||||||
}"
|
}"
|
||||||
|
|
||||||
# Create the bound widget
|
# Create the bound widget
|
||||||
zle -N $widget _zsh_autosuggest_bound_${bind_count}_$widget
|
zle -N -- $widget _zsh_autosuggest_bound_${bind_count}_$widget
|
||||||
}
|
}
|
||||||
|
|
||||||
# Map all configured widgets to the right autosuggest widgets
|
# Map all configured widgets to the right autosuggest widgets
|
||||||
_zsh_autosuggest_bind_widgets() {
|
_zsh_autosuggest_bind_widgets() {
|
||||||
|
emulate -L zsh
|
||||||
|
|
||||||
local widget
|
local widget
|
||||||
local ignore_widgets
|
local ignore_widgets
|
||||||
|
|
||||||
@@ -334,6 +320,8 @@ _zsh_autosuggest_modify() {
|
|||||||
_zsh_autosuggest_invoke_original_widget $@
|
_zsh_autosuggest_invoke_original_widget $@
|
||||||
retval=$?
|
retval=$?
|
||||||
|
|
||||||
|
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"
|
||||||
@@ -364,7 +352,7 @@ _zsh_autosuggest_modify() {
|
|||||||
|
|
||||||
# Get a new suggestion if the buffer is not empty after modification
|
# Get a new suggestion if the buffer is not empty after modification
|
||||||
if (( $#BUFFER > 0 )); then
|
if (( $#BUFFER > 0 )); then
|
||||||
if [[ -z "$ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE" ]] || (( $#BUFFER <= $ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE )); then
|
if (( ! ${+ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE} )) || (( $#BUFFER <= $ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE )); then
|
||||||
_zsh_autosuggest_fetch
|
_zsh_autosuggest_fetch
|
||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
@@ -374,17 +362,19 @@ _zsh_autosuggest_modify() {
|
|||||||
|
|
||||||
# Fetch a new suggestion based on what's currently in the buffer
|
# Fetch a new suggestion based on what's currently in the buffer
|
||||||
_zsh_autosuggest_fetch() {
|
_zsh_autosuggest_fetch() {
|
||||||
if zpty -t "$ZSH_AUTOSUGGEST_ASYNC_PTY_NAME" &>/dev/null; then
|
if (( ${+ZSH_AUTOSUGGEST_USE_ASYNC} )); then
|
||||||
_zsh_autosuggest_async_request "$BUFFER"
|
_zsh_autosuggest_async_request "$BUFFER"
|
||||||
else
|
else
|
||||||
local suggestion
|
local suggestion
|
||||||
_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY "$BUFFER"
|
_zsh_autosuggest_fetch_suggestion "$BUFFER"
|
||||||
_zsh_autosuggest_suggest "$suggestion"
|
_zsh_autosuggest_suggest "$suggestion"
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# Offer a suggestion
|
# Offer a suggestion
|
||||||
_zsh_autosuggest_suggest() {
|
_zsh_autosuggest_suggest() {
|
||||||
|
emulate -L zsh
|
||||||
|
|
||||||
local suggestion="$1"
|
local suggestion="$1"
|
||||||
|
|
||||||
if [[ -n "$suggestion" ]] && (( $#BUFFER )); then
|
if [[ -n "$suggestion" ]] && (( $#BUFFER )); then
|
||||||
@@ -467,7 +457,9 @@ _zsh_autosuggest_partial_accept() {
|
|||||||
return $retval
|
return $retval
|
||||||
}
|
}
|
||||||
|
|
||||||
for action in clear modify fetch suggest accept partial_accept execute enable disable toggle; do
|
() {
|
||||||
|
local action
|
||||||
|
for action in clear modify fetch suggest accept partial_accept execute enable disable toggle; do
|
||||||
eval "_zsh_autosuggest_widget_$action() {
|
eval "_zsh_autosuggest_widget_$action() {
|
||||||
local -i retval
|
local -i retval
|
||||||
|
|
||||||
@@ -482,25 +474,26 @@ for action in clear modify fetch suggest accept partial_accept execute enable di
|
|||||||
|
|
||||||
return \$retval
|
return \$retval
|
||||||
}"
|
}"
|
||||||
done
|
done
|
||||||
|
|
||||||
zle -N autosuggest-fetch _zsh_autosuggest_widget_fetch
|
zle -N autosuggest-fetch _zsh_autosuggest_widget_fetch
|
||||||
zle -N autosuggest-suggest _zsh_autosuggest_widget_suggest
|
zle -N autosuggest-suggest _zsh_autosuggest_widget_suggest
|
||||||
zle -N autosuggest-accept _zsh_autosuggest_widget_accept
|
zle -N autosuggest-accept _zsh_autosuggest_widget_accept
|
||||||
zle -N autosuggest-clear _zsh_autosuggest_widget_clear
|
zle -N autosuggest-clear _zsh_autosuggest_widget_clear
|
||||||
zle -N autosuggest-execute _zsh_autosuggest_widget_execute
|
zle -N autosuggest-execute _zsh_autosuggest_widget_execute
|
||||||
zle -N autosuggest-enable _zsh_autosuggest_widget_enable
|
zle -N autosuggest-enable _zsh_autosuggest_widget_enable
|
||||||
zle -N autosuggest-disable _zsh_autosuggest_widget_disable
|
zle -N autosuggest-disable _zsh_autosuggest_widget_disable
|
||||||
zle -N autosuggest-toggle _zsh_autosuggest_widget_toggle
|
zle -N autosuggest-toggle _zsh_autosuggest_widget_toggle
|
||||||
|
}
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Default Suggestion Strategy #
|
# History Suggestion Strategy #
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Suggests the most recent history item that matches the given
|
# Suggests the most recent history item that matches the given
|
||||||
# prefix.
|
# prefix.
|
||||||
#
|
#
|
||||||
|
|
||||||
_zsh_autosuggest_strategy_default() {
|
_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
|
||||||
|
|
||||||
@@ -578,109 +571,96 @@ _zsh_autosuggest_strategy_match_prev_cmd() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Async #
|
# Fetch Suggestion #
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
|
# Loops through all specified strategies and returns a suggestion
|
||||||
|
# from the first strategy to provide one.
|
||||||
|
#
|
||||||
|
|
||||||
# Zpty process is spawned running this function
|
_zsh_autosuggest_fetch_suggestion() {
|
||||||
_zsh_autosuggest_async_server() {
|
typeset -g suggestion
|
||||||
emulate -R zsh
|
local -a strategies
|
||||||
|
local strategy
|
||||||
|
|
||||||
# There is a bug in zpty module (fixed in zsh/master) by which a
|
# Ensure we are working with an array
|
||||||
# zpty that exits will kill all zpty processes that were forked
|
strategies=(${=ZSH_AUTOSUGGEST_STRATEGY})
|
||||||
# before it. Here we set up a zsh exit hook to SIGKILL the zpty
|
|
||||||
# process immediately, before it has a chance to kill any other
|
|
||||||
# zpty processes.
|
|
||||||
zshexit() {
|
|
||||||
kill -KILL $$
|
|
||||||
sleep 1 # Block for long enough for the signal to come through
|
|
||||||
}
|
|
||||||
|
|
||||||
# Output only newlines (not carriage return + newline)
|
for strategy in $strategies; do
|
||||||
stty -onlcr
|
# Try to get a suggestion from this strategy
|
||||||
|
_zsh_autosuggest_strategy_$strategy "$1"
|
||||||
|
|
||||||
# Silence any error messages
|
# Break once we've found a suggestion
|
||||||
exec 2>/dev/null
|
[[ -n "$suggestion" ]] && break
|
||||||
|
|
||||||
local last_pid
|
|
||||||
|
|
||||||
while IFS='' read -r -d $'\0' query; do
|
|
||||||
# Kill last bg process
|
|
||||||
kill -KILL $last_pid &>/dev/null
|
|
||||||
|
|
||||||
# Run suggestion search in the background
|
|
||||||
(
|
|
||||||
local suggestion
|
|
||||||
_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY "$query"
|
|
||||||
echo -n -E "$suggestion"$'\0'
|
|
||||||
) &
|
|
||||||
|
|
||||||
last_pid=$!
|
|
||||||
done
|
done
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
# Async #
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
|
||||||
|
zmodload zsh/system
|
||||||
|
|
||||||
_zsh_autosuggest_async_request() {
|
_zsh_autosuggest_async_request() {
|
||||||
# Write the query to the zpty process to fetch a suggestion
|
typeset -g _ZSH_AUTOSUGGEST_ASYNC_FD _ZSH_AUTOSUGGEST_CHILD_PID
|
||||||
zpty -w -n $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME "${1}"$'\0'
|
|
||||||
|
# If we've got a pending request, cancel it
|
||||||
|
if [[ -n "$_ZSH_AUTOSUGGEST_ASYNC_FD" ]] && { true <&$_ZSH_AUTOSUGGEST_ASYNC_FD } 2>/dev/null; then
|
||||||
|
# Close the file descriptor and remove the handler
|
||||||
|
exec {_ZSH_AUTOSUGGEST_ASYNC_FD}<&-
|
||||||
|
zle -F $_ZSH_AUTOSUGGEST_ASYNC_FD
|
||||||
|
|
||||||
|
# Zsh will make a new process group for the child process only if job
|
||||||
|
# control is enabled (MONITOR option)
|
||||||
|
if [[ -o MONITOR ]]; then
|
||||||
|
# Send the signal to the process group to kill any processes that may
|
||||||
|
# have been forked by the suggestion strategy
|
||||||
|
kill -TERM -$_ZSH_AUTOSUGGEST_CHILD_PID 2>/dev/null
|
||||||
|
else
|
||||||
|
# Kill just the child process since it wasn't placed in a new process
|
||||||
|
# group. If the suggestion strategy forked any child processes they may
|
||||||
|
# be orphaned and left behind.
|
||||||
|
kill -TERM $_ZSH_AUTOSUGGEST_CHILD_PID 2>/dev/null
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Fork a process to fetch a suggestion and open a pipe to read from it
|
||||||
|
exec {_ZSH_AUTOSUGGEST_ASYNC_FD}< <(
|
||||||
|
# Tell parent process our pid
|
||||||
|
echo $sysparams[pid]
|
||||||
|
|
||||||
|
# Fetch and print the suggestion
|
||||||
|
local suggestion
|
||||||
|
_zsh_autosuggest_fetch_suggestion "$1"
|
||||||
|
echo -nE "$suggestion"
|
||||||
|
)
|
||||||
|
|
||||||
|
# There's a weird bug here where ^C stops working unless we force a fork
|
||||||
|
# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
|
||||||
|
command true
|
||||||
|
|
||||||
|
# Read the pid from the child process
|
||||||
|
read _ZSH_AUTOSUGGEST_CHILD_PID <&$_ZSH_AUTOSUGGEST_ASYNC_FD
|
||||||
|
|
||||||
|
# When the fd is readable, call the response handler
|
||||||
|
zle -F "$_ZSH_AUTOSUGGEST_ASYNC_FD" _zsh_autosuggest_async_response
|
||||||
}
|
}
|
||||||
|
|
||||||
# Called when new data is ready to be read from the pty
|
# Called when new data is ready to be read from the pipe
|
||||||
# First arg will be fd ready for reading
|
# First arg will be fd ready for reading
|
||||||
# Second arg will be passed in case of error
|
# Second arg will be passed in case of error
|
||||||
_zsh_autosuggest_async_response() {
|
_zsh_autosuggest_async_response() {
|
||||||
setopt LOCAL_OPTIONS EXTENDED_GLOB
|
emulate -L zsh
|
||||||
|
|
||||||
local suggestion
|
if [[ -z "$2" || "$2" == "hup" ]]; then
|
||||||
|
# Read everything from the fd and give it as a suggestion
|
||||||
|
zle autosuggest-suggest -- "$(cat <&$1)"
|
||||||
|
|
||||||
zpty -rt $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME suggestion '*'$'\0' 2>/dev/null
|
# Close the fd
|
||||||
zle autosuggest-suggest -- "${suggestion%%$'\0'##}"
|
exec {1}<&-
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_async_pty_create() {
|
|
||||||
# With newer versions of zsh, REPLY stores the fd to read from
|
|
||||||
typeset -h REPLY
|
|
||||||
|
|
||||||
# If we won't get a fd back from zpty, try to guess it
|
|
||||||
if (( ! $_ZSH_AUTOSUGGEST_ZPTY_RETURNS_FD )); then
|
|
||||||
integer -l zptyfd
|
|
||||||
exec {zptyfd}>&1 # Open a new file descriptor (above 10).
|
|
||||||
exec {zptyfd}>&- # Close it so it's free to be used by zpty.
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Fork a zpty process running the server function
|
# Always remove the handler
|
||||||
zpty -b $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME _zsh_autosuggest_async_server
|
zle -F "$1"
|
||||||
|
|
||||||
# Store the fd so we can remove the handler later
|
|
||||||
if (( REPLY )); then
|
|
||||||
_ZSH_AUTOSUGGEST_PTY_FD=$REPLY
|
|
||||||
else
|
|
||||||
_ZSH_AUTOSUGGEST_PTY_FD=$zptyfd
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Set up input handler from the zpty
|
|
||||||
zle -F $_ZSH_AUTOSUGGEST_PTY_FD _zsh_autosuggest_async_response
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_async_pty_destroy() {
|
|
||||||
# Remove the input handler
|
|
||||||
zle -F $_ZSH_AUTOSUGGEST_PTY_FD &>/dev/null
|
|
||||||
|
|
||||||
# Destroy the zpty
|
|
||||||
zpty -d $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME &>/dev/null
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_async_pty_recreate() {
|
|
||||||
_zsh_autosuggest_async_pty_destroy
|
|
||||||
_zsh_autosuggest_async_pty_create
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_async_start() {
|
|
||||||
typeset -g _ZSH_AUTOSUGGEST_PTY_FD
|
|
||||||
|
|
||||||
_zsh_autosuggest_feature_detect_zpty_returns_fd
|
|
||||||
_zsh_autosuggest_async_pty_recreate
|
|
||||||
|
|
||||||
# We recreate the pty to get a fresh list of history events
|
|
||||||
add-zsh-hook precmd _zsh_autosuggest_async_pty_recreate
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
@@ -689,19 +669,17 @@ _zsh_autosuggest_async_start() {
|
|||||||
|
|
||||||
# Start the autosuggestion widgets
|
# Start the autosuggestion widgets
|
||||||
_zsh_autosuggest_start() {
|
_zsh_autosuggest_start() {
|
||||||
|
# By default we re-bind widgets on every precmd to ensure we wrap other
|
||||||
|
# wrappers. Specifically, highlighting breaks if our widgets are wrapped by
|
||||||
|
# zsh-syntax-highlighting widgets. This also allows modifications to the
|
||||||
|
# widget list variables to take effect on the next precmd. However this has
|
||||||
|
# a decent performance hit, so users can set ZSH_AUTOSUGGEST_MANUAL_REBIND
|
||||||
|
# to disable the automatic re-binding.
|
||||||
|
if (( ${+ZSH_AUTOSUGGEST_MANUAL_REBIND} )); then
|
||||||
add-zsh-hook -d precmd _zsh_autosuggest_start
|
add-zsh-hook -d precmd _zsh_autosuggest_start
|
||||||
|
fi
|
||||||
|
|
||||||
_zsh_autosuggest_bind_widgets
|
_zsh_autosuggest_bind_widgets
|
||||||
|
|
||||||
# Re-bind widgets on every precmd to ensure we wrap other wrappers.
|
|
||||||
# Specifically, highlighting breaks if our widgets are wrapped by
|
|
||||||
# zsh-syntax-highlighting widgets. This also allows modifications
|
|
||||||
# to the widget list variables to take effect on the next precmd.
|
|
||||||
add-zsh-hook precmd _zsh_autosuggest_bind_widgets
|
|
||||||
|
|
||||||
if [[ -n "${ZSH_AUTOSUGGEST_USE_ASYNC+x}" ]]; then
|
|
||||||
_zsh_autosuggest_async_start
|
|
||||||
fi
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Start the autosuggestion widgets on the next precmd
|
# Start the autosuggestion widgets on the next precmd
|
||||||
|
|||||||
Reference in New Issue
Block a user