mirror of
https://github.com/zsh-users/zsh-autosuggestions.git
synced 2025-06-05 12:36:28 +08:00
Compare commits
No commits in common. "master" and "v0.4.2" have entirely different histories.
36
.github/ISSUE_TEMPLATE/bug-report.md
vendored
36
.github/ISSUE_TEMPLATE/bug-report.md
vendored
@ -1,36 +0,0 @@
|
|||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
title: ''
|
|
||||||
labels: bug
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Describe the bug
|
|
||||||
<!-- A clear and concise description of what the bug is. -->
|
|
||||||
|
|
||||||
### To Reproduce
|
|
||||||
Steps to reproduce the behavior:
|
|
||||||
|
|
||||||
<!-- If you are not able to reproduce it by running `zsh -df` and sourcing the plugin manually, it means there that the issue is caused by something in your local config file(s). Temporarily comment out or remove sections of your config and restart `zsh` until you narrow down exactly what is causing the issue. -->
|
|
||||||
|
|
||||||
```sh
|
|
||||||
% zsh -df
|
|
||||||
% source path/to/zsh-autosuggestions.zsh
|
|
||||||
% ... # what do you do to reproduce?
|
|
||||||
```
|
|
||||||
|
|
||||||
### Expected behavior
|
|
||||||
<!-- A clear and concise description of what you expected to happen. -->
|
|
||||||
|
|
||||||
### Screenshots
|
|
||||||
<!-- If applicable, add screenshots to help explain your problem. -->
|
|
||||||
|
|
||||||
### Desktop
|
|
||||||
- OS + distribution: <!-- e.g. Arch Linux 2019.07.01 -->
|
|
||||||
- Zsh version: <!-- `echo $ZSH_VERSION` -->
|
|
||||||
- Plugin version: <!-- or git commit hash if installed via git -->
|
|
||||||
|
|
||||||
### Additional context
|
|
||||||
<!-- Add any other context about the problem here. -->
|
|
||||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
name: Feature request
|
|
||||||
about: Suggest an idea for this project
|
|
||||||
title: ''
|
|
||||||
labels: enhancement
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### Is your feature request related to a problem? Please describe.
|
|
||||||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
|
||||||
|
|
||||||
### Describe the solution you'd like
|
|
||||||
<!-- A clear and concise description of what you want to happen. -->
|
|
||||||
|
|
||||||
### Describe alternatives you've considered
|
|
||||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
|
||||||
|
|
||||||
### Additional context
|
|
||||||
<!-- Add any other context or screenshots about the feature request here. -->
|
|
||||||
51
.github/workflows/integration.yml
vendored
51
.github/workflows/integration.yml
vendored
@ -1,51 +0,0 @@
|
|||||||
on: [push, pull_request]
|
|
||||||
concurrency:
|
|
||||||
group: ${{ github.workflow }}-${{ github.ref }}
|
|
||||||
cancel-in-progress: true
|
|
||||||
env:
|
|
||||||
IMAGE_CACHE_PATH: /tmp/.image-cache
|
|
||||||
IMAGE_CACHE_NAME: zsh-autosuggestions-test
|
|
||||||
jobs:
|
|
||||||
determine-versions:
|
|
||||||
runs-on: ubuntu-22.04
|
|
||||||
outputs:
|
|
||||||
versions: ${{ steps.set-versions.outputs.versions }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- id: set-versions
|
|
||||||
run: |
|
|
||||||
echo "versions=$(
|
|
||||||
grep "^[^#]" ZSH_VERSIONS \
|
|
||||||
| sed -E 's/(^|$)/"/g' \
|
|
||||||
| paste -sd ',' - \
|
|
||||||
| sed -e 's/^/[/' -e 's/$/]/'
|
|
||||||
)" >> $GITHUB_OUTPUT
|
|
||||||
test:
|
|
||||||
needs: determine-versions
|
|
||||||
runs-on: ubuntu-22.04
|
|
||||||
strategy:
|
|
||||||
matrix:
|
|
||||||
version: ${{ fromJson(needs.determine-versions.outputs.versions) }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
- name: Docker image cache
|
|
||||||
id: image-cache
|
|
||||||
uses: actions/cache@v3
|
|
||||||
with:
|
|
||||||
path: ${{ env.IMAGE_CACHE_PATH }}
|
|
||||||
key: image-cache-${{ matrix.version }}-${{ hashFiles('Dockerfile', 'install_test_zsh.sh', 'Gemfile.lock') }}
|
|
||||||
- name: Load cached docker image if available
|
|
||||||
if: ${{ steps.image-cache.outputs.cache-hit }}
|
|
||||||
run: gunzip < $IMAGE_CACHE_PATH/$IMAGE_CACHE_NAME.tar.gz | docker load
|
|
||||||
- name: Build the docker image if necessary
|
|
||||||
if: ${{ !steps.image-cache.outputs.cache-hit }}
|
|
||||||
run: |
|
|
||||||
docker build --build-arg TEST_ZSH_VERSION=${{ matrix.version }} -t $IMAGE_CACHE_NAME .
|
|
||||||
mkdir -p $IMAGE_CACHE_PATH
|
|
||||||
docker save $IMAGE_CACHE_NAME | gzip > $IMAGE_CACHE_PATH/$IMAGE_CACHE_NAME.tar.gz
|
|
||||||
- name: Run the tests
|
|
||||||
run: |
|
|
||||||
docker run --rm \
|
|
||||||
-v $PWD:/zsh-autosuggestions \
|
|
||||||
$IMAGE_CACHE_NAME \
|
|
||||||
make test
|
|
||||||
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,2 +0,0 @@
|
|||||||
# zsh word code files
|
|
||||||
*.zwc
|
|
||||||
@ -1 +1 @@
|
|||||||
2.5.3
|
2.3.1
|
||||||
|
|||||||
66
CHANGELOG.md
66
CHANGELOG.md
@ -1,69 +1,5 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
## v0.7.1
|
|
||||||
- Clear POSTDISPLAY instead of unsetting (#634)
|
|
||||||
- Always reset async file descriptor after consuming it (#630)
|
|
||||||
- Always use builtin `exec` (#628)
|
|
||||||
- Add `history-beginning-search-*-end` widgets to clear widget list (#619)
|
|
||||||
- Switch CI from Circle CI to GitHub Actions
|
|
||||||
|
|
||||||
## v0.7.0
|
|
||||||
- Enable asynchronous mode by default (#498)
|
|
||||||
- No longer wrap user widgets starting with `autosuggest-` prefix (#496)
|
|
||||||
- Fix a bug wrapping widgets that modify the buffer (#541)
|
|
||||||
|
|
||||||
|
|
||||||
## v0.6.4
|
|
||||||
- Fix `vi-forward-char` triggering a bell when using it to accept a suggestion (#488)
|
|
||||||
- New configuration option to skip completion suggestions when buffer matches a pattern (#487)
|
|
||||||
- New configuration option to ignore history entries matching a pattern (#456)
|
|
||||||
|
|
||||||
## v0.6.3
|
|
||||||
- Fixed bug moving cursor to end of buffer after accepting suggestion (#453)
|
|
||||||
|
|
||||||
## v0.6.2
|
|
||||||
- Fixed bug deleting the last character in the buffer in vi mode (#450)
|
|
||||||
- Degrade gracefully when user doesn't have `zsh/system` module installed (#447)
|
|
||||||
|
|
||||||
## v0.6.1
|
|
||||||
- Fixed bug occurring when `_complete` had been aliased (#443)
|
|
||||||
|
|
||||||
## v0.6.0
|
|
||||||
- Added `completion` suggestion strategy powered by completion system (#111)
|
|
||||||
- Allow setting `ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE` to an empty string (#422)
|
|
||||||
- Don't fetch suggestions after copy-earlier-word (#439)
|
|
||||||
- Allow users to unignore zle-\* widgets (e.g. zle-line-init) (#432)
|
|
||||||
|
|
||||||
|
|
||||||
## 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
|
|
||||||
- Avoid bell when accepting suggestions with `autosuggest-accept` (#228)
|
|
||||||
- Don't fetch suggestions after [up,down]-line-or-beginning-search (#227, #241)
|
|
||||||
- We are now running CI against new 5.5.1 version
|
|
||||||
- Fix partial-accept in vi mode (#188)
|
|
||||||
- Fix suggestion disappearing on fast movement after switching to `vicmd` mode (#290)
|
|
||||||
- Fix issue rotating through kill ring with `yank-pop` (#301)
|
|
||||||
- Fix issue creating new pty for async mode when previous pty is not properly cleaned up (#249)
|
|
||||||
|
|
||||||
## v0.4.2
|
## v0.4.2
|
||||||
- Fix bug in zsh versions older than 5.0.8 (#296)
|
- Fix bug in zsh versions older than 5.0.8 (#296)
|
||||||
- Officially support back to zsh v4.3.11
|
- Officially support back to zsh v4.3.11
|
||||||
@ -81,7 +17,7 @@
|
|||||||
- Experimental support for asynchronous suggestions (#170)
|
- Experimental support for asynchronous suggestions (#170)
|
||||||
- Fix problems with multi-line suggestions (#225)
|
- Fix problems with multi-line suggestions (#225)
|
||||||
- Optimize case where manually typing in suggestion
|
- Optimize case where manually typing in suggestion
|
||||||
- Avoid wrapping any zle-\* widgets (#206)
|
- Avoid wrapping any zle-* widgets (#206)
|
||||||
- Remove support for deprecated options from v0.0.x
|
- Remove support for deprecated options from v0.0.x
|
||||||
- Handle history entries that begin with dashes
|
- Handle history entries that begin with dashes
|
||||||
- Gracefully handle being sourced multiple times (#126)
|
- Gracefully handle being sourced multiple times (#126)
|
||||||
|
|||||||
21
Dockerfile
21
Dockerfile
@ -1,21 +0,0 @@
|
|||||||
FROM ruby:2.5.3-alpine
|
|
||||||
|
|
||||||
ARG TEST_ZSH_VERSION
|
|
||||||
RUN : "${TEST_ZSH_VERSION:?}"
|
|
||||||
|
|
||||||
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 install_test_zsh.sh ./
|
|
||||||
RUN ./install_test_zsh.sh
|
|
||||||
|
|
||||||
ADD Gemfile Gemfile.lock ./
|
|
||||||
RUN bundle install
|
|
||||||
81
INSTALL.md
81
INSTALL.md
@ -1,81 +0,0 @@
|
|||||||
# Installation
|
|
||||||
|
|
||||||
* [Packages](#packages)
|
|
||||||
* [Antigen](#antigen)
|
|
||||||
* [Oh My Zsh](#oh-my-zsh)
|
|
||||||
* [HomeBrew](#homebrew)
|
|
||||||
* [Manual](#manual-git-clone)
|
|
||||||
|
|
||||||
## Packages
|
|
||||||
|
|
||||||
| System | Package |
|
|
||||||
| ------------- | ------------- |
|
|
||||||
| Alpine Linux | [zsh-autosuggestions](https://pkgs.alpinelinux.org/packages?name=zsh-autosuggestions) |
|
|
||||||
| Debian / Ubuntu | [zsh-autosuggestions OBS repository](https://software.opensuse.org/download.html?project=shells%3Azsh-users%3Azsh-autosuggestions&package=zsh-autosuggestions) |
|
|
||||||
| Fedora / CentOS / RHEL / Scientific Linux | [zsh-autosuggestions OBS repository](https://software.opensuse.org/download.html?project=shells%3Azsh-users%3Azsh-autosuggestions&package=zsh-autosuggestions) |
|
|
||||||
| OpenSUSE / SLE | [zsh-autosuggestions OBS repository](https://software.opensuse.org/download.html?project=shells%3Azsh-users%3Azsh-autosuggestions&package=zsh-autosuggestions) |
|
|
||||||
| Arch Linux / Manjaro / Antergos / Hyperbola | [zsh-autosuggestions](https://www.archlinux.org/packages/zsh-autosuggestions), [zsh-autosuggestions-git](https://aur.archlinux.org/packages/zsh-autosuggestions-git) |
|
|
||||||
| NixOS | [zsh-autosuggestions](https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/zs/zsh-autosuggestions/package.nix) |
|
|
||||||
| Void Linux | [zsh-autosuggestions](https://github.com/void-linux/void-packages/blob/master/srcpkgs/zsh-autosuggestions/template) |
|
|
||||||
| Mac OS | [homebrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/z/zsh-autosuggestions.rb) |
|
|
||||||
| NetBSD | [pkgsrc](http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/shells/zsh-autosuggestions/README.html) |
|
|
||||||
|
|
||||||
## Antigen
|
|
||||||
|
|
||||||
1. Add the following to your `.zshrc`:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
antigen bundle zsh-users/zsh-autosuggestions
|
|
||||||
```
|
|
||||||
|
|
||||||
2. 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 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 (inside `~/.zshrc`):
|
|
||||||
|
|
||||||
```sh
|
|
||||||
plugins=(
|
|
||||||
# other plugins...
|
|
||||||
zsh-autosuggestions
|
|
||||||
)
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Start a new terminal session.
|
|
||||||
|
|
||||||
## Homebrew
|
|
||||||
|
|
||||||
1. Install command:
|
|
||||||
```sh
|
|
||||||
brew install zsh-autosuggestions
|
|
||||||
```
|
|
||||||
|
|
||||||
2. To activate the autosuggestions, add the following at the end of your .zshrc:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
source $(brew --prefix)/share/zsh-autosuggestions/zsh-autosuggestions.zsh
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Start a new terminal session.
|
|
||||||
|
|
||||||
## Manual (Git Clone)
|
|
||||||
|
|
||||||
1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`.
|
|
||||||
|
|
||||||
```sh
|
|
||||||
git clone https://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.
|
|
||||||
2
LICENSE
2
LICENSE
@ -1,5 +1,5 @@
|
|||||||
Copyright (c) 2013 Thiago de Arruda
|
Copyright (c) 2013 Thiago de Arruda
|
||||||
Copyright (c) 2016-2021 Eric Freese
|
Copyright (c) 2016-2017 Eric Freese
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person
|
Permission is hereby granted, free of charge, to any person
|
||||||
obtaining a copy of this software and associated documentation
|
obtaining a copy of this software and associated documentation
|
||||||
|
|||||||
3
Makefile
3
Makefile
@ -1,13 +1,14 @@
|
|||||||
SRC_DIR := ./src
|
SRC_DIR := ./src
|
||||||
|
|
||||||
SRC_FILES := \
|
SRC_FILES := \
|
||||||
|
$(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
|
||||||
|
|
||||||
|
|||||||
136
README.md
136
README.md
@ -2,19 +2,83 @@
|
|||||||
|
|
||||||
_[Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh._
|
_[Fish](http://fishshell.com/)-like fast/unobtrusive autosuggestions for zsh._
|
||||||
|
|
||||||
It suggests commands as you type based on history and completions.
|
It suggests commands as you type, based on command history.
|
||||||
|
|
||||||
Requirements: Zsh v4.3.11 or later
|
[](https://circleci.com/gh/zsh-users/zsh-autosuggestions)
|
||||||
|
|
||||||
[](https://gitter.im/zsh-users/zsh-autosuggestions)
|
|
||||||
|
|
||||||
<a href="https://asciinema.org/a/37390" target="_blank"><img src="https://asciinema.org/a/37390.png" width="400" /></a>
|
<a href="https://asciinema.org/a/37390" target="_blank"><img src="https://asciinema.org/a/37390.png" width="400" /></a>
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
See [INSTALL.md](INSTALL.md).
|
Requirements: Zsh v4.3.11 or later
|
||||||
|
|
||||||
|
### Manual
|
||||||
|
|
||||||
|
1. Clone this repository somewhere on your machine. This guide will assume `~/.zsh/zsh-autosuggestions`.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://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 https://github.com/zsh-users/zsh-autosuggestions $ZSH_CUSTOM/plugins/zsh-autosuggestions
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Add the plugin to the list of plugins for Oh My Zsh to load:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
plugins=(zsh-autosuggestions)
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Start a new terminal session.
|
||||||
|
|
||||||
|
### Arch Linux via the AUR
|
||||||
|
1. Install the [`zsh-autosuggestions`](https://aur.archlinux.org/packages/zsh-autosuggestions/) or the [`zsh-autosuggestions-git`](https://aur.archlinux.org/packages/zsh-autosuggestions-git/) packages from the [AUR](https://wiki.archlinux.org/index.php/Arch_User_Repository).
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pacaur -S zsh-autosuggestions
|
||||||
|
```
|
||||||
|
or
|
||||||
|
```
|
||||||
|
pacaur -S zsh-autosuggestions-git
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Add the following to your `.zshrc`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
source /usr/share/zsh/plugins/zsh-autosuggestions/zsh-autosuggestions.zsh
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Start a new terminal session.
|
||||||
|
|
||||||
|
### macOS via Homebrew
|
||||||
|
1. Install the `zsh-autosuggestions` package using [Homebrew](https://brew.sh/).
|
||||||
|
|
||||||
|
```sh
|
||||||
|
brew install zsh-autosuggestions
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Add the following to your `.zshrc`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
source /usr/local/share/zsh-autosuggestions/zsh-autosuggestions.zsh
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Start a new terminal session.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -27,35 +91,22 @@ 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. Default values of these variables can be found [here](src/config.zsh).
|
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).
|
**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
|
### Suggestion Highlight Style
|
||||||
|
|
||||||
Set `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` to configure the style that the suggestion is shown with. The default is `fg=8`, which will set the foreground color to color 8 from the [256-color palette](https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg). If your terminal only supports 8 colors, you will need to use a number between 0 and 7.
|
Set `ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE` to configure the style that the suggestion is shown with. The default is `fg=8`.
|
||||||
|
|
||||||
Background color can also be set, and the suggestion can be styled bold, underlined, or standout. For example, this would show suggestions with bold, underlined, pink text on a cyan background:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE="fg=#ff00ff,bg=cyan,bold,underline"
|
|
||||||
```
|
|
||||||
|
|
||||||
For more info, read the Character Highlighting section of the zsh manual: `man zshzle` or [online](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting).
|
|
||||||
|
|
||||||
**Note:** Some iTerm2 users have reported [not being able to see the suggestions](https://github.com/zsh-users/zsh-autosuggestions/issues/416#issuecomment-486516333). If this affects you, the problem is likely caused by incorrect color settings. In order to correct this, go into iTerm2's setting, navigate to profile > colors and make sure that the colors for Basic Colors > Background and ANSI Colors > Bright Black are **different**.
|
|
||||||
|
|
||||||
|
|
||||||
### Suggestion Strategy
|
### Suggestion Strategy
|
||||||
|
|
||||||
`ZSH_AUTOSUGGEST_STRATEGY` is an array that specifies how suggestions should be generated. The strategies in the array are tried successively until a suggestion is found. There are currently three built-in strategies to choose from:
|
Set `ZSH_AUTOSUGGEST_STRATEGY` to choose the strategy for generating suggestions. There are currently two to choose from:
|
||||||
|
|
||||||
- `history`: Chooses the most recent match from history.
|
- `default`: Chooses the most recent match.
|
||||||
- `completion`: Chooses a suggestion based on what tab-completion would suggest. (requires `zpty` module, which is included with zsh since 4.0.1)
|
- `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`.
|
|
||||||
|
|
||||||
For example, setting `ZSH_AUTOSUGGEST_STRATEGY=(history completion)` will first try to find a suggestion from your history, but, if it can't find a match, will find a suggestion from the completion engine.
|
|
||||||
|
|
||||||
|
|
||||||
### Widget Mapping
|
### Widget Mapping
|
||||||
@ -76,29 +127,11 @@ 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 strings that are too long.
|
This can be useful when pasting large amount of text in the terminal, to avoid triggering autosuggestion for too long strings.
|
||||||
|
|
||||||
### Asynchronous Mode
|
### Enable Asynchronous Mode
|
||||||
|
|
||||||
Suggestions are fetched asynchronously by default in zsh versions 5.0.8 and greater. To disable asynchronous suggestions and fetch them synchronously instead, `unset ZSH_AUTOSUGGEST_USE_ASYNC` after sourcing the plugin.
|
As of `v0.4.0`, suggestions can be fetched asynchronously using the `zsh/zpty` module. To enable this behavior, set the `ZSH_AUTOSUGGEST_USE_ASYNC` variable (it can be set to anything).
|
||||||
|
|
||||||
Alternatively, if you are using a version of zsh older than 5.0.8 and want to enable asynchronous mode, set the `ZSH_AUTOSUGGEST_USE_ASYNC` variable after sourcing the plugin (it can be set to anything). Note that there is [a bug](https://github.com/zsh-users/zsh-autosuggestions/issues/364#issuecomment-481423232) in versions of zsh older than 5.0.8 where <kbd>ctrl</kbd> + <kbd>c</kbd> will fail to reset the prompt immediately after fetching a suggestion asynchronously.
|
|
||||||
|
|
||||||
### Disabling automatic widget re-binding
|
|
||||||
|
|
||||||
Set `ZSH_AUTOSUGGEST_MANUAL_REBIND` (it can be set to anything) to disable automatic widget re-binding on each precmd. This can be a big boost to performance, but you'll need to handle re-binding yourself if any of the widget lists change or if you or another plugin wrap any of the autosuggest widgets. To re-bind widgets, run `_zsh_autosuggest_bind_widgets`.
|
|
||||||
|
|
||||||
### Ignoring history suggestions that match a pattern
|
|
||||||
|
|
||||||
Set `ZSH_AUTOSUGGEST_HISTORY_IGNORE` to a [glob pattern](http://zsh.sourceforge.net/Doc/Release/Expansion.html#Glob-Operators) to prevent offering suggestions for history entries that match the pattern. For example, set it to `"cd *"` to never suggest any `cd` commands from history. Or set to `"?(#c50,)"` to never suggest anything 50 characters or longer.
|
|
||||||
|
|
||||||
**Note:** This only affects the `history` and `match_prev_cmd` suggestion strategies.
|
|
||||||
|
|
||||||
### Skipping completion suggestions for certain cases
|
|
||||||
|
|
||||||
Set `ZSH_AUTOSUGGEST_COMPLETION_IGNORE` to a [glob pattern](http://zsh.sourceforge.net/Doc/Release/Expansion.html#Glob-Operators) to prevent offering completion suggestions when the buffer matches that pattern. For example, set it to `"git *"` to disable completion suggestions for git subcommands.
|
|
||||||
|
|
||||||
**Note:** This only affects the `completion` suggestion strategy.
|
|
||||||
|
|
||||||
|
|
||||||
### Key Bindings
|
### Key Bindings
|
||||||
@ -122,7 +155,8 @@ bindkey '^ ' autosuggest-accept
|
|||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
If you have a problem, please search through [the list of issues on GitHub](https://github.com/zsh-users/zsh-autosuggestions/issues?q=) to see if someone else has already reported it.
|
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
|
### Reporting an Issue
|
||||||
|
|
||||||
@ -169,18 +203,6 @@ 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`).
|
||||||
|
|
||||||
It's possible to run the tests for any supported version of zsh in a Docker image by building an image from the provided Dockerfile. To build the docker image for a specific version of zsh (where `<version>` below is substituted with the contents of a line from the [`ZSH_VERSIONS`](ZSH_VERSIONS) file), run:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
docker build --build-arg TEST_ZSH_VERSION=<version> -t zsh-autosuggestions-test .
|
|
||||||
```
|
|
||||||
|
|
||||||
After building the image, run the tests via:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
docker run -it -v $PWD:/zsh-autosuggestions zsh-autosuggestions-test make test
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
14
ZSH_VERSIONS
14
ZSH_VERSIONS
@ -1,14 +0,0 @@
|
|||||||
# Zsh releases to run tests against
|
|
||||||
# See https://github.com/zsh-users/zsh/releases
|
|
||||||
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
|
|
||||||
5.8.1
|
|
||||||
5.9
|
|
||||||
12
circle.yml
Normal file
12
circle.yml
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
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
|
||||||
|
|
||||||
|
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
|
||||||
@ -1,23 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
|
|
||||||
set -ex
|
|
||||||
|
|
||||||
mkdir zsh-build
|
|
||||||
cd zsh-build
|
|
||||||
|
|
||||||
curl -L https://api.github.com/repos/zsh-users/zsh/tarball/zsh-$TEST_ZSH_VERSION | tar xz --strip=1
|
|
||||||
|
|
||||||
./Util/preconfig
|
|
||||||
./configure --enable-pcre \
|
|
||||||
--enable-cap \
|
|
||||||
--enable-multibyte \
|
|
||||||
--with-term-lib='ncursesw tinfo' \
|
|
||||||
--with-tcsetpgrp
|
|
||||||
|
|
||||||
make install.bin
|
|
||||||
make install.modules
|
|
||||||
make install.fns
|
|
||||||
|
|
||||||
cd ..
|
|
||||||
|
|
||||||
rm -rf zsh-build
|
|
||||||
@ -1,70 +0,0 @@
|
|||||||
context 'with asynchronous suggestions enabled' do
|
|
||||||
let(:options) { ["ZSH_AUTOSUGGEST_USE_ASYNC="] }
|
|
||||||
|
|
||||||
describe '`up-line-or-beginning-search`' do
|
|
||||||
let(:before_sourcing) do
|
|
||||||
-> do
|
|
||||||
session.
|
|
||||||
run_command('autoload -U up-line-or-beginning-search').
|
|
||||||
run_command('zle -N up-line-or-beginning-search').
|
|
||||||
send_string('bindkey "').
|
|
||||||
send_keys('C-v').send_keys('up').
|
|
||||||
send_string('" up-line-or-beginning-search').
|
|
||||||
send_keys('enter')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'should show previous history entries' do
|
|
||||||
with_history(
|
|
||||||
'echo foo',
|
|
||||||
'echo bar',
|
|
||||||
'echo baz'
|
|
||||||
) do
|
|
||||||
session.clear_screen
|
|
||||||
3.times { session.send_keys('up') }
|
|
||||||
wait_for { session.content }.to eq("echo foo")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '`copy-earlier-word`' do
|
|
||||||
let(:before_sourcing) do
|
|
||||||
-> do
|
|
||||||
session.
|
|
||||||
run_command('autoload -Uz copy-earlier-word').
|
|
||||||
run_command('zle -N copy-earlier-word').
|
|
||||||
run_command('bindkey "^N" copy-earlier-word')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'should cycle through previous words in the buffer' do
|
|
||||||
session.clear_screen
|
|
||||||
session.send_string('foo bar baz')
|
|
||||||
sleep 0.5
|
|
||||||
session.send_keys('C-n')
|
|
||||||
wait_for { session.content }.to eq('foo bar bazbaz')
|
|
||||||
session.send_keys('C-n')
|
|
||||||
wait_for { session.content }.to eq('foo bar bazbar')
|
|
||||||
session.send_keys('C-n')
|
|
||||||
wait_for { session.content }.to eq('foo bar bazfoo')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe 'pressing ^C after fetching a suggestion' do
|
|
||||||
before do
|
|
||||||
skip 'Workaround does not work below v5.0.8' if session.zsh_version < Gem::Version.new('5.0.8')
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'terminates the prompt and begins a new one' do
|
|
||||||
session.send_keys('e')
|
|
||||||
sleep 0.5
|
|
||||||
session.send_keys('C-c')
|
|
||||||
sleep 0.5
|
|
||||||
session.send_keys('echo')
|
|
||||||
|
|
||||||
wait_for { session.content }.to eq("e\necho")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
@ -1,14 +0,0 @@
|
|||||||
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
|
|
||||||
@ -24,20 +24,4 @@ describe 'pasting using bracketed-paste-magic' do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'with `bracketed-paste` added to the list of widgets that clear the suggestion' do
|
|
||||||
let(:options) { ['ZSH_AUTOSUGGEST_CLEAR_WIDGETS+=(bracketed-paste)'] }
|
|
||||||
|
|
||||||
it 'does not retain an old suggestion' do
|
|
||||||
with_history ('echo foo') do
|
|
||||||
session.send_string('echo ')
|
|
||||||
wait_for { session.content }.to eq('echo foo')
|
|
||||||
session.paste_string('bar')
|
|
||||||
wait_for { session.content }.to eq('echo bar')
|
|
||||||
session.send_keys('C-a') # Any cursor movement works
|
|
||||||
sleep 1
|
|
||||||
expect(session.content).to eq('echo bar')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@ -1,14 +1,10 @@
|
|||||||
describe 'a running zpty command' do
|
describe 'a running zpty command' do
|
||||||
let(:before_sourcing) { -> { session.run_command('zmodload zsh/zpty && zpty -b kitty cat') } }
|
let(:before_sourcing) { -> { session.run_command('zmodload zsh/zpty && zpty -b kitty cat') } }
|
||||||
|
|
||||||
context 'when using `completion` strategy' do
|
it 'is not affected by running zsh-autosuggestions' do
|
||||||
let(:options) { ["ZSH_AUTOSUGGEST_STRATEGY=completion"] }
|
sleep 1 # Give a little time for precmd hooks to run
|
||||||
|
|
||||||
it 'is not affected' do
|
|
||||||
session.send_keys('a').send_keys('C-h')
|
|
||||||
session.run_command('zpty -t kitty; echo $?')
|
session.run_command('zpty -t kitty; echo $?')
|
||||||
|
|
||||||
wait_for { session.content }.to end_with("\n0")
|
wait_for { session.content }.to end_with("\n0")
|
||||||
end
|
end
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|||||||
@ -1,12 +0,0 @@
|
|||||||
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
|
|
||||||
@ -1,80 +0,0 @@
|
|||||||
describe 'when using vi mode' do
|
|
||||||
let(:before_sourcing) do
|
|
||||||
-> do
|
|
||||||
session.run_command('bindkey -v')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe 'moving the cursor after exiting insert mode' do
|
|
||||||
it 'should not clear the current suggestion' do
|
|
||||||
with_history('foobar foo') do
|
|
||||||
session.
|
|
||||||
send_string('foo').
|
|
||||||
send_keys('escape').
|
|
||||||
send_keys('h')
|
|
||||||
|
|
||||||
wait_for { session.content }.to eq('foobar foo')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '`vi-forward-word-end`' do
|
|
||||||
it 'should accept through the end of the current word' do
|
|
||||||
with_history('foobar foo') do
|
|
||||||
session.
|
|
||||||
send_string('foo').
|
|
||||||
send_keys('escape').
|
|
||||||
send_keys('e'). # vi-forward-word-end
|
|
||||||
send_keys('a'). # vi-add-next
|
|
||||||
send_string('baz')
|
|
||||||
|
|
||||||
wait_for { session.content }.to eq('foobarbaz')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '`vi-forward-word`' do
|
|
||||||
it 'should accept through the first character of the next word' do
|
|
||||||
with_history('foobar foo') do
|
|
||||||
session.
|
|
||||||
send_string('foo').
|
|
||||||
send_keys('escape').
|
|
||||||
send_keys('w'). # vi-forward-word
|
|
||||||
send_keys('a'). # vi-add-next
|
|
||||||
send_string('az')
|
|
||||||
|
|
||||||
wait_for { session.content }.to eq('foobar faz')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '`vi-find-next-char`' do
|
|
||||||
it 'should accept through the next occurrence of the character' do
|
|
||||||
with_history('foobar foo') do
|
|
||||||
session.
|
|
||||||
send_string('foo').
|
|
||||||
send_keys('escape').
|
|
||||||
send_keys('f'). # vi-find-next-char
|
|
||||||
send_keys('o').
|
|
||||||
send_keys('a'). # vi-add-next
|
|
||||||
send_string('b')
|
|
||||||
|
|
||||||
wait_for { session.content }.to eq('foobar fob')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '`vi-delete`' do
|
|
||||||
it 'should be able to remove the last character in the buffer' do
|
|
||||||
skip 'deleting last char did not work below zsh version 5.0.8' if session.zsh_version < Gem::Version.new('5.0.8')
|
|
||||||
|
|
||||||
session.
|
|
||||||
send_string('echo foo').
|
|
||||||
send_keys('escape').
|
|
||||||
send_keys('d').
|
|
||||||
send_keys('l')
|
|
||||||
|
|
||||||
wait_for { session.content }.to eq('echo fo')
|
|
||||||
end
|
|
||||||
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_history "$1" }').
|
run_command('_zsh_autosuggest_strategy_test() { sleep 1; _zsh_autosuggest_strategy_default "$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,23 +0,0 @@
|
|||||||
context 'with some items in the kill ring' do
|
|
||||||
before do
|
|
||||||
session.
|
|
||||||
send_string('echo foo').
|
|
||||||
send_keys('C-u').
|
|
||||||
send_string('echo bar').
|
|
||||||
send_keys('C-u')
|
|
||||||
end
|
|
||||||
|
|
||||||
describe '`yank-pop`' do
|
|
||||||
it 'should cycle through all items in the kill ring' do
|
|
||||||
session.send_keys('C-y')
|
|
||||||
wait_for { session.content }.to eq('echo bar')
|
|
||||||
|
|
||||||
session.send_keys('escape').send_keys('y')
|
|
||||||
wait_for { session.content }.to eq('echo foo')
|
|
||||||
|
|
||||||
session.send_keys('escape').send_keys('y')
|
|
||||||
wait_for { session.content }.to eq('echo bar')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
context 'with zle-line-init unignored' do
|
|
||||||
let(:after_sourcing) do
|
|
||||||
-> do
|
|
||||||
session.
|
|
||||||
run_command('setopt extendedglob').
|
|
||||||
run_command('ZSH_AUTOSUGGEST_IGNORE_WIDGETS=(${(@)ZSH_AUTOSUGGEST_IGNORE_WIDGETS:#zle-\*} zle-\^line-init)').
|
|
||||||
run_command('zle-line-init() { BUFFER="echo" }')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'should fetch a suggestion on each line initialization' do
|
|
||||||
with_history('echo foo') do
|
|
||||||
session.run_command('zle -N zle-line-init')
|
|
||||||
wait_for { session.content }.to end_with('echo foo')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@ -1,6 +1,11 @@
|
|||||||
describe 'a multi-line suggestion' do
|
describe 'a multi-line suggestion' do
|
||||||
it 'should be displayed on multiple lines' do
|
it 'should be displayed on multiple lines' do
|
||||||
with_history("echo \"\n\"") do
|
with_history(-> {
|
||||||
|
session.send_string('echo "')
|
||||||
|
session.send_keys('enter')
|
||||||
|
session.send_string('"')
|
||||||
|
session.send_keys('enter')
|
||||||
|
}) do
|
||||||
session.send_keys('e')
|
session.send_keys('e')
|
||||||
wait_for { session.content }.to eq("echo \"\n\"")
|
wait_for { session.content }.to eq("echo \"\n\"")
|
||||||
end
|
end
|
||||||
|
|||||||
19
spec/options/async_zpty_name_spec.rb
Normal file
19
spec/options/async_zpty_name_spec.rb
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
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,55 +1,20 @@
|
|||||||
describe 'a suggestion for a given prefix' do
|
describe 'a suggestion for a given prefix' do
|
||||||
let(:history_strategy) { '_zsh_autosuggest_strategy_history() { suggestion="history" }' }
|
let(:options) { ['_zsh_autosuggest_strategy_default() { suggestion="echo foo" }'] }
|
||||||
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" }' }
|
|
||||||
|
|
||||||
let(:after_sourcing) do
|
it 'is determined by calling the default strategy function' do
|
||||||
-> do
|
session.send_string('e')
|
||||||
session.run_command(history_strategy)
|
wait_for { session.content }.to eq('echo foo')
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'by default is determined by calling the `history` strategy function' do
|
context 'when ZSH_AUTOSUGGEST_STRATEGY is set' do
|
||||||
session.send_string('h')
|
let(:options) { [
|
||||||
wait_for { session.content }.to eq('history')
|
'_zsh_autosuggest_strategy_custom() { suggestion="echo foo" }',
|
||||||
end
|
'ZSH_AUTOSUGGEST_STRATEGY=custom'
|
||||||
|
] }
|
||||||
|
|
||||||
context 'when ZSH_AUTOSUGGEST_STRATEGY is set to an array' do
|
it 'is determined by calling the specified strategy function' do
|
||||||
let(:after_sourcing) do
|
session.send_string('e')
|
||||||
-> do
|
wait_for { session.content }.to eq('echo foo')
|
||||||
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
|
||||||
|
|
||||||
|
|||||||
7
spec/options/use_async_spec.rb
Normal file
7
spec/options/use_async_spec.rb
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
describe 'suggestion fetching' do
|
||||||
|
it 'is performed synchronously'
|
||||||
|
|
||||||
|
context 'when ZSH_AUTOSUGGEST_USE_ASYNC is set' do
|
||||||
|
it 'is performed asynchronously'
|
||||||
|
end
|
||||||
|
end
|
||||||
@ -5,13 +5,12 @@ describe 'a zle widget' do
|
|||||||
context 'when added to ZSH_AUTOSUGGEST_ACCEPT_WIDGETS' do
|
context 'when added to ZSH_AUTOSUGGEST_ACCEPT_WIDGETS' do
|
||||||
let(:options) { ["ZSH_AUTOSUGGEST_ACCEPT_WIDGETS+=(#{widget})"] }
|
let(:options) { ["ZSH_AUTOSUGGEST_ACCEPT_WIDGETS+=(#{widget})"] }
|
||||||
|
|
||||||
it 'accepts the suggestion and moves the cursor to the end of the buffer when invoked' do
|
it 'accepts the suggestion when invoked' do
|
||||||
with_history('echo hello') do
|
with_history('echo hello') do
|
||||||
session.send_string('e')
|
session.send_string('e')
|
||||||
wait_for { session.content }.to eq('echo hello')
|
wait_for { session.content }.to eq('echo hello')
|
||||||
session.send_keys('C-b')
|
session.send_keys('C-b')
|
||||||
wait_for { session.content(esc_seqs: true) }.to eq('echo hello')
|
wait_for { session.content(esc_seqs: true) }.to eq('echo hello')
|
||||||
wait_for { session.cursor }.to eq([10, 0])
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@ -95,27 +94,4 @@ 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
|
||||||
|
|||||||
@ -1,19 +1,17 @@
|
|||||||
require 'pry'
|
require 'pry'
|
||||||
require 'rspec/wait'
|
require 'rspec/wait'
|
||||||
require 'terminal_session'
|
require 'terminal_session'
|
||||||
require 'tempfile'
|
|
||||||
|
|
||||||
RSpec.shared_context 'terminal session' do
|
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(['source zsh-autosuggestions.zsh', *options].join('; '))
|
|
||||||
after_sourcing.call
|
session.run_command((['source zsh-autosuggestions.zsh'] + options).join('; '))
|
||||||
session.clear_screen
|
session.clear_screen
|
||||||
|
|
||||||
example.run
|
example.run
|
||||||
@ -22,12 +20,11 @@ RSpec.shared_context 'terminal session' do
|
|||||||
end
|
end
|
||||||
|
|
||||||
def with_history(*commands, &block)
|
def with_history(*commands, &block)
|
||||||
Tempfile.create do |f|
|
|
||||||
f.write(commands.map{|c| c.gsub("\n", "\\\n")}.join("\n"))
|
|
||||||
f.flush
|
|
||||||
|
|
||||||
session.run_command('fc -p')
|
session.run_command('fc -p')
|
||||||
session.run_command("fc -R #{f.path}")
|
|
||||||
|
commands.each do |c|
|
||||||
|
c.respond_to?(:call) ? c.call : session.run_command(c)
|
||||||
|
end
|
||||||
|
|
||||||
session.clear_screen
|
session.clear_screen
|
||||||
|
|
||||||
@ -36,7 +33,6 @@ RSpec.shared_context 'terminal session' do
|
|||||||
session.send_keys('C-c')
|
session.send_keys('C-c')
|
||||||
session.run_command('fc -P')
|
session.run_command('fc -P')
|
||||||
end
|
end
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
RSpec.configure do |config|
|
RSpec.configure do |config|
|
||||||
|
|||||||
@ -1,72 +0,0 @@
|
|||||||
describe 'the `completion` suggestion strategy' do
|
|
||||||
let(:options) { ['ZSH_AUTOSUGGEST_STRATEGY=completion'] }
|
|
||||||
let(:before_sourcing) do
|
|
||||||
-> do
|
|
||||||
session.
|
|
||||||
run_command('autoload compinit && compinit').
|
|
||||||
run_command('_foo() { compadd bar; compadd bat }').
|
|
||||||
run_command('_num() { compadd two; compadd three }').
|
|
||||||
run_command('compdef _foo baz').
|
|
||||||
run_command('compdef _num one')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'suggests the first completion result' do
|
|
||||||
session.send_string('baz ')
|
|
||||||
wait_for { session.content }.to eq('baz bar')
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'does not add extra carriage returns when prefix has a line feed' do
|
|
||||||
skip '`stty` does not work inside zpty below zsh version 5.0.3' if session.zsh_version < Gem::Version.new('5.0.3')
|
|
||||||
session.send_string('baz \\').send_keys('C-v', 'C-j')
|
|
||||||
wait_for { session.content }.to eq("baz \\\nbar")
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when `_complete` is aliased' do
|
|
||||||
let(:before_sourcing) do
|
|
||||||
-> do
|
|
||||||
session.
|
|
||||||
run_command('autoload compinit && compinit').
|
|
||||||
run_command('_foo() { compadd bar; compadd bat }').
|
|
||||||
run_command('compdef _foo baz').
|
|
||||||
run_command('alias _complete=_complete')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'suggests the first completion result' do
|
|
||||||
session.send_string('baz ')
|
|
||||||
wait_for { session.content }.to eq('baz bar')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when ZSH_AUTOSUGGEST_COMPLETION_IGNORE is set to a pattern' do
|
|
||||||
let(:options) { ['ZSH_AUTOSUGGEST_STRATEGY=completion', 'ZSH_AUTOSUGGEST_COMPLETION_IGNORE="one *"'] }
|
|
||||||
|
|
||||||
it 'makes suggestions when the buffer does not match the pattern' do
|
|
||||||
session.send_string('baz ')
|
|
||||||
wait_for { session.content }.to eq('baz bar')
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'does not make suggestions when the buffer matches the pattern' do
|
|
||||||
session.send_string('one t')
|
|
||||||
sleep 1
|
|
||||||
expect(session.content).to eq('one t')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when async mode is enabled' do
|
|
||||||
let(:options) { ['ZSH_AUTOSUGGEST_USE_ASYNC=true', 'ZSH_AUTOSUGGEST_STRATEGY=completion'] }
|
|
||||||
|
|
||||||
it 'suggests the first completion result' do
|
|
||||||
session.send_string('baz ')
|
|
||||||
wait_for { session.content }.to eq('baz bar')
|
|
||||||
end
|
|
||||||
|
|
||||||
it 'does not add extra carriage returns when prefix has a line feed' do
|
|
||||||
skip '`stty` does not work inside zpty below zsh version 5.0.3' if session.zsh_version < Gem::Version.new('5.0.3')
|
|
||||||
session.send_string('baz \\').send_keys('C-v', 'C-j')
|
|
||||||
wait_for { session.content }.to eq("baz \\\nbar")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
12
spec/strategies/default_spec.rb
Normal file
12
spec/strategies/default_spec.rb
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
require 'strategies/special_characters_helper'
|
||||||
|
|
||||||
|
describe 'the default suggestion strategy' do
|
||||||
|
it 'suggests the last matching history entry' do
|
||||||
|
with_history('ls foo', 'ls bar', 'echo baz') do
|
||||||
|
session.send_string('ls')
|
||||||
|
wait_for { session.content }.to eq('ls bar')
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
include_examples 'special characters'
|
||||||
|
end
|
||||||
@ -1,23 +0,0 @@
|
|||||||
require 'strategies/special_characters_helper'
|
|
||||||
|
|
||||||
describe 'the `history` suggestion strategy' do
|
|
||||||
it 'suggests the last matching history entry' do
|
|
||||||
with_history('ls foo', 'ls bar', 'echo baz') do
|
|
||||||
session.send_string('ls')
|
|
||||||
wait_for { session.content }.to eq('ls bar')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
context 'when ZSH_AUTOSUGGEST_HISTORY_IGNORE is set to a pattern' do
|
|
||||||
let(:options) { ['ZSH_AUTOSUGGEST_HISTORY_IGNORE="* bar"'] }
|
|
||||||
|
|
||||||
it 'does not make suggestions that match the pattern' do
|
|
||||||
with_history('ls foo', 'ls bar', 'echo baz') do
|
|
||||||
session.send_string('ls')
|
|
||||||
wait_for { session.content }.to eq('ls foo')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
include_examples 'special characters'
|
|
||||||
end
|
|
||||||
@ -1,34 +1,21 @@
|
|||||||
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'] }
|
||||||
|
|
||||||
let(:history) { [
|
it 'suggests the last matching history entry after the previous command' do
|
||||||
|
with_history(
|
||||||
'echo what',
|
'echo what',
|
||||||
'ls foo',
|
'ls foo',
|
||||||
'echo what',
|
'echo what',
|
||||||
'ls bar',
|
'ls bar',
|
||||||
'ls baz',
|
'ls baz',
|
||||||
'echo what'
|
'echo what'
|
||||||
] }
|
) do
|
||||||
|
|
||||||
it 'suggests the last matching history entry after the previous command' do
|
|
||||||
with_history(*history) do
|
|
||||||
session.send_string('ls')
|
session.send_string('ls')
|
||||||
wait_for { session.content }.to eq('ls bar')
|
wait_for { session.content }.to eq('ls bar')
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
context 'when ZSH_AUTOSUGGEST_HISTORY_IGNORE is set to a pattern' do
|
|
||||||
let(:options) { ['ZSH_AUTOSUGGEST_STRATEGY=match_prev_cmd', 'ZSH_AUTOSUGGEST_HISTORY_IGNORE="* bar"'] }
|
|
||||||
|
|
||||||
it 'does not make suggestions that match the pattern' do
|
|
||||||
with_history(*history) do
|
|
||||||
session.send_string('ls')
|
|
||||||
wait_for { session.content }.to eq('ls foo')
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
include_examples 'special characters'
|
include_examples 'special characters'
|
||||||
end
|
end
|
||||||
|
|||||||
@ -1,71 +1,58 @@
|
|||||||
shared_examples 'special characters' do
|
shared_examples 'special characters' do
|
||||||
describe 'a special character in the buffer should be treated like any other character' do
|
describe 'a special character in the buffer' do
|
||||||
it 'asterisk' do
|
it 'should be treated like any other character' do
|
||||||
with_history('echo "hello*"', 'echo "hello."') do
|
with_history('echo "hello*"', 'echo "hello."') do
|
||||||
session.send_string('echo "hello*')
|
session.send_string('echo "hello*')
|
||||||
wait_for { session.content }.to eq('echo "hello*"')
|
wait_for { session.content }.to eq('echo "hello*"')
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
it 'question mark' do
|
|
||||||
with_history('echo "hello?"', 'echo "hello."') do
|
with_history('echo "hello?"', 'echo "hello."') do
|
||||||
session.send_string('echo "hello?')
|
session.send_string('echo "hello?')
|
||||||
wait_for { session.content }.to eq('echo "hello?"')
|
wait_for { session.content }.to eq('echo "hello?"')
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
it 'backslash' do
|
|
||||||
with_history('echo "hello\nworld"') do
|
with_history('echo "hello\nworld"') do
|
||||||
session.send_string('echo "hello\\')
|
session.send_string('echo "hello\\')
|
||||||
wait_for { session.content }.to eq('echo "hello\nworld"')
|
wait_for { session.content }.to eq('echo "hello\nworld"')
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
it 'double backslash' do
|
|
||||||
with_history('echo "\\\\"') do
|
with_history('echo "\\\\"') do
|
||||||
session.send_string('echo "\\\\')
|
session.send_string('echo "\\\\')
|
||||||
wait_for { session.content }.to eq('echo "\\\\"')
|
wait_for { session.content }.to eq('echo "\\\\"')
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
it 'tilde' do
|
|
||||||
with_history('echo ~/foo') do
|
with_history('echo ~/foo') do
|
||||||
session.send_string('echo ~')
|
session.send_string('echo ~')
|
||||||
wait_for { session.content }.to eq('echo ~/foo')
|
wait_for { session.content }.to eq('echo ~/foo')
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
it 'parentheses' do
|
|
||||||
with_history('echo "$(ls foo)"') do
|
with_history('echo "$(ls foo)"') do
|
||||||
session.send_string('echo "$(')
|
session.send_string('echo "$(')
|
||||||
wait_for { session.content }.to eq('echo "$(ls foo)"')
|
wait_for { session.content }.to eq('echo "$(ls foo)"')
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
it 'square bracket' do
|
|
||||||
with_history('echo "$history[123]"') do
|
with_history('echo "$history[123]"') do
|
||||||
session.send_string('echo "$history[')
|
session.send_string('echo "$history[')
|
||||||
wait_for { session.content }.to eq('echo "$history[123]"')
|
wait_for { session.content }.to eq('echo "$history[123]"')
|
||||||
session.send_string('123]')
|
session.send_string('123]')
|
||||||
wait_for { session.content }.to eq('echo "$history[123]"')
|
wait_for { session.content }.to eq('echo "$history[123]"')
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
it 'octothorpe' do
|
|
||||||
with_history('echo "#yolo"') do
|
with_history('echo "#yolo"') do
|
||||||
session.send_string('echo "#')
|
session.send_string('echo "#')
|
||||||
wait_for { session.content }.to eq('echo "#yolo"')
|
wait_for { session.content }.to eq('echo "#yolo"')
|
||||||
end
|
end
|
||||||
|
|
||||||
|
with_history('echo "#foo"', 'echo $#abc') do
|
||||||
|
session.send_string('echo "#')
|
||||||
|
wait_for { session.content }.to eq('echo "#foo"')
|
||||||
end
|
end
|
||||||
|
|
||||||
it 'caret' do
|
|
||||||
with_history('echo "^A"', 'echo "^B"') do
|
with_history('echo "^A"', 'echo "^B"') do
|
||||||
session.send_string('echo "^A')
|
session.send_string('echo "^A')
|
||||||
wait_for { session.content }.to eq('echo "^A"')
|
wait_for { session.content }.to eq('echo "^A"')
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
it 'dash' do
|
|
||||||
with_history('-foo() {}') do
|
with_history('-foo() {}') do
|
||||||
session.send_string('-')
|
session.send_string('-')
|
||||||
wait_for { session.content }.to eq('-foo() {}')
|
wait_for { session.content }.to eq('-foo() {}')
|
||||||
|
|||||||
@ -18,10 +18,6 @@ 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
|
||||||
@ -81,10 +77,6 @@ class TerminalSession
|
|||||||
map(&:to_i)
|
map(&:to_i)
|
||||||
end
|
end
|
||||||
|
|
||||||
def attach!
|
|
||||||
tmux_command('attach-session')
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
attr_reader :opts
|
attr_reader :opts
|
||||||
|
|||||||
138
src/async.zsh
138
src/async.zsh
@ -3,75 +3,107 @@
|
|||||||
# Async #
|
# Async #
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
|
|
||||||
_zsh_autosuggest_async_request() {
|
# Zpty process is spawned running this function
|
||||||
zmodload zsh/system 2>/dev/null # For `$sysparams`
|
_zsh_autosuggest_async_server() {
|
||||||
|
emulate -R zsh
|
||||||
|
|
||||||
typeset -g _ZSH_AUTOSUGGEST_ASYNC_FD _ZSH_AUTOSUGGEST_CHILD_PID
|
# 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
|
||||||
|
}
|
||||||
|
|
||||||
# If we've got a pending request, cancel it
|
# Output only newlines (not carriage return + newline)
|
||||||
if [[ -n "$_ZSH_AUTOSUGGEST_ASYNC_FD" ]] && { true <&$_ZSH_AUTOSUGGEST_ASYNC_FD } 2>/dev/null; then
|
stty -onlcr
|
||||||
# Close the file descriptor and remove the handler
|
|
||||||
builtin exec {_ZSH_AUTOSUGGEST_ASYNC_FD}<&-
|
|
||||||
zle -F $_ZSH_AUTOSUGGEST_ASYNC_FD
|
|
||||||
|
|
||||||
# We won't know the pid unless the user has zsh/system module installed
|
# Silence any error messages
|
||||||
if [[ -n "$_ZSH_AUTOSUGGEST_CHILD_PID" ]]; then
|
exec 2>/dev/null
|
||||||
# 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
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Fork a process to fetch a suggestion and open a pipe to read from it
|
local strategy=$1
|
||||||
builtin exec {_ZSH_AUTOSUGGEST_ASYNC_FD}< <(
|
local last_pid
|
||||||
# Tell parent process our pid
|
|
||||||
echo $sysparams[pid]
|
|
||||||
|
|
||||||
# Fetch and print the suggestion
|
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
|
local suggestion
|
||||||
_zsh_autosuggest_fetch_suggestion "$1"
|
_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY "$query"
|
||||||
echo -nE "$suggestion"
|
echo -n -E "$suggestion"$'\0'
|
||||||
)
|
) &
|
||||||
|
|
||||||
# There's a weird bug here where ^C stops working unless we force a fork
|
last_pid=$!
|
||||||
# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
|
done
|
||||||
autoload -Uz is-at-least
|
|
||||||
is-at-least 5.8 || 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 pipe
|
_zsh_autosuggest_async_request() {
|
||||||
|
# Write the query to the zpty process to fetch a suggestion
|
||||||
|
zpty -w -n $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME "${1}"$'\0'
|
||||||
|
}
|
||||||
|
|
||||||
|
# Called when new data is ready to be read from the pty
|
||||||
# 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() {
|
||||||
emulate -L zsh
|
setopt LOCAL_OPTIONS EXTENDED_GLOB
|
||||||
|
|
||||||
local suggestion
|
local suggestion
|
||||||
|
|
||||||
if [[ -z "$2" || "$2" == "hup" ]]; then
|
zpty -rt $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME suggestion '*'$'\0' 2>/dev/null
|
||||||
# Read everything from the fd and give it as a suggestion
|
zle autosuggest-suggest -- "${suggestion%%$'\0'##}"
|
||||||
IFS='' read -rd '' -u $1 suggestion
|
}
|
||||||
zle autosuggest-suggest -- "$suggestion"
|
|
||||||
|
|
||||||
# Close the fd
|
_zsh_autosuggest_async_pty_create() {
|
||||||
builtin exec {1}<&-
|
# 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
|
||||||
|
|
||||||
# Always remove the handler
|
# Fork a zpty process running the server function
|
||||||
zle -F "$1"
|
zpty -b $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME "_zsh_autosuggest_async_server _zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY"
|
||||||
_ZSH_AUTOSUGGEST_ASYNC_FD=
|
|
||||||
|
# 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() {
|
||||||
|
if zpty -t $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME &>/dev/null; then
|
||||||
|
# Remove the input handler
|
||||||
|
zle -F $_ZSH_AUTOSUGGEST_PTY_FD &>/dev/null
|
||||||
|
|
||||||
|
# Destroy the zpty
|
||||||
|
zpty -d $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME &>/dev/null
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
_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
|
||||||
}
|
}
|
||||||
|
|||||||
38
src/bind.zsh
38
src/bind.zsh
@ -4,8 +4,21 @@
|
|||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
|
|
||||||
_zsh_autosuggest_incr_bind_count() {
|
_zsh_autosuggest_incr_bind_count() {
|
||||||
typeset -gi bind_count=$((_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]+1))
|
if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then
|
||||||
_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=$bind_count
|
((_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]++))
|
||||||
|
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
|
||||||
@ -21,30 +34,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
|
||||||
@ -56,20 +69,19 @@ _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
|
||||||
|
|
||||||
ignore_widgets=(
|
ignore_widgets=(
|
||||||
.\*
|
.\*
|
||||||
_\*
|
_\*
|
||||||
${_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS/#/autosuggest-}
|
zle-\*
|
||||||
|
autosuggest-\*
|
||||||
$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX\*
|
$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX\*
|
||||||
$ZSH_AUTOSUGGEST_IGNORE_WIDGETS
|
$ZSH_AUTOSUGGEST_IGNORE_WIDGETS
|
||||||
)
|
)
|
||||||
@ -94,7 +106,7 @@ _zsh_autosuggest_bind_widgets() {
|
|||||||
# Given the name of an original widget and args, invoke it, if it exists
|
# Given the name of an original widget and args, invoke it, if it exists
|
||||||
_zsh_autosuggest_invoke_original_widget() {
|
_zsh_autosuggest_invoke_original_widget() {
|
||||||
# Do nothing unless called with at least one arg
|
# Do nothing unless called with at least one arg
|
||||||
(( $# )) || return 0
|
(( $# )) || return
|
||||||
|
|
||||||
local original_widget_name="$1"
|
local original_widget_name="$1"
|
||||||
|
|
||||||
|
|||||||
@ -6,90 +6,61 @@
|
|||||||
# 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} )) &&
|
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=8'
|
||||||
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} )) &&
|
ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
||||||
typeset -g ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
|
||||||
|
|
||||||
# Strategies to use to fetch a suggestion
|
ZSH_AUTOSUGGEST_STRATEGY=default
|
||||||
# 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
|
||||||
history-beginning-search-backward
|
history-beginning-search-backward
|
||||||
history-beginning-search-forward-end
|
|
||||||
history-beginning-search-backward-end
|
|
||||||
history-substring-search-up
|
history-substring-search-up
|
||||||
history-substring-search-down
|
history-substring-search-down
|
||||||
up-line-or-beginning-search
|
|
||||||
down-line-or-beginning-search
|
|
||||||
up-line-or-history
|
up-line-or-history
|
||||||
down-line-or-history
|
down-line-or-history
|
||||||
accept-line
|
accept-line
|
||||||
copy-earlier-word
|
)
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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
|
||||||
vi-forward-word-end
|
vi-forward-word-end
|
||||||
vi-forward-blank-word
|
vi-forward-blank-word
|
||||||
vi-forward-blank-word-end
|
vi-forward-blank-word-end
|
||||||
vi-find-next-char
|
)
|
||||||
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
|
||||||
set-local-history
|
set-local-history
|
||||||
which-command
|
which-command
|
||||||
yank
|
yank
|
||||||
yank-pop
|
)
|
||||||
zle-\*
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
# Pty name for capturing completions for completion suggestion strategy
|
# Max size of buffer to trigger autosuggestion. Leave undefined for no upper bound.
|
||||||
(( ! ${+ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME} )) &&
|
ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE=
|
||||||
typeset -g ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME=zsh_autosuggest_completion_pty
|
|
||||||
|
# Pty name for calculating autosuggestions asynchronously
|
||||||
|
ZSH_AUTOSUGGEST_ASYNC_PTY_NAME=zsh_autosuggest_pty
|
||||||
|
|||||||
19
src/features.zsh
Normal file
19
src/features.zsh
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
# 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
|
||||||
|
}
|
||||||
@ -1,27 +0,0 @@
|
|||||||
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
# 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"
|
|
||||||
|
|
||||||
# Ensure the suggestion matches the prefix
|
|
||||||
[[ "$suggestion" != "$1"* ]] && unset suggestion
|
|
||||||
|
|
||||||
# Break once we've found a valid suggestion
|
|
||||||
[[ -n "$suggestion" ]] && break
|
|
||||||
done
|
|
||||||
}
|
|
||||||
10
src/setup.zsh
Normal file
10
src/setup.zsh
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
# Setup #
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
|
||||||
|
# Precmd hooks for initializing the library and starting pty's
|
||||||
|
autoload -Uz add-zsh-hook
|
||||||
|
|
||||||
|
# Asynchronous suggestions are generated in a pty
|
||||||
|
zmodload zsh/zpty
|
||||||
@ -5,29 +5,20 @@
|
|||||||
|
|
||||||
# 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
|
||||||
}
|
}
|
||||||
|
|
||||||
# Mark for auto-loading the functions that we use
|
|
||||||
autoload -Uz add-zsh-hook is-at-least
|
|
||||||
|
|
||||||
# Automatically enable asynchronous mode in newer versions of zsh. Disable for
|
|
||||||
# older versions because there is a bug when using async mode where ^C does not
|
|
||||||
# work immediately after fetching a suggestion.
|
|
||||||
# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
|
|
||||||
if is-at-least 5.0.8; then
|
|
||||||
typeset -g ZSH_AUTOSUGGEST_USE_ASYNC=
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Start the autosuggestion widgets on the next precmd
|
# Start the autosuggestion widgets on the next precmd
|
||||||
add-zsh-hook precmd _zsh_autosuggest_start
|
add-zsh-hook precmd _zsh_autosuggest_start
|
||||||
|
|||||||
@ -1,137 +0,0 @@
|
|||||||
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
# Completion Suggestion Strategy #
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
# Fetches a suggestion from the completion engine
|
|
||||||
#
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_postcompletion() {
|
|
||||||
# Always insert the first completion into the buffer
|
|
||||||
compstate[insert]=1
|
|
||||||
|
|
||||||
# Don't list completions
|
|
||||||
unset 'compstate[list]'
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_completion_widget() {
|
|
||||||
# Add a post-completion hook to be called after all completions have been
|
|
||||||
# gathered. The hook can modify compstate to affect what is done with the
|
|
||||||
# gathered completions.
|
|
||||||
local -a +h comppostfuncs
|
|
||||||
comppostfuncs=(_zsh_autosuggest_capture_postcompletion)
|
|
||||||
|
|
||||||
# Only capture completions at the end of the buffer
|
|
||||||
CURSOR=$#BUFFER
|
|
||||||
|
|
||||||
# Run the original widget wrapping `.complete-word` so we don't
|
|
||||||
# recursively try to fetch suggestions, since our pty is forked
|
|
||||||
# after autosuggestions is initialized.
|
|
||||||
zle -- ${(k)widgets[(r)completion:.complete-word:_main_complete]}
|
|
||||||
|
|
||||||
if is-at-least 5.0.3; then
|
|
||||||
# Don't do any cr/lf transformations. We need to do this immediately before
|
|
||||||
# output because if we do it in setup, onlcr will be re-enabled when we enter
|
|
||||||
# vared in the async code path. There is a bug in zpty module in older versions
|
|
||||||
# where the tty is not properly attached to the pty slave, resulting in stty
|
|
||||||
# getting stopped with a SIGTTOU. See zsh-workers thread 31660 and upstream
|
|
||||||
# commit f75904a38
|
|
||||||
stty -onlcr -ocrnl -F /dev/tty
|
|
||||||
fi
|
|
||||||
|
|
||||||
# The completion has been added, print the buffer as the suggestion
|
|
||||||
echo -nE - $'\0'$BUFFER$'\0'
|
|
||||||
}
|
|
||||||
|
|
||||||
zle -N autosuggest-capture-completion _zsh_autosuggest_capture_completion_widget
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_setup() {
|
|
||||||
# There is a bug in zpty module in older zsh versions by which a
|
|
||||||
# zpty that exits will kill all zpty processes that were forked
|
|
||||||
# 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.
|
|
||||||
if ! is-at-least 5.4; then
|
|
||||||
zshexit() {
|
|
||||||
# The zsh builtin `kill` fails sometimes in older versions
|
|
||||||
# https://unix.stackexchange.com/a/477647/156673
|
|
||||||
kill -KILL $$ 2>&- || command kill -KILL $$
|
|
||||||
|
|
||||||
# Block for long enough for the signal to come through
|
|
||||||
sleep 1
|
|
||||||
}
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Try to avoid any suggestions that wouldn't match the prefix
|
|
||||||
zstyle ':completion:*' matcher-list ''
|
|
||||||
zstyle ':completion:*' path-completion false
|
|
||||||
zstyle ':completion:*' max-errors 0 not-numeric
|
|
||||||
|
|
||||||
bindkey '^I' autosuggest-capture-completion
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_completion_sync() {
|
|
||||||
_zsh_autosuggest_capture_setup
|
|
||||||
|
|
||||||
zle autosuggest-capture-completion
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_completion_async() {
|
|
||||||
_zsh_autosuggest_capture_setup
|
|
||||||
|
|
||||||
zmodload zsh/parameter 2>/dev/null || return # For `$functions`
|
|
||||||
|
|
||||||
# Make vared completion work as if for a normal command line
|
|
||||||
# https://stackoverflow.com/a/7057118/154703
|
|
||||||
autoload +X _complete
|
|
||||||
functions[_original_complete]=$functions[_complete]
|
|
||||||
function _complete() {
|
|
||||||
unset 'compstate[vared]'
|
|
||||||
_original_complete "$@"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Open zle with buffer set so we can capture completions for it
|
|
||||||
vared 1
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_strategy_completion() {
|
|
||||||
# Reset options to defaults and enable LOCAL_OPTIONS
|
|
||||||
emulate -L zsh
|
|
||||||
|
|
||||||
# Enable extended glob for completion ignore pattern
|
|
||||||
setopt EXTENDED_GLOB
|
|
||||||
|
|
||||||
typeset -g suggestion
|
|
||||||
local line REPLY
|
|
||||||
|
|
||||||
# Exit if we don't have completions
|
|
||||||
whence compdef >/dev/null || return
|
|
||||||
|
|
||||||
# Exit if we don't have zpty
|
|
||||||
zmodload zsh/zpty 2>/dev/null || return
|
|
||||||
|
|
||||||
# Exit if our search string matches the ignore pattern
|
|
||||||
[[ -n "$ZSH_AUTOSUGGEST_COMPLETION_IGNORE" ]] && [[ "$1" == $~ZSH_AUTOSUGGEST_COMPLETION_IGNORE ]] && return
|
|
||||||
|
|
||||||
# Zle will be inactive if we are in async mode
|
|
||||||
if zle; then
|
|
||||||
zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_sync
|
|
||||||
else
|
|
||||||
zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_async "\$1"
|
|
||||||
zpty -w $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME $'\t'
|
|
||||||
fi
|
|
||||||
|
|
||||||
{
|
|
||||||
# The completion result is surrounded by null bytes, so read the
|
|
||||||
# content between the first two null bytes.
|
|
||||||
zpty -r $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME line '*'$'\0''*'$'\0'
|
|
||||||
|
|
||||||
# Extract the suggestion from between the null bytes. On older
|
|
||||||
# versions of zsh (older than 5.3), we sometimes get extra bytes after
|
|
||||||
# the second null byte, so trim those off the end.
|
|
||||||
# See http://www.zsh.org/mla/workers/2015/msg03290.html
|
|
||||||
suggestion="${${(@0)line}[2]}"
|
|
||||||
} always {
|
|
||||||
# Destroy the pty
|
|
||||||
zpty -d $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,16 +1,16 @@
|
|||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# History Suggestion Strategy #
|
# Default 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_history() {
|
_zsh_autosuggest_strategy_default() {
|
||||||
# Reset options to defaults and enable LOCAL_OPTIONS
|
# Reset options to defaults and enable LOCAL_OPTIONS
|
||||||
emulate -L zsh
|
emulate -L zsh
|
||||||
|
|
||||||
# Enable globbing flags so that we can use (#m) and (x~y) glob operator
|
# Enable globbing flags so that we can use (#m)
|
||||||
setopt EXTENDED_GLOB
|
setopt EXTENDED_GLOB
|
||||||
|
|
||||||
# Escape backslashes and all of the glob operators so we can use
|
# Escape backslashes and all of the glob operators so we can use
|
||||||
@ -19,14 +19,7 @@ _zsh_autosuggest_strategy_history() {
|
|||||||
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
|
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
|
||||||
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
|
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
|
||||||
|
|
||||||
# Get the history items that match the prefix, excluding those that match
|
# Get the history items that match
|
||||||
# the ignore pattern
|
|
||||||
local pattern="$prefix*"
|
|
||||||
if [[ -n $ZSH_AUTOSUGGEST_HISTORY_IGNORE ]]; then
|
|
||||||
pattern="($pattern)~($ZSH_AUTOSUGGEST_HISTORY_IGNORE)"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Give the first history item matching the pattern as the suggestion
|
|
||||||
# - (r) subscript flag makes the pattern match on values
|
# - (r) subscript flag makes the pattern match on values
|
||||||
typeset -g suggestion="${history[(r)$pattern]}"
|
typeset -g suggestion="${history[(r)${prefix}*]}"
|
||||||
}
|
}
|
||||||
@ -24,23 +24,16 @@ _zsh_autosuggest_strategy_match_prev_cmd() {
|
|||||||
# Reset options to defaults and enable LOCAL_OPTIONS
|
# Reset options to defaults and enable LOCAL_OPTIONS
|
||||||
emulate -L zsh
|
emulate -L zsh
|
||||||
|
|
||||||
# Enable globbing flags so that we can use (#m) and (x~y) glob operator
|
# Enable globbing flags so that we can use (#m)
|
||||||
setopt EXTENDED_GLOB
|
setopt EXTENDED_GLOB
|
||||||
|
|
||||||
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
|
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
|
||||||
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
|
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
|
||||||
|
|
||||||
# Get the history items that match the prefix, excluding those that match
|
|
||||||
# the ignore pattern
|
|
||||||
local pattern="$prefix*"
|
|
||||||
if [[ -n $ZSH_AUTOSUGGEST_HISTORY_IGNORE ]]; then
|
|
||||||
pattern="($pattern)~($ZSH_AUTOSUGGEST_HISTORY_IGNORE)"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Get all history event numbers that correspond to history
|
# Get all history event numbers that correspond to history
|
||||||
# entries that match the pattern
|
# entries that match pattern $prefix*
|
||||||
local history_match_keys
|
local history_match_keys
|
||||||
history_match_keys=(${(k)history[(R)$~pattern]})
|
history_match_keys=(${(k)history[(R)$prefix*]})
|
||||||
|
|
||||||
# By default we use the first history number (most recent history entry)
|
# By default we use the first history number (most recent history entry)
|
||||||
local histkey="${history_match_keys[1]}"
|
local histkey="${history_match_keys[1]}"
|
||||||
|
|||||||
113
src/widgets.zsh
113
src/widgets.zsh
@ -20,7 +20,7 @@ _zsh_autosuggest_enable() {
|
|||||||
|
|
||||||
# Toggle suggestions (enable/disable)
|
# Toggle suggestions (enable/disable)
|
||||||
_zsh_autosuggest_toggle() {
|
_zsh_autosuggest_toggle() {
|
||||||
if (( ${+_ZSH_AUTOSUGGEST_DISABLED} )); then
|
if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
|
||||||
_zsh_autosuggest_enable
|
_zsh_autosuggest_enable
|
||||||
else
|
else
|
||||||
_zsh_autosuggest_disable
|
_zsh_autosuggest_disable
|
||||||
@ -30,7 +30,7 @@ _zsh_autosuggest_toggle() {
|
|||||||
# Clear the suggestion
|
# Clear the suggestion
|
||||||
_zsh_autosuggest_clear() {
|
_zsh_autosuggest_clear() {
|
||||||
# Remove the suggestion
|
# Remove the suggestion
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
|
|
||||||
_zsh_autosuggest_invoke_original_widget $@
|
_zsh_autosuggest_invoke_original_widget $@
|
||||||
}
|
}
|
||||||
@ -47,28 +47,36 @@ _zsh_autosuggest_modify() {
|
|||||||
local orig_postdisplay="$POSTDISPLAY"
|
local orig_postdisplay="$POSTDISPLAY"
|
||||||
|
|
||||||
# Clear suggestion while waiting for next one
|
# Clear suggestion while waiting for next one
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
|
|
||||||
# Original widget may modify the buffer
|
# Original widget may modify the buffer
|
||||||
_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
|
||||||
|
return $retval
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Optimize if manually typing in the suggestion
|
||||||
|
if (( $#BUFFER > $#orig_buffer )); then
|
||||||
|
local added=${BUFFER#$orig_buffer}
|
||||||
|
|
||||||
|
# If the string added matches the beginning of the postdisplay
|
||||||
|
if [[ "$added" = "${orig_postdisplay:0:$#added}" ]]; then
|
||||||
|
POSTDISPLAY="${orig_postdisplay:$#added}"
|
||||||
|
return $retval
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Don't fetch a new suggestion if the buffer hasn't changed
|
||||||
|
if [[ "$BUFFER" = "$orig_buffer" ]]; then
|
||||||
POSTDISPLAY="$orig_postdisplay"
|
POSTDISPLAY="$orig_postdisplay"
|
||||||
return $retval
|
return $retval
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Optimize if manually typing in the suggestion or if buffer hasn't changed
|
|
||||||
if [[ "$BUFFER" = "$orig_buffer"* && "$orig_postdisplay" = "${BUFFER:$#orig_buffer}"* ]]; then
|
|
||||||
POSTDISPLAY="${orig_postdisplay:$(($#BUFFER - $#orig_buffer))}"
|
|
||||||
return $retval
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Bail out if suggestions are disabled
|
# Bail out if suggestions are disabled
|
||||||
if (( ${+_ZSH_AUTOSUGGEST_DISABLED} )); then
|
if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
|
||||||
return $?
|
return $?
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@ -84,31 +92,29 @@ _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 (( ${+ZSH_AUTOSUGGEST_USE_ASYNC} )); then
|
if zpty -t "$ZSH_AUTOSUGGEST_ASYNC_PTY_NAME" &>/dev/null; then
|
||||||
_zsh_autosuggest_async_request "$BUFFER"
|
_zsh_autosuggest_async_request "$BUFFER"
|
||||||
else
|
else
|
||||||
local suggestion
|
local suggestion
|
||||||
_zsh_autosuggest_fetch_suggestion "$BUFFER"
|
_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY "$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
|
||||||
POSTDISPLAY="${suggestion#$BUFFER}"
|
POSTDISPLAY="${suggestion#$BUFFER}"
|
||||||
else
|
else
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# Accept the entire suggestion
|
# Accept the entire suggestion
|
||||||
_zsh_autosuggest_accept() {
|
_zsh_autosuggest_accept() {
|
||||||
local -i retval max_cursor_pos=$#BUFFER
|
local -i max_cursor_pos=$#BUFFER
|
||||||
|
|
||||||
# When vicmd keymap is active, the cursor can't move all the way
|
# When vicmd keymap is active, the cursor can't move all the way
|
||||||
# to the end of the buffer
|
# to the end of the buffer
|
||||||
@ -116,33 +122,19 @@ _zsh_autosuggest_accept() {
|
|||||||
max_cursor_pos=$((max_cursor_pos - 1))
|
max_cursor_pos=$((max_cursor_pos - 1))
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# If we're not in a valid state to accept a suggestion, just run the
|
|
||||||
# original widget and bail out
|
|
||||||
if (( $CURSOR != $max_cursor_pos || !$#POSTDISPLAY )); then
|
|
||||||
_zsh_autosuggest_invoke_original_widget $@
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Only accept if the cursor is at the end of the buffer
|
# Only accept if the cursor is at the end of the buffer
|
||||||
|
if [[ $CURSOR = $max_cursor_pos ]]; then
|
||||||
# Add the suggestion to the buffer
|
# Add the suggestion to the buffer
|
||||||
BUFFER="$BUFFER$POSTDISPLAY"
|
BUFFER="$BUFFER$POSTDISPLAY"
|
||||||
|
|
||||||
# Remove the suggestion
|
# Remove the suggestion
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
|
|
||||||
# Run the original widget before manually moving the cursor so that the
|
|
||||||
# cursor movement doesn't make the widget do something unexpected
|
|
||||||
_zsh_autosuggest_invoke_original_widget $@
|
|
||||||
retval=$?
|
|
||||||
|
|
||||||
# Move the cursor to the end of the buffer
|
# Move the cursor to the end of the buffer
|
||||||
if [[ "$KEYMAP" = "vicmd" ]]; then
|
CURSOR=${#BUFFER}
|
||||||
CURSOR=$(($#BUFFER - 1))
|
|
||||||
else
|
|
||||||
CURSOR=$#BUFFER
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
return $retval
|
_zsh_autosuggest_invoke_original_widget $@
|
||||||
}
|
}
|
||||||
|
|
||||||
# Accept the entire suggestion and execute it
|
# Accept the entire suggestion and execute it
|
||||||
@ -151,7 +143,7 @@ _zsh_autosuggest_execute() {
|
|||||||
BUFFER="$BUFFER$POSTDISPLAY"
|
BUFFER="$BUFFER$POSTDISPLAY"
|
||||||
|
|
||||||
# Remove the suggestion
|
# Remove the suggestion
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
|
|
||||||
# Call the original `accept-line` to handle syntax highlighting or
|
# Call the original `accept-line` to handle syntax highlighting or
|
||||||
# other potential custom behavior
|
# other potential custom behavior
|
||||||
@ -160,7 +152,7 @@ _zsh_autosuggest_execute() {
|
|||||||
|
|
||||||
# Partially accept the suggestion
|
# Partially accept the suggestion
|
||||||
_zsh_autosuggest_partial_accept() {
|
_zsh_autosuggest_partial_accept() {
|
||||||
local -i retval cursor_loc
|
local -i retval
|
||||||
|
|
||||||
# Save the contents of the buffer so we can restore later if needed
|
# Save the contents of the buffer so we can restore later if needed
|
||||||
local original_buffer="$BUFFER"
|
local original_buffer="$BUFFER"
|
||||||
@ -172,19 +164,13 @@ _zsh_autosuggest_partial_accept() {
|
|||||||
_zsh_autosuggest_invoke_original_widget $@
|
_zsh_autosuggest_invoke_original_widget $@
|
||||||
retval=$?
|
retval=$?
|
||||||
|
|
||||||
# Normalize cursor location across vi/emacs modes
|
|
||||||
cursor_loc=$CURSOR
|
|
||||||
if [[ "$KEYMAP" = "vicmd" ]]; then
|
|
||||||
cursor_loc=$((cursor_loc + 1))
|
|
||||||
fi
|
|
||||||
|
|
||||||
# If we've moved past the end of the original buffer
|
# If we've moved past the end of the original buffer
|
||||||
if (( $cursor_loc > $#original_buffer )); then
|
if (( $CURSOR > $#original_buffer )); then
|
||||||
# Set POSTDISPLAY to text right of the cursor
|
# Set POSTDISPLAY to text right of the cursor
|
||||||
POSTDISPLAY="${BUFFER[$(($cursor_loc + 1)),$#BUFFER]}"
|
POSTDISPLAY="$RBUFFER"
|
||||||
|
|
||||||
# Clip the buffer at the cursor
|
# Clip the buffer at the cursor
|
||||||
BUFFER="${BUFFER[1,$cursor_loc]}"
|
BUFFER="$LBUFFER"
|
||||||
else
|
else
|
||||||
# Restore the original buffer
|
# Restore the original buffer
|
||||||
BUFFER="$original_buffer"
|
BUFFER="$original_buffer"
|
||||||
@ -193,22 +179,7 @@ _zsh_autosuggest_partial_accept() {
|
|||||||
return $retval
|
return $retval
|
||||||
}
|
}
|
||||||
|
|
||||||
() {
|
for action in clear modify fetch suggest accept partial_accept execute enable disable toggle; do
|
||||||
typeset -ga _ZSH_AUTOSUGGEST_BUILTIN_ACTIONS
|
|
||||||
|
|
||||||
_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS=(
|
|
||||||
clear
|
|
||||||
fetch
|
|
||||||
suggest
|
|
||||||
accept
|
|
||||||
execute
|
|
||||||
enable
|
|
||||||
disable
|
|
||||||
toggle
|
|
||||||
)
|
|
||||||
|
|
||||||
local action
|
|
||||||
for action in $_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS modify partial_accept; do
|
|
||||||
eval "_zsh_autosuggest_widget_$action() {
|
eval "_zsh_autosuggest_widget_$action() {
|
||||||
local -i retval
|
local -i retval
|
||||||
|
|
||||||
@ -223,9 +194,13 @@ _zsh_autosuggest_partial_accept() {
|
|||||||
|
|
||||||
return \$retval
|
return \$retval
|
||||||
}"
|
}"
|
||||||
done
|
done
|
||||||
|
|
||||||
for action in $_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS; do
|
zle -N autosuggest-fetch _zsh_autosuggest_widget_fetch
|
||||||
zle -N autosuggest-$action _zsh_autosuggest_widget_$action
|
zle -N autosuggest-suggest _zsh_autosuggest_widget_suggest
|
||||||
done
|
zle -N autosuggest-accept _zsh_autosuggest_widget_accept
|
||||||
}
|
zle -N autosuggest-clear _zsh_autosuggest_widget_clear
|
||||||
|
zle -N autosuggest-execute _zsh_autosuggest_widget_execute
|
||||||
|
zle -N autosuggest-enable _zsh_autosuggest_widget_enable
|
||||||
|
zle -N autosuggest-disable _zsh_autosuggest_widget_disable
|
||||||
|
zle -N autosuggest-toggle _zsh_autosuggest_widget_toggle
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
# 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.7.1
|
# v0.4.2
|
||||||
# Copyright (c) 2013 Thiago de Arruda
|
# Copyright (c) 2013 Thiago de Arruda
|
||||||
# Copyright (c) 2016-2021 Eric Freese
|
# Copyright (c) 2016-2017 Eric Freese
|
||||||
#
|
#
|
||||||
# Permission is hereby granted, free of charge, to any person
|
# Permission is hereby granted, free of charge, to any person
|
||||||
# obtaining a copy of this software and associated documentation
|
# obtaining a copy of this software and associated documentation
|
||||||
@ -25,6 +25,16 @@
|
|||||||
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||||
# OTHER DEALINGS IN THE SOFTWARE.
|
# OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
# Setup #
|
||||||
|
#--------------------------------------------------------------------#
|
||||||
|
|
||||||
|
# Precmd hooks for initializing the library and starting pty's
|
||||||
|
autoload -Uz add-zsh-hook
|
||||||
|
|
||||||
|
# Asynchronous suggestions are generated in a pty
|
||||||
|
zmodload zsh/zpty
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Global Configuration Variables #
|
# Global Configuration Variables #
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
@ -32,93 +42,64 @@
|
|||||||
# 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} )) &&
|
ZSH_AUTOSUGGEST_HIGHLIGHT_STYLE='fg=8'
|
||||||
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} )) &&
|
ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
||||||
typeset -g ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX=autosuggest-orig-
|
|
||||||
|
|
||||||
# Strategies to use to fetch a suggestion
|
ZSH_AUTOSUGGEST_STRATEGY=default
|
||||||
# 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
|
||||||
history-beginning-search-backward
|
history-beginning-search-backward
|
||||||
history-beginning-search-forward-end
|
|
||||||
history-beginning-search-backward-end
|
|
||||||
history-substring-search-up
|
history-substring-search-up
|
||||||
history-substring-search-down
|
history-substring-search-down
|
||||||
up-line-or-beginning-search
|
|
||||||
down-line-or-beginning-search
|
|
||||||
up-line-or-history
|
up-line-or-history
|
||||||
down-line-or-history
|
down-line-or-history
|
||||||
accept-line
|
accept-line
|
||||||
copy-earlier-word
|
)
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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
|
||||||
vi-forward-word-end
|
vi-forward-word-end
|
||||||
vi-forward-blank-word
|
vi-forward-blank-word
|
||||||
vi-forward-blank-word-end
|
vi-forward-blank-word-end
|
||||||
vi-find-next-char
|
)
|
||||||
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
|
||||||
set-local-history
|
set-local-history
|
||||||
which-command
|
which-command
|
||||||
yank
|
yank
|
||||||
yank-pop
|
)
|
||||||
zle-\*
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
# Pty name for capturing completions for completion suggestion strategy
|
# Max size of buffer to trigger autosuggestion. Leave undefined for no upper bound.
|
||||||
(( ! ${+ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME} )) &&
|
ZSH_AUTOSUGGEST_BUFFER_MAX_SIZE=
|
||||||
typeset -g ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME=zsh_autosuggest_completion_pty
|
|
||||||
|
# Pty name for calculating autosuggestions asynchronously
|
||||||
|
ZSH_AUTOSUGGEST_ASYNC_PTY_NAME=zsh_autosuggest_pty
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Utility Functions #
|
# Utility Functions #
|
||||||
@ -131,13 +112,45 @@ _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() {
|
||||||
typeset -gi bind_count=$((_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]+1))
|
if ((${+_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]})); then
|
||||||
_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]=$bind_count
|
((_ZSH_AUTOSUGGEST_BIND_COUNTS[$1]++))
|
||||||
|
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
|
||||||
@ -153,30 +166,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
|
||||||
@ -188,20 +201,19 @@ _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
|
||||||
|
|
||||||
ignore_widgets=(
|
ignore_widgets=(
|
||||||
.\*
|
.\*
|
||||||
_\*
|
_\*
|
||||||
${_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS/#/autosuggest-}
|
zle-\*
|
||||||
|
autosuggest-\*
|
||||||
$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX\*
|
$ZSH_AUTOSUGGEST_ORIGINAL_WIDGET_PREFIX\*
|
||||||
$ZSH_AUTOSUGGEST_IGNORE_WIDGETS
|
$ZSH_AUTOSUGGEST_IGNORE_WIDGETS
|
||||||
)
|
)
|
||||||
@ -226,7 +238,7 @@ _zsh_autosuggest_bind_widgets() {
|
|||||||
# Given the name of an original widget and args, invoke it, if it exists
|
# Given the name of an original widget and args, invoke it, if it exists
|
||||||
_zsh_autosuggest_invoke_original_widget() {
|
_zsh_autosuggest_invoke_original_widget() {
|
||||||
# Do nothing unless called with at least one arg
|
# Do nothing unless called with at least one arg
|
||||||
(( $# )) || return 0
|
(( $# )) || return
|
||||||
|
|
||||||
local original_widget_name="$1"
|
local original_widget_name="$1"
|
||||||
|
|
||||||
@ -284,7 +296,7 @@ _zsh_autosuggest_enable() {
|
|||||||
|
|
||||||
# Toggle suggestions (enable/disable)
|
# Toggle suggestions (enable/disable)
|
||||||
_zsh_autosuggest_toggle() {
|
_zsh_autosuggest_toggle() {
|
||||||
if (( ${+_ZSH_AUTOSUGGEST_DISABLED} )); then
|
if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
|
||||||
_zsh_autosuggest_enable
|
_zsh_autosuggest_enable
|
||||||
else
|
else
|
||||||
_zsh_autosuggest_disable
|
_zsh_autosuggest_disable
|
||||||
@ -294,7 +306,7 @@ _zsh_autosuggest_toggle() {
|
|||||||
# Clear the suggestion
|
# Clear the suggestion
|
||||||
_zsh_autosuggest_clear() {
|
_zsh_autosuggest_clear() {
|
||||||
# Remove the suggestion
|
# Remove the suggestion
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
|
|
||||||
_zsh_autosuggest_invoke_original_widget $@
|
_zsh_autosuggest_invoke_original_widget $@
|
||||||
}
|
}
|
||||||
@ -311,28 +323,36 @@ _zsh_autosuggest_modify() {
|
|||||||
local orig_postdisplay="$POSTDISPLAY"
|
local orig_postdisplay="$POSTDISPLAY"
|
||||||
|
|
||||||
# Clear suggestion while waiting for next one
|
# Clear suggestion while waiting for next one
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
|
|
||||||
# Original widget may modify the buffer
|
# Original widget may modify the buffer
|
||||||
_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
|
||||||
|
return $retval
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Optimize if manually typing in the suggestion
|
||||||
|
if (( $#BUFFER > $#orig_buffer )); then
|
||||||
|
local added=${BUFFER#$orig_buffer}
|
||||||
|
|
||||||
|
# If the string added matches the beginning of the postdisplay
|
||||||
|
if [[ "$added" = "${orig_postdisplay:0:$#added}" ]]; then
|
||||||
|
POSTDISPLAY="${orig_postdisplay:$#added}"
|
||||||
|
return $retval
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Don't fetch a new suggestion if the buffer hasn't changed
|
||||||
|
if [[ "$BUFFER" = "$orig_buffer" ]]; then
|
||||||
POSTDISPLAY="$orig_postdisplay"
|
POSTDISPLAY="$orig_postdisplay"
|
||||||
return $retval
|
return $retval
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Optimize if manually typing in the suggestion or if buffer hasn't changed
|
|
||||||
if [[ "$BUFFER" = "$orig_buffer"* && "$orig_postdisplay" = "${BUFFER:$#orig_buffer}"* ]]; then
|
|
||||||
POSTDISPLAY="${orig_postdisplay:$(($#BUFFER - $#orig_buffer))}"
|
|
||||||
return $retval
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Bail out if suggestions are disabled
|
# Bail out if suggestions are disabled
|
||||||
if (( ${+_ZSH_AUTOSUGGEST_DISABLED} )); then
|
if [[ -n "${_ZSH_AUTOSUGGEST_DISABLED+x}" ]]; then
|
||||||
return $?
|
return $?
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@ -348,31 +368,29 @@ _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 (( ${+ZSH_AUTOSUGGEST_USE_ASYNC} )); then
|
if zpty -t "$ZSH_AUTOSUGGEST_ASYNC_PTY_NAME" &>/dev/null; then
|
||||||
_zsh_autosuggest_async_request "$BUFFER"
|
_zsh_autosuggest_async_request "$BUFFER"
|
||||||
else
|
else
|
||||||
local suggestion
|
local suggestion
|
||||||
_zsh_autosuggest_fetch_suggestion "$BUFFER"
|
_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY "$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
|
||||||
POSTDISPLAY="${suggestion#$BUFFER}"
|
POSTDISPLAY="${suggestion#$BUFFER}"
|
||||||
else
|
else
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
# Accept the entire suggestion
|
# Accept the entire suggestion
|
||||||
_zsh_autosuggest_accept() {
|
_zsh_autosuggest_accept() {
|
||||||
local -i retval max_cursor_pos=$#BUFFER
|
local -i max_cursor_pos=$#BUFFER
|
||||||
|
|
||||||
# When vicmd keymap is active, the cursor can't move all the way
|
# When vicmd keymap is active, the cursor can't move all the way
|
||||||
# to the end of the buffer
|
# to the end of the buffer
|
||||||
@ -380,33 +398,19 @@ _zsh_autosuggest_accept() {
|
|||||||
max_cursor_pos=$((max_cursor_pos - 1))
|
max_cursor_pos=$((max_cursor_pos - 1))
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# If we're not in a valid state to accept a suggestion, just run the
|
|
||||||
# original widget and bail out
|
|
||||||
if (( $CURSOR != $max_cursor_pos || !$#POSTDISPLAY )); then
|
|
||||||
_zsh_autosuggest_invoke_original_widget $@
|
|
||||||
return
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Only accept if the cursor is at the end of the buffer
|
# Only accept if the cursor is at the end of the buffer
|
||||||
|
if [[ $CURSOR = $max_cursor_pos ]]; then
|
||||||
# Add the suggestion to the buffer
|
# Add the suggestion to the buffer
|
||||||
BUFFER="$BUFFER$POSTDISPLAY"
|
BUFFER="$BUFFER$POSTDISPLAY"
|
||||||
|
|
||||||
# Remove the suggestion
|
# Remove the suggestion
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
|
|
||||||
# Run the original widget before manually moving the cursor so that the
|
|
||||||
# cursor movement doesn't make the widget do something unexpected
|
|
||||||
_zsh_autosuggest_invoke_original_widget $@
|
|
||||||
retval=$?
|
|
||||||
|
|
||||||
# Move the cursor to the end of the buffer
|
# Move the cursor to the end of the buffer
|
||||||
if [[ "$KEYMAP" = "vicmd" ]]; then
|
CURSOR=${#BUFFER}
|
||||||
CURSOR=$(($#BUFFER - 1))
|
|
||||||
else
|
|
||||||
CURSOR=$#BUFFER
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
return $retval
|
_zsh_autosuggest_invoke_original_widget $@
|
||||||
}
|
}
|
||||||
|
|
||||||
# Accept the entire suggestion and execute it
|
# Accept the entire suggestion and execute it
|
||||||
@ -415,7 +419,7 @@ _zsh_autosuggest_execute() {
|
|||||||
BUFFER="$BUFFER$POSTDISPLAY"
|
BUFFER="$BUFFER$POSTDISPLAY"
|
||||||
|
|
||||||
# Remove the suggestion
|
# Remove the suggestion
|
||||||
POSTDISPLAY=
|
unset POSTDISPLAY
|
||||||
|
|
||||||
# Call the original `accept-line` to handle syntax highlighting or
|
# Call the original `accept-line` to handle syntax highlighting or
|
||||||
# other potential custom behavior
|
# other potential custom behavior
|
||||||
@ -424,7 +428,7 @@ _zsh_autosuggest_execute() {
|
|||||||
|
|
||||||
# Partially accept the suggestion
|
# Partially accept the suggestion
|
||||||
_zsh_autosuggest_partial_accept() {
|
_zsh_autosuggest_partial_accept() {
|
||||||
local -i retval cursor_loc
|
local -i retval
|
||||||
|
|
||||||
# Save the contents of the buffer so we can restore later if needed
|
# Save the contents of the buffer so we can restore later if needed
|
||||||
local original_buffer="$BUFFER"
|
local original_buffer="$BUFFER"
|
||||||
@ -436,19 +440,13 @@ _zsh_autosuggest_partial_accept() {
|
|||||||
_zsh_autosuggest_invoke_original_widget $@
|
_zsh_autosuggest_invoke_original_widget $@
|
||||||
retval=$?
|
retval=$?
|
||||||
|
|
||||||
# Normalize cursor location across vi/emacs modes
|
|
||||||
cursor_loc=$CURSOR
|
|
||||||
if [[ "$KEYMAP" = "vicmd" ]]; then
|
|
||||||
cursor_loc=$((cursor_loc + 1))
|
|
||||||
fi
|
|
||||||
|
|
||||||
# If we've moved past the end of the original buffer
|
# If we've moved past the end of the original buffer
|
||||||
if (( $cursor_loc > $#original_buffer )); then
|
if (( $CURSOR > $#original_buffer )); then
|
||||||
# Set POSTDISPLAY to text right of the cursor
|
# Set POSTDISPLAY to text right of the cursor
|
||||||
POSTDISPLAY="${BUFFER[$(($cursor_loc + 1)),$#BUFFER]}"
|
POSTDISPLAY="$RBUFFER"
|
||||||
|
|
||||||
# Clip the buffer at the cursor
|
# Clip the buffer at the cursor
|
||||||
BUFFER="${BUFFER[1,$cursor_loc]}"
|
BUFFER="$LBUFFER"
|
||||||
else
|
else
|
||||||
# Restore the original buffer
|
# Restore the original buffer
|
||||||
BUFFER="$original_buffer"
|
BUFFER="$original_buffer"
|
||||||
@ -457,22 +455,7 @@ _zsh_autosuggest_partial_accept() {
|
|||||||
return $retval
|
return $retval
|
||||||
}
|
}
|
||||||
|
|
||||||
() {
|
for action in clear modify fetch suggest accept partial_accept execute enable disable toggle; do
|
||||||
typeset -ga _ZSH_AUTOSUGGEST_BUILTIN_ACTIONS
|
|
||||||
|
|
||||||
_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS=(
|
|
||||||
clear
|
|
||||||
fetch
|
|
||||||
suggest
|
|
||||||
accept
|
|
||||||
execute
|
|
||||||
enable
|
|
||||||
disable
|
|
||||||
toggle
|
|
||||||
)
|
|
||||||
|
|
||||||
local action
|
|
||||||
for action in $_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS modify partial_accept; do
|
|
||||||
eval "_zsh_autosuggest_widget_$action() {
|
eval "_zsh_autosuggest_widget_$action() {
|
||||||
local -i retval
|
local -i retval
|
||||||
|
|
||||||
@ -487,162 +470,29 @@ _zsh_autosuggest_partial_accept() {
|
|||||||
|
|
||||||
return \$retval
|
return \$retval
|
||||||
}"
|
}"
|
||||||
done
|
done
|
||||||
|
|
||||||
for action in $_ZSH_AUTOSUGGEST_BUILTIN_ACTIONS; do
|
zle -N autosuggest-fetch _zsh_autosuggest_widget_fetch
|
||||||
zle -N autosuggest-$action _zsh_autosuggest_widget_$action
|
zle -N autosuggest-suggest _zsh_autosuggest_widget_suggest
|
||||||
done
|
zle -N autosuggest-accept _zsh_autosuggest_widget_accept
|
||||||
}
|
zle -N autosuggest-clear _zsh_autosuggest_widget_clear
|
||||||
|
zle -N autosuggest-execute _zsh_autosuggest_widget_execute
|
||||||
|
zle -N autosuggest-enable _zsh_autosuggest_widget_enable
|
||||||
|
zle -N autosuggest-disable _zsh_autosuggest_widget_disable
|
||||||
|
zle -N autosuggest-toggle _zsh_autosuggest_widget_toggle
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Completion Suggestion Strategy #
|
# Default Suggestion Strategy #
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
# Fetches a suggestion from the completion engine
|
|
||||||
#
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_postcompletion() {
|
|
||||||
# Always insert the first completion into the buffer
|
|
||||||
compstate[insert]=1
|
|
||||||
|
|
||||||
# Don't list completions
|
|
||||||
unset 'compstate[list]'
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_completion_widget() {
|
|
||||||
# Add a post-completion hook to be called after all completions have been
|
|
||||||
# gathered. The hook can modify compstate to affect what is done with the
|
|
||||||
# gathered completions.
|
|
||||||
local -a +h comppostfuncs
|
|
||||||
comppostfuncs=(_zsh_autosuggest_capture_postcompletion)
|
|
||||||
|
|
||||||
# Only capture completions at the end of the buffer
|
|
||||||
CURSOR=$#BUFFER
|
|
||||||
|
|
||||||
# Run the original widget wrapping `.complete-word` so we don't
|
|
||||||
# recursively try to fetch suggestions, since our pty is forked
|
|
||||||
# after autosuggestions is initialized.
|
|
||||||
zle -- ${(k)widgets[(r)completion:.complete-word:_main_complete]}
|
|
||||||
|
|
||||||
if is-at-least 5.0.3; then
|
|
||||||
# Don't do any cr/lf transformations. We need to do this immediately before
|
|
||||||
# output because if we do it in setup, onlcr will be re-enabled when we enter
|
|
||||||
# vared in the async code path. There is a bug in zpty module in older versions
|
|
||||||
# where the tty is not properly attached to the pty slave, resulting in stty
|
|
||||||
# getting stopped with a SIGTTOU. See zsh-workers thread 31660 and upstream
|
|
||||||
# commit f75904a38
|
|
||||||
stty -onlcr -ocrnl -F /dev/tty
|
|
||||||
fi
|
|
||||||
|
|
||||||
# The completion has been added, print the buffer as the suggestion
|
|
||||||
echo -nE - $'\0'$BUFFER$'\0'
|
|
||||||
}
|
|
||||||
|
|
||||||
zle -N autosuggest-capture-completion _zsh_autosuggest_capture_completion_widget
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_setup() {
|
|
||||||
# There is a bug in zpty module in older zsh versions by which a
|
|
||||||
# zpty that exits will kill all zpty processes that were forked
|
|
||||||
# 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.
|
|
||||||
if ! is-at-least 5.4; then
|
|
||||||
zshexit() {
|
|
||||||
# The zsh builtin `kill` fails sometimes in older versions
|
|
||||||
# https://unix.stackexchange.com/a/477647/156673
|
|
||||||
kill -KILL $$ 2>&- || command kill -KILL $$
|
|
||||||
|
|
||||||
# Block for long enough for the signal to come through
|
|
||||||
sleep 1
|
|
||||||
}
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Try to avoid any suggestions that wouldn't match the prefix
|
|
||||||
zstyle ':completion:*' matcher-list ''
|
|
||||||
zstyle ':completion:*' path-completion false
|
|
||||||
zstyle ':completion:*' max-errors 0 not-numeric
|
|
||||||
|
|
||||||
bindkey '^I' autosuggest-capture-completion
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_completion_sync() {
|
|
||||||
_zsh_autosuggest_capture_setup
|
|
||||||
|
|
||||||
zle autosuggest-capture-completion
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_capture_completion_async() {
|
|
||||||
_zsh_autosuggest_capture_setup
|
|
||||||
|
|
||||||
zmodload zsh/parameter 2>/dev/null || return # For `$functions`
|
|
||||||
|
|
||||||
# Make vared completion work as if for a normal command line
|
|
||||||
# https://stackoverflow.com/a/7057118/154703
|
|
||||||
autoload +X _complete
|
|
||||||
functions[_original_complete]=$functions[_complete]
|
|
||||||
function _complete() {
|
|
||||||
unset 'compstate[vared]'
|
|
||||||
_original_complete "$@"
|
|
||||||
}
|
|
||||||
|
|
||||||
# Open zle with buffer set so we can capture completions for it
|
|
||||||
vared 1
|
|
||||||
}
|
|
||||||
|
|
||||||
_zsh_autosuggest_strategy_completion() {
|
|
||||||
# Reset options to defaults and enable LOCAL_OPTIONS
|
|
||||||
emulate -L zsh
|
|
||||||
|
|
||||||
# Enable extended glob for completion ignore pattern
|
|
||||||
setopt EXTENDED_GLOB
|
|
||||||
|
|
||||||
typeset -g suggestion
|
|
||||||
local line REPLY
|
|
||||||
|
|
||||||
# Exit if we don't have completions
|
|
||||||
whence compdef >/dev/null || return
|
|
||||||
|
|
||||||
# Exit if we don't have zpty
|
|
||||||
zmodload zsh/zpty 2>/dev/null || return
|
|
||||||
|
|
||||||
# Exit if our search string matches the ignore pattern
|
|
||||||
[[ -n "$ZSH_AUTOSUGGEST_COMPLETION_IGNORE" ]] && [[ "$1" == $~ZSH_AUTOSUGGEST_COMPLETION_IGNORE ]] && return
|
|
||||||
|
|
||||||
# Zle will be inactive if we are in async mode
|
|
||||||
if zle; then
|
|
||||||
zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_sync
|
|
||||||
else
|
|
||||||
zpty $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME _zsh_autosuggest_capture_completion_async "\$1"
|
|
||||||
zpty -w $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME $'\t'
|
|
||||||
fi
|
|
||||||
|
|
||||||
{
|
|
||||||
# The completion result is surrounded by null bytes, so read the
|
|
||||||
# content between the first two null bytes.
|
|
||||||
zpty -r $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME line '*'$'\0''*'$'\0'
|
|
||||||
|
|
||||||
# Extract the suggestion from between the null bytes. On older
|
|
||||||
# versions of zsh (older than 5.3), we sometimes get extra bytes after
|
|
||||||
# the second null byte, so trim those off the end.
|
|
||||||
# See http://www.zsh.org/mla/workers/2015/msg03290.html
|
|
||||||
suggestion="${${(@0)line}[2]}"
|
|
||||||
} always {
|
|
||||||
# Destroy the pty
|
|
||||||
zpty -d $ZSH_AUTOSUGGEST_COMPLETIONS_PTY_NAME
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
# 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_history() {
|
_zsh_autosuggest_strategy_default() {
|
||||||
# Reset options to defaults and enable LOCAL_OPTIONS
|
# Reset options to defaults and enable LOCAL_OPTIONS
|
||||||
emulate -L zsh
|
emulate -L zsh
|
||||||
|
|
||||||
# Enable globbing flags so that we can use (#m) and (x~y) glob operator
|
# Enable globbing flags so that we can use (#m)
|
||||||
setopt EXTENDED_GLOB
|
setopt EXTENDED_GLOB
|
||||||
|
|
||||||
# Escape backslashes and all of the glob operators so we can use
|
# Escape backslashes and all of the glob operators so we can use
|
||||||
@ -651,16 +501,9 @@ _zsh_autosuggest_strategy_history() {
|
|||||||
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
|
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
|
||||||
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
|
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
|
||||||
|
|
||||||
# Get the history items that match the prefix, excluding those that match
|
# Get the history items that match
|
||||||
# the ignore pattern
|
|
||||||
local pattern="$prefix*"
|
|
||||||
if [[ -n $ZSH_AUTOSUGGEST_HISTORY_IGNORE ]]; then
|
|
||||||
pattern="($pattern)~($ZSH_AUTOSUGGEST_HISTORY_IGNORE)"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Give the first history item matching the pattern as the suggestion
|
|
||||||
# - (r) subscript flag makes the pattern match on values
|
# - (r) subscript flag makes the pattern match on values
|
||||||
typeset -g suggestion="${history[(r)$pattern]}"
|
typeset -g suggestion="${history[(r)${prefix}*]}"
|
||||||
}
|
}
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
@ -688,23 +531,16 @@ _zsh_autosuggest_strategy_match_prev_cmd() {
|
|||||||
# Reset options to defaults and enable LOCAL_OPTIONS
|
# Reset options to defaults and enable LOCAL_OPTIONS
|
||||||
emulate -L zsh
|
emulate -L zsh
|
||||||
|
|
||||||
# Enable globbing flags so that we can use (#m) and (x~y) glob operator
|
# Enable globbing flags so that we can use (#m)
|
||||||
setopt EXTENDED_GLOB
|
setopt EXTENDED_GLOB
|
||||||
|
|
||||||
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
|
# TODO: Use (b) flag when we can drop support for zsh older than v5.0.8
|
||||||
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
|
local prefix="${1//(#m)[\\*?[\]<>()|^~#]/\\$MATCH}"
|
||||||
|
|
||||||
# Get the history items that match the prefix, excluding those that match
|
|
||||||
# the ignore pattern
|
|
||||||
local pattern="$prefix*"
|
|
||||||
if [[ -n $ZSH_AUTOSUGGEST_HISTORY_IGNORE ]]; then
|
|
||||||
pattern="($pattern)~($ZSH_AUTOSUGGEST_HISTORY_IGNORE)"
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Get all history event numbers that correspond to history
|
# Get all history event numbers that correspond to history
|
||||||
# entries that match the pattern
|
# entries that match pattern $prefix*
|
||||||
local history_match_keys
|
local history_match_keys
|
||||||
history_match_keys=(${(k)history[(R)$~pattern]})
|
history_match_keys=(${(k)history[(R)$prefix*]})
|
||||||
|
|
||||||
# By default we use the first history number (most recent history entry)
|
# By default we use the first history number (most recent history entry)
|
||||||
local histkey="${history_match_keys[1]}"
|
local histkey="${history_match_keys[1]}"
|
||||||
@ -729,108 +565,113 @@ _zsh_autosuggest_strategy_match_prev_cmd() {
|
|||||||
typeset -g suggestion="$history[$histkey]"
|
typeset -g suggestion="$history[$histkey]"
|
||||||
}
|
}
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
|
||||||
# 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"
|
|
||||||
|
|
||||||
# Ensure the suggestion matches the prefix
|
|
||||||
[[ "$suggestion" != "$1"* ]] && unset suggestion
|
|
||||||
|
|
||||||
# Break once we've found a valid suggestion
|
|
||||||
[[ -n "$suggestion" ]] && break
|
|
||||||
done
|
|
||||||
}
|
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
# Async #
|
# Async #
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
|
|
||||||
_zsh_autosuggest_async_request() {
|
# Zpty process is spawned running this function
|
||||||
zmodload zsh/system 2>/dev/null # For `$sysparams`
|
_zsh_autosuggest_async_server() {
|
||||||
|
emulate -R zsh
|
||||||
|
|
||||||
typeset -g _ZSH_AUTOSUGGEST_ASYNC_FD _ZSH_AUTOSUGGEST_CHILD_PID
|
# 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
|
||||||
|
}
|
||||||
|
|
||||||
# If we've got a pending request, cancel it
|
# Output only newlines (not carriage return + newline)
|
||||||
if [[ -n "$_ZSH_AUTOSUGGEST_ASYNC_FD" ]] && { true <&$_ZSH_AUTOSUGGEST_ASYNC_FD } 2>/dev/null; then
|
stty -onlcr
|
||||||
# Close the file descriptor and remove the handler
|
|
||||||
builtin exec {_ZSH_AUTOSUGGEST_ASYNC_FD}<&-
|
|
||||||
zle -F $_ZSH_AUTOSUGGEST_ASYNC_FD
|
|
||||||
|
|
||||||
# We won't know the pid unless the user has zsh/system module installed
|
# Silence any error messages
|
||||||
if [[ -n "$_ZSH_AUTOSUGGEST_CHILD_PID" ]]; then
|
exec 2>/dev/null
|
||||||
# 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
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Fork a process to fetch a suggestion and open a pipe to read from it
|
local strategy=$1
|
||||||
builtin exec {_ZSH_AUTOSUGGEST_ASYNC_FD}< <(
|
local last_pid
|
||||||
# Tell parent process our pid
|
|
||||||
echo $sysparams[pid]
|
|
||||||
|
|
||||||
# Fetch and print the suggestion
|
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
|
local suggestion
|
||||||
_zsh_autosuggest_fetch_suggestion "$1"
|
_zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY "$query"
|
||||||
echo -nE "$suggestion"
|
echo -n -E "$suggestion"$'\0'
|
||||||
)
|
) &
|
||||||
|
|
||||||
# There's a weird bug here where ^C stops working unless we force a fork
|
last_pid=$!
|
||||||
# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
|
done
|
||||||
autoload -Uz is-at-least
|
|
||||||
is-at-least 5.8 || 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 pipe
|
_zsh_autosuggest_async_request() {
|
||||||
|
# Write the query to the zpty process to fetch a suggestion
|
||||||
|
zpty -w -n $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME "${1}"$'\0'
|
||||||
|
}
|
||||||
|
|
||||||
|
# Called when new data is ready to be read from the pty
|
||||||
# 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() {
|
||||||
emulate -L zsh
|
setopt LOCAL_OPTIONS EXTENDED_GLOB
|
||||||
|
|
||||||
local suggestion
|
local suggestion
|
||||||
|
|
||||||
if [[ -z "$2" || "$2" == "hup" ]]; then
|
zpty -rt $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME suggestion '*'$'\0' 2>/dev/null
|
||||||
# Read everything from the fd and give it as a suggestion
|
zle autosuggest-suggest -- "${suggestion%%$'\0'##}"
|
||||||
IFS='' read -rd '' -u $1 suggestion
|
}
|
||||||
zle autosuggest-suggest -- "$suggestion"
|
|
||||||
|
|
||||||
# Close the fd
|
_zsh_autosuggest_async_pty_create() {
|
||||||
builtin exec {1}<&-
|
# 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
|
||||||
|
|
||||||
# Always remove the handler
|
# Fork a zpty process running the server function
|
||||||
zle -F "$1"
|
zpty -b $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME "_zsh_autosuggest_async_server _zsh_autosuggest_strategy_$ZSH_AUTOSUGGEST_STRATEGY"
|
||||||
_ZSH_AUTOSUGGEST_ASYNC_FD=
|
|
||||||
|
# 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() {
|
||||||
|
if zpty -t $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME &>/dev/null; then
|
||||||
|
# Remove the input handler
|
||||||
|
zle -F $_ZSH_AUTOSUGGEST_PTY_FD &>/dev/null
|
||||||
|
|
||||||
|
# Destroy the zpty
|
||||||
|
zpty -d $ZSH_AUTOSUGGEST_ASYNC_PTY_NAME &>/dev/null
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
_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
|
||||||
}
|
}
|
||||||
|
|
||||||
#--------------------------------------------------------------------#
|
#--------------------------------------------------------------------#
|
||||||
@ -839,29 +680,20 @@ _zsh_autosuggest_async_response() {
|
|||||||
|
|
||||||
# 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
|
||||||
}
|
}
|
||||||
|
|
||||||
# Mark for auto-loading the functions that we use
|
|
||||||
autoload -Uz add-zsh-hook is-at-least
|
|
||||||
|
|
||||||
# Automatically enable asynchronous mode in newer versions of zsh. Disable for
|
|
||||||
# older versions because there is a bug when using async mode where ^C does not
|
|
||||||
# work immediately after fetching a suggestion.
|
|
||||||
# See https://github.com/zsh-users/zsh-autosuggestions/issues/364
|
|
||||||
if is-at-least 5.0.8; then
|
|
||||||
typeset -g ZSH_AUTOSUGGEST_USE_ASYNC=
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Start the autosuggestion widgets on the next precmd
|
# Start the autosuggestion widgets on the next precmd
|
||||||
add-zsh-hook precmd _zsh_autosuggest_start
|
add-zsh-hook precmd _zsh_autosuggest_start
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user