一个用于不可知论的 ZSH
插件。
🤔 为什么选择 ZVM?
也许你曾经体验过 Zsh 的默认 Vi 模式,在开启默认 Vi 模式后,你逐渐发现它存在许多问题,一些功能不完善或不存在,甚至有些行为与原生 Vi(Vim) 模式不同。
尽管默认的 Vi 模式有些尴尬和不愉快,你仍然继续使用它,但在使用一段时间后gradually逐渐失去了兴趣。最终,你失望地放弃了。
你很长一段时间都没有再想起 Vi 模式,直到有一天你偶然发现了这个插件,你读到这里,意识到这个插件就是为了解决上述问题,让你重新爱上 Vi 模式。一个微笑突然出现在你的脸上,就像重获新生。
冬天来了,春天还会远吗?
✨ 特性
- 🌟 纯 Zsh 脚本,无任何第三方依赖。
- 🎉 提供近乎原生的 vi(vim) 模式体验。
- ⌛ 更低延迟和更好的响应(模式切换速度等)。
- ✏️ 通过不同光标样式指示模式。
- 🧮 光标移动(导航)。
- 📝 插入和替换(插入模式)。
- 💡 文本对象(一个单词、内部单词等)。
- 🔎 历史搜索。
- ❇️ 撤销、重做、剪切、复制、粘贴和删除。
- 🪐 更好的环绕功能(添加、替换、删除、移动和高亮)。
- 🧽 切换关键词(增加/减少数字、布尔值、星期、月份等)。
- ⚙️ 命令模式下更好的功能(进行中)。
- 🪀 重复命令,如
10p
和4fa
(进行中)。 - 📒 系统剪贴板(进行中)。
💼 要求
ZSH: >= 5.1.0
🛠️ 安装
使用 Antigen
在你的 .zshrc
中添加 zsh-vi-mode
antigen bundle jeffreytse/zsh-vi-mode
使用 zplug
在你的 .zshrc
中加载 zsh-vi-mode
作为插件
zplug "jeffreytse/zsh-vi-mode"
使用 zgen
在你的 .zshrc
中包含加载命令
zgen load jeffreytse/zsh-vi-mode
使用 zinit
在你的 .zshrc
中包含加载命令
zinit ice depth=1
zinit light jeffreytse/zsh-vi-mode
注意:使用 depth=1
ice 是可选的,不推荐也不官方支持其他类型的 ice。
作为 Oh My Zsh! 自定义插件
将 zsh-vi-mode
克隆到你的自定义插件仓库
git clone https://github.com/jeffreytse/zsh-vi-mode \
$ZSH_CUSTOM/plugins/zsh-vi-mode
然后在你的 .zshrc
中加载它作为插件
plugins+=(zsh-vi-mode)
请记住,插件需要在 oh-my-zsh.sh
被加载之前添加。
使用 Antibody
将 zsh-vi-mode
添加到你的插件文件(例如 ~/.zsh_plugins.txt
)
jeffreytse/zsh-vi-mode
使用 Zap
在你的 .zshrc
中加载 zsh-vi-mode
作为插件
plug "jeffreytse/zsh-vi-mode"
使用 Zim
在你的 .zimrc
中加载 zsh-vi-mode
作为插件
zmodule jeffreytse/zsh-vi-mode
使用 Homebrew
对于 Homebrew 用户,你可以通过以下命令安装
brew install zsh-vi-mode
然后在你的 .zshrc
(或 .bashrc
)中加载它
source $(brew --prefix)/opt/zsh-vi-mode/share/zsh-vi-mode/zsh-vi-mode.plugin.zsh
Arch Linux (AUR)
对于 Arch Linux 用户,可以通过以下命令安装
yay -S zsh-vi-mode
或者安装最新更新版本(不稳定)
yay -S zsh-vi-mode-git
然后在 .zshrc
(或 .bashrc
)中引用
source /usr/share/zsh/plugins/zsh-vi-mode/zsh-vi-mode.plugin.zsh
Nix
对于 Nix 用户,从 e7e3480530b34a9fe8cb52963ec2cf66e6707e15 版本开始,可以通过以下配置引用插件
programs = {
zsh = {
interactiveShellInit = ''
source ${pkgs.zsh-vi-mode}/share/zsh-vi-mode/zsh-vi-mode.plugin.zsh
'';
};
};
或者如果你喜欢使用 home-manager
:
home-manager.users.[你的用户名] = { pkgs, ... }: {
programs = {
zsh = {
initExtra = ''
source ${pkgs.zsh-vi-mode}/share/zsh-vi-mode/zsh-vi-mode.plugin.zsh
'';
};
};
};
你也可以使用 home-manager
内置的"插件"功能:
home-manager.users.[你的用户名] = { pkgs, ... }: {
programs = {
zsh = {
plugins = [
{
name = "vi-mode";
src = pkgs.zsh-vi-mode;
file = "share/zsh-vi-mode/zsh-vi-mode.plugin.zsh";
}
];
};
};
};
使用 Fig
Fig 为你现有的终端添加应用、快捷方式和自动完成功能。
只需一次点击即可安装 zsh-vi-mode
。
Gentoo Linux
可在 dm9pZCAq overlay 中获取
eselect repository enable dm9pZCAq
emerge --sync dm9pZCAq
emerge app-shells/zsh-vi-mode
然后在 .zshrc
(或 .bashrc
)中引用
source /usr/share/zsh/site-contrib/zsh-vi-mode/zsh-vi-mode.plugin.zsh
手动安装
将此仓库克隆到某个位置(例如 $HOME/.zsh-vi-mode
)
git clone https://github.com/jeffreytse/zsh-vi-mode.git $HOME/.zsh-vi-mode
然后在 .zshrc
(或 .bashrc
)中引用
source $HOME/.zsh-vi-mode/zsh-vi-mode.plugin.zsh
打包状态
📚 使用方法
使用 ESC
或 CTRL-[
进入 普通模式
。
但有些人可能喜欢自定义的 escape 键,比如 jj
、jk
等,如果你想自定义 escape 键,可以从这里了解更多。
历史记录
ctrl-p
: 历史记录中的上一个命令ctrl-n
: 历史记录中的下一个命令/
: 在历史记录中向后搜索n
: 重复上一次/
搜索
模式指示器
默认情况下,普通模式
用方块样式光标表示,插入模式
用条形样式光标表示。
Vim 编辑
在 普通模式
下,你可以使用 vv
在编辑器(如 vi
/vim
/nvim
...)中编辑当前命令行,因为它被绑定到了 可视模式
。
你可以通过 ZVM_VI_EDITOR
选项更改编辑器,默认为 $EDITOR
。
移动
$
: 移动到行尾^
: 移动到行首第一个非空白字符0
: 移动到行首w
: 向前移动 [count] 个单词W
: 向前移动 [count] 个大单词e
: 向前移动到单词末尾 [count] 次(包含)E
: 向前移动到大单词末尾 [count] 次(包含)b
: 向后移动 [count] 个单词B
: 向后移动 [count] 个大单词t{char}
: 向右查找第 [count] 个 {char} 出现之前T{char}
: 向左查找第 [count] 个 {char} 出现之前f{char}
: 向右查找第 [count] 个 {char} 出现F{char}
: 向左查找第 [count] 个 {char} 出现;
: 重复上一次 f、t、F 或 T 操作 [count] 次,
: 反向重复上一次 f、t、F 或 T 操作
插入
i
: 在光标前插入文本I
: 在行首插入文本a
: 在光标后追加文本A
: 在行尾追加文本o
: 在当前行下方插入新的命令行O
: 在当前行上方插入新的命令行
环绕
有两种环绕操作的按键绑定模式,默认为 经典
模式,你可以通过设置 ZVM_VI_SURROUND_BINDKEY
选项来选择模式。
经典
模式(动作->s->环绕)
S"
: 为可视选择添加"
ys"
: 为可视选择添加"
cs"'
: 将"
更改为'
ds"
: 删除"
s-前缀
模式(s->动作->环绕)
sa"
: 为可视选择添加"
sd"
: 删除"
sr"'
: 将"
更改为'
注意,按键序列必须相当快速地按下,以避免超时。你可以通过 ZVM_KEYTIMEOUT
选项 延长这个超时时间。
如何选择环绕文本对象?
vi"
: 选择引号内的文本对象va(
: 选择括号内的文本对象(包括括号)
然后你可以对选择进行任何操作:
- 为文本对象添加环绕
vi"
->S[
或sa[
=>"object"
->"[object]"
va"
->S[
或sa[
=>"object"
->["object"]
- 删除/复制/更改文本对象
di(
或vi(
->d
ca(
或va(
->c
yi(
或vi(
->y
递增和递减
在普通模式下,输入 ctrl-a
将增加到下一个关键词,输入 ctrl-x
将减少到下一个关键词。关键词可以在光标处,也可以在光标右侧(同一行)。关键词可以是以下类型:
- 数字(十进制、十六进制、二进制...)
- 布尔值(True 或 False、Yes 或 No、On 或 Off...)
- 星期(Sunday、Monday、Tuesday、Wednesday...)
- 月份(January、February、March、April、May...)
- 运算符(&&、||、++、--、==、!==、and、or...)
- ...
例如:
- 递增
9
=>10
aa99bb
=>aa100bb
aa100bc
=>aa101bc
0xDe
=>0xdf
0Xdf
=>0Xe0
0b101
=>0b110
0B11
=>0B101
true
=>false
yes
=>no
on
=>off
T
=>F
Fri
=>Sat
Oct
=>Nov
Monday
=>Tuesday
January
=>February
+
=>-
++
=>--
==
=>!=
!==
=>===
&&
=>||
and
=>or
- ...
- 递减:
100
=>99
aa100bb
=>aa99bb
0
=>-1
0xdE0
=>0xDDF
0xffFf0
=>0xfffef
0xfffF0
=>0xFFFEF
0x0
=>0xffffffffffffffff
0Xf
=>0Xe
0b100
=>0b010
0B100
=>0B011
True
=>False
On
=>Off
Sun
=>Sat
Jan
=>Dec
Monday
=>Sunday
August
=>July
/
=>*
++
=>--
==
=>!=
!==
=>===
||
=>&&
or
=>and
- ...
自定义退出键
你可以使用以下选项来自定义退出键,以更好地符合你的偏好,比如 jj
或 jk
等。
ZVM_VI_ESCAPE_BINDKEY
: 所有模式下的 vi 退出键(默认为^[
=>ESC
)ZVM_VI_INSERT_ESCAPE_BINDKEY
: 插入模式下的 vi 退出键(默认为$ZVM_VI_ESCAPE_BINDKEY
)ZVM_VI_VISUAL_ESCAPE_BINDKEY
: 可视模式下的 vi 退出键(默认为$ZVM_VI_ESCAPE_BINDKEY
)ZVM_VI_OPPEND_ESCAPE_BINDKEY
: 操作符待定模式下的 vi 退出键(默认为$ZVM_VI_ESCAPE_BINDKEY
)
例如:
# 仅在插入模式下将退出键更改为 `jk`,我们仍然在其他模式下使用默认的 `^[` 键绑定
ZVM_VI_INSERT_ESCAPE_BINDKEY=jk
读键引擎
该插件支持选择读键引擎来读取和处理按键事件。可以通过 ZVM_READKEY_ENGINE
选项轻松实现,目前支持以下引擎:
ZVM_READKEY_ENGINE_NEX
: 这是一个更好的读键引擎,用于替代 ZLE(测试版)。ZVM_READKEY_ENGINE_ZLE
: 这是 Zsh 的默认读键引擎(ZLE)。ZVM_READKEY_ENGINE_DEFAULT
: 这是该插件的默认引擎(目前是 NEX 引擎)。
NEX 是一个比 Zsh 的 ZLE 引擎更好的读取和处理按键事件的引擎,目前 NEX 引擎仍处于测试阶段,如果你愿意,可以切换回 Zsh 的 ZLE 引擎。
例如:
# 切换到 Zsh 的默认读键引擎
ZVM_READKEY_ENGINE=$ZVM_READKEY_ENGINE_ZLE
你可以使用 ZVM_KEYTIMEOUT
选项来调整等待下一个按键的输入超时时间,默认为 0.4
秒。
退出键是一个特殊情况,它可以单独使用。NEX 引擎在接收到退出字符后会等待一段时间,以确定它是单独使用还是转义序列的一部分。在等待期间,额外的按键会使退出键表现为元键。如果没有其他按键输入,它将被视为单独的退出键。
对于 NEX 引擎,我们可以使用 ZVM_ESCAPE_KEYTIMEOUT
选项来调整退出键的等待超时时间,默认为 0.03
秒。
配置函数
由于有些配置选项依赖于插件中定义的一些变量,而有些则不依赖。我们需要提供一个统一的配置入口函数。入口函数的名称存储在一个名为 ZVM_CONFIG_FUNC
的选项中,默认值为 zvm_config
,你可以根据自己的喜好更改为其他名称。
如果这个配置函数存在,它将被自动调用,你可以在加载这个插件之前在这个方面进行一些配置。例如:
function zvm_config() {
ZVM_LINE_INIT_MODE=$ZVM_MODE_INSERT
ZVM_VI_INSERT_ESCAPE_BINDKEY=jk
}
source ~/zsh-vi-mode.zsh
执行额外命令
该插件提供了一种执行额外命令的机制,现在你可以在以下方面执行一些操作:
zvm_before_init_commands=()
zvm_after_init_commands=()
zvm_before_select_vi_mode_commands=()
zvm_after_select_vi_mode_commands=()
zvm_before_lazy_keybindings_commands=()
zvm_after_lazy_keybindings_commands=()
由于默认的初始化模式,该插件会覆盖之前的键绑定,这会导致其他插件(如 fzf
、zsh-autocomplete
等)的键绑定失效。
你可以按以下方式解决兼容性问题:
# 直接追加一个命令
zvm_after_init_commands+=('[ -f ~/.fzf.zsh ] && source ~/.fzf.zsh')
或者
# 定义一个初始化函数并追加到 zvm_after_init_commands
function my_init() {
[ -f ~/.fzf.zsh ] && source ~/.fzf.zsh
}
zvm_after_init_commands+=(my_init)
或者
# 插件会自动执行这个 zvm_after_init 函数
function zvm_after_init() {
[ -f ~/.fzf.zsh ] && source ~/.fzf.zsh
}
或者如果你使用的是 zinit
:
# 推迟加载 `fzf`
zinit ice lucid wait
zinit snippet OMZP::fzf
默认情况下,延迟键绑定功能是启用的,所有 normal
和 visual
模式的键绑定应该通过 zvm_after_lazy_keybindings_commands
执行。例如:
# 插件会自动执行这个 zvm_after_lazy_keybindings 函数
function zvm_after_lazy_keybindings() {
bindkey -M vicmd 's' your_normal_widget
bindkey -M visual 'n' your_visual_widget
}
自定义小部件和键绑定
该插件提供了两个函数,用于定义自定义小部件和键绑定。为了避免不必要的问题,最好使用它们,特别是当你遇到按键冲突时。
要定义一个自定义小部件,你应该:
# 如果 [your_custom_widget] 被忽略,它将与 <your_custom_widget> 相同
zvm_define_widget <your_custom_widget> [your_custom_function]
要定义一个键绑定,你应该:
zvm_bindkey <keymap> <keys> <widget>
例如:
# 你的自定义小部件
function my_custom_widget() {
echo 'Hello, ZSH!'
}
# 插件会自动执行这个 zvm_after_lazy_keybindings 函数
function zvm_after_lazy_keybindings() {
# 在这里我们定义自定义小部件
zvm_define_widget my_custom_widget
# 在普通模式下,按 Ctrl-E 调用这个小部件
zvm_bindkey vicmd '^E' my_custom_widget
}
Vi 模式指示器
该插件提供了一个 ZVM_MODE
变量,用于获取当前的 vi 模式并更好地显示指示器。
目前支持以下模式:
ZVM_MODE_NORMAL
ZVM_MODE_INSERT
ZVM_MODE_VISUAL
ZVM_MODE_VISUAL_LINE
ZVM_MODE_REPLACE
要更新 vi 模式指示器,我们应该将命令添加到 zvm_after_select_vi_mode_commands
中。例如:
# 插件将自动执行此 zvm_after_select_vi_mode 函数
function zvm_after_select_vi_mode() {
case $ZVM_MODE in
$ZVM_MODE_NORMAL)
# 你想做的事情...
;;
$ZVM_MODE_INSERT)
# 你想做的事情...
;;
$ZVM_MODE_VISUAL)
# 你想做的事情...
;;
$ZVM_MODE_VISUAL_LINE)
# 你想做的事情...
;;
$ZVM_MODE_REPLACE)
# 你想做的事情...
;;
esac
}
自定义光标样式
该插件为用户提供了一些选项,以自定义光标样式,以获得更好的终端兼容性。
- 你可以通过
ZVM_CURSOR_STYLE_ENABLED
选项禁用此功能(默认为true
)
# 禁用光标样式功能
ZVM_CURSOR_STYLE_ENABLED=false
- 你可以为不同的 vi 模式设置光标样式:
# 普通模式下的提示符光标
ZVM_NORMAL_MODE_CURSOR
# 插入模式下的提示符光标
ZVM_INSERT_MODE_CURSOR
# 可视模式下的提示符光标
ZVM_VISUAL_MODE_CURSOR
# 可视行模式下的提示符光标
ZVM_VISUAL_LINE_MODE_CURSOR
# 操作符待定模式下的提示符光标
ZVM_OPPEND_MODE_CURSOR
- 支持以下光标样式:
ZVM_CURSOR_USER_DEFAULT
ZVM_CURSOR_BLOCK
ZVM_CURSOR_UNDERLINE
ZVM_CURSOR_BEAM
ZVM_CURSOR_BLINKING_BLOCK
ZVM_CURSOR_BLINKING_UNDERLINE
ZVM_CURSOR_BLINKING_BEAM
- 自定义光标样式很简单,如下所示:
ZVM_INSERT_MODE_CURSOR=$ZVM_CURSOR_BEAM
ZVM_NORMAL_MODE_CURSOR=$ZVM_CURSOR_BLOCK
ZVM_OPPEND_MODE_CURSOR=$ZVM_CURSOR_UNDERLINE
- 还可以自定义彩色光标样式,如下所示:
# 插件将自动执行此 zvm_config 函数
zvm_config() {
# 获取默认光标样式
local ncur=$(zvm_cursor_style $ZVM_NORMAL_MODE_CURSOR)
local icur=$(zvm_cursor_style $ZVM_INSERT_MODE_CURSOR)
# 为光标添加自定义颜色
ZVM_INSERT_MODE_CURSOR=$icur'\e\e]12;red\a'
ZVM_NORMAL_MODE_CURSOR=$ncur'\e\e]12;#008800\a'
}
我们可以使用 ZVM_TERM
选项为插件设置终端类型以处理终端转义序列,默认为 $TERM
。它可以是 xterm-256color
、alacritty-256color
、st-256color
等。对于某些终端模拟器来说,这对于正确显示光标很重要。
高亮行为
你可以使用 ZVM_VI_HIGHLIGHT_BACKGROUND
、ZVM_VI_HIGHLIGHT_FOREGROUND
和 ZVM_VI_HIGHLIGHT_EXTRASTYLE
来更改高亮行为(包括环绕、可视行等),颜色值可以是颜色名称或十六进制颜色值。
例如:
ZVM_VI_HIGHLIGHT_FOREGROUND=green # 颜色名称
ZVM_VI_HIGHLIGHT_FOREGROUND=#008800 # 十六进制值
ZVM_VI_HIGHLIGHT_BACKGROUND=red # 颜色名称
ZVM_VI_HIGHLIGHT_BACKGROUND=#ff0000 # 十六进制值
ZVM_VI_HIGHLIGHT_EXTRASTYLE=bold,underline # 粗体和下划线
命令行初始模式
你可以通过 ZVM_LINE_INIT_MODE
选项设置命令行初始模式。
目前支持以下模式:
ZVM_MODE_LAST
: 从上一次的模式开始(默认)。ZVM_MODE_INSERT
: 从插入模式开始。ZVM_MODE_NORMAL
: 从普通模式开始。
例如:
# 每个命令行总是从插入模式开始
ZVM_LINE_INIT_MODE=$ZVM_MODE_INSERT
延迟键绑定
该插件支持延迟键绑定功能,默认启用。要禁用它,你可以在加载此插件之前将 ZVM_LAZY_KEYBINDINGS
选项设置为 false
。此功能将推迟所有 normal
和 visual
模式的键绑定,直到你第一次进入普通模式。
这可以大大提高启动速度,特别是当你打开终端只想执行一个简单的命令时。
初始化模式
为了防止由插件加载顺序引起的各种与键绑定相关的问题,同时保持插件的功能不变,插件的初始化被推迟到第一个命令行开始时。
然而,几乎所有插件都在脚本被加载时初始化。因此,该插件提供了一个 ZVM_INIT_MODE
选项来更改初始化模式。
例如:
# 在脚本被加载时进行初始化(即立即初始化)
ZVM_INIT_MODE=sourcing
💎 致谢
- Zsh - 一个既可作为交互式 shell 又可作为脚本语言解释器的强大 shell。
- Oh-My-Zsh - 一个令人愉快的、开源的、社区驱动的 ZSH 配置管理框架。
- vim-surround - 一个 vim 插件,专注于"环绕":括号、方括号、引号、XML 标签等。
- vim-sandwich - 一套操作符和文本对象插件,用于添加/删除/替换被包围的文本对象。
🔫 贡献
非常感谢问题报告和拉取请求。如果你从未为开源项目做出过贡献,我很乐意指导你如何创建拉取请求。
你可以从开启一个问题开始,描述你想要解决的问题,我们将从那里开始。
🌈 许可证
本主题基于 MIT 许可证 © Jeffrey Tse。