Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qianbinbin/vim-autoim
macOS 版 Vim 自动切换输入法 | Automatically switches input methods for Vim on macOS
https://github.com/qianbinbin/vim-autoim
macos vim vim-plugin
Last synced: 7 days ago
JSON representation
macOS 版 Vim 自动切换输入法 | Automatically switches input methods for Vim on macOS
- Host: GitHub
- URL: https://github.com/qianbinbin/vim-autoim
- Owner: qianbinbin
- License: mit
- Created: 2024-01-19T06:33:05.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-01-22T06:17:02.000Z (11 months ago)
- Last Synced: 2024-10-29T17:21:35.539Z (about 2 months ago)
- Topics: macos, vim, vim-plugin
- Language: Vim Script
- Homepage:
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[English](#English)
***
## vim-autoim
这是 macOS 版 Vim 自动切换输入法的插件，它只做两件事：
* 进入输入模式时，恢复到上次的输入法。
* 退出输入模式时，切换到英文输入法。
### 前提条件
* 系统配置单独的英文输入法，如“美国”或“ABC”。
* 开启 Ctrl + Space 切换输入法的快捷键。
### 安装
#### [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'qianbinbin/vim-autoim'
```
### 配置
#### 默认英文输入法
切换到英文输入法，并运行以下命令获取英文输入法的 ID：
```sh
defaults read ~/Library/Preferences/com.apple.HIToolbox.plist AppleCurrentKeyboardLayoutInputSourceID
```
如结果为 `com.apple.keylayout.US` 则无需配置，否则在 `~/.vimrc` 中加入：
```vim
let g:autoim_en = 'com.apple.keylayout.US'
```
将 `com.apple.keylayout.US` 改为你自己的英文输入法 ID，如 `com.apple.keylayout.ABC`。
#### 允许使用辅助功能
首次使用时，你的终端或 iTerm 等会要求使用辅助功能，允许即可。这是因为插件需要模拟键盘操作。
#### 减小延迟
如果你在退出输入模式时感到延迟，在 `~/.vimrc` 加入：
```vim
set ttimeoutlen=0
```
注意 `ttimeoutlen` 不是 `timeoutlen`，后者会造成组合键映射失效。
### 感谢
* [自动切换 vim 中文输入法](https://taoshu.in/vim/vim-auto-im.html)
* [smartim](https://github.com/ybian/smartim)
* [vimrc - Usage of timeoutlen and ttimeoutlen - Vi and Vim Stack Exchange](https://vi.stackexchange.com/a/24938)
* [Eliminating delays on ESC in vim and zsh - John Hawthorn](https://www.johnhawthorn.com/2012/09/vi-escape-delays/)
* [Delay when entering Insert mode in a terminal buffer · Issue #3743 · neovim/neovim](https://github.com/neovim/neovim/issues/3743#issuecomment-159642147)
### 为什么不使用 smartim
smartim 使用的 im-select 有概率性 bug：在进入输入模式并自动切换输入法后，即使菜单栏已经显示切换成功，输入的仍是英文。
***
## English
This is a plugin for Vim on macOS that automatically switches input methods.
It just does two things:
* When entering insert mode, restore the last used input method.
* When leaving insert mode, switch to English input method.
### Prerequisites
* Set up a separate English input method, such as "U.S." or "ABC".
* Enable the shortcut key Ctrl + Space for switching input methods.
### Installation
#### [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug 'qianbinbin/vim-autoim'
```
### Configuration
#### The Default English Input Method
Switch to the English input method and execute the following command to obtain the ID:
```sh
defaults read ~/Library/Preferences/com.apple.HIToolbox.plist AppleCurrentKeyboardLayoutInputSourceID
```
If the output is `com.apple.keylayout.US`, no further configuration is needed.
Otherwise, add the following line to `~/.vimrc`:
```vim
let g:autoim_en = 'com.apple.keylayout.US'
```
Replace `com.apple.keylayout.US` with your own English input method ID, such as `com.apple.keylayout.ABC`.
#### Allow Accessibility Access
Upon first usage, your terminal APP will prompt for accessibility access.
Please allow it as the plugin requires simulating keyboard operations.
#### Reduce Latency
If you experience a delay when leaving insert mode, add the following line to `~/.vimrc`:
```vim
set ttimeoutlen=0
```
Note that `ttimeoutlen` is not the same as `timeoutlen`,
as the latter can cause the mappings to fail.
### Credits
* [自动切换 vim 中文输入法](https://taoshu.in/vim/vim-auto-im.html)
* [smartim](https://github.com/ybian/smartim)
* [vimrc - Usage of timeoutlen and ttimeoutlen - Vi and Vim Stack Exchange](https://vi.stackexchange.com/a/24938)
* [Eliminating delays on ESC in vim and zsh - John Hawthorn](https://www.johnhawthorn.com/2012/09/vi-escape-delays/)
* [Delay when entering Insert mode in a terminal buffer · Issue #3743 · neovim/neovim](https://github.com/neovim/neovim/issues/3743#issuecomment-159642147)
### Why Not smartim
There is a probabilistic bug with `im-select` used by smartim.
Even after entering insert mode and automatically restoring the input method,
there are cases where the input remains in English,
despite the input method being successfully displayed in the menu bar.