Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freed-wu/ime.nvim
auto switch IME for neovim.
https://github.com/freed-wu/ime.nvim
fcitx5 ibus lua neovim rime vim-plugin
Last synced: 2 months ago
JSON representation
auto switch IME for neovim.
- Host: GitHub
- URL: https://github.com/freed-wu/ime.nvim
- Owner: Freed-Wu
- License: gpl-3.0
- Created: 2024-07-20T15:22:03.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-09T20:07:00.000Z (4 months ago)
- Last Synced: 2024-09-10T00:42:36.477Z (4 months ago)
- Topics: fcitx5, ibus, lua, neovim, rime, vim-plugin
- Language: Lua
- Homepage: https://luarocks.org/modules/Freed-Wu/ime.nvim
- Size: 61.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ime.nvim
[](https://results.pre-commit.ci/latest/github/Freed-Wu/ime.nvim/main)
[](https://github.com/Freed-Wu/ime.nvim/actions)
[](https://github.com/Freed-Wu/ime.nvim/releases)
[](https://github.com/Freed-Wu/ime.nvim/releases/latest)
[](https://github.com/Freed-Wu/ime.nvim/issues)
[](https://github.com/Freed-Wu/ime.nvim/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/Freed-Wu/ime.nvim/pulls)
[](https://github.com/Freed-Wu/ime.nvim/pulls?q=is%3Apr+is%3Aclosed)
[](https://github.com/Freed-Wu/ime.nvim/discussions)
[](https://github.com/Freed-Wu/ime.nvim/milestones)
[](https://github.com/Freed-Wu/ime.nvim/network/members)
[](https://github.com/Freed-Wu/ime.nvim/stargazers)
[](https://github.com/Freed-Wu/ime.nvim/watchers)
[](https://github.com/Freed-Wu/ime.nvim/graphs/contributors)
[](https://github.com/Freed-Wu/ime.nvim/graphs/commit-activity)
[](https://github.com/Freed-Wu/ime.nvim/commits)
[](https://github.com/Freed-Wu/ime.nvim/releases/latest)
[](https://github.com/Freed-Wu/ime.nvim/blob/main/LICENSE)
[](https://github.com/Freed-Wu/ime.nvim)
[](https://github.com/Freed-Wu/ime.nvim)
[](https://github.com/Freed-Wu/ime.nvim)
[](https://github.com/Freed-Wu/ime.nvim)
[](https://github.com/Freed-Wu/ime.nvim)
[](https://github.com/Freed-Wu/ime.nvim)
[](https://luarocks.org/modules/Freed-Wu/ime.nvim)
Switch back from IME after `InsertLeave`. Powered by dbus.
## Introduction
### Multi-mode IME
- Vim (include other editors who have a vim emulator) is mulit-mode editor:
- insert mode
- normal mode
- ...
- IME is also multi-mode mostly:
- ASCII mode
- CJKV mode
- ...
In insert mode, we can switch IME mode to input ASCII characters or CJKV
characters. However, in other modes of Vim, only ASCII mode can work: Vim will
not response any CJKV character. So we must switch back from IME after
`InsertLeave`.
Currently, we have two schemes to realize it:
#### IME inside Vim
- no dependencies of GUI
- support remote machines: ssh, telnet, ...
1. Vim passes user's input to IME by librime/dbus
2. IME passes the result to Vim by librime/dbus
3. Vim draw UI of Vim IME window
4. When user `InsertLeave`, we close Vim IME window.
##### [librime](https://github.com/rime/librime)
librime is a library for creating IME.
- [coc-rime](https://github.com/tonyfettes/coc-rime): written in javascript
- [rime.nvim](https://github.com/Freed-Wu/rime.nvim): written in lua
##### [dbus](https://dbus.freedesktop.org/)
dbus is an inter process communication system. we can communicate with an
external IME.
- [fcitx5.nvim](https://github.com/tonyfettes/fcitx5.nvim): for fcitx5
- [fcitx5-ui.nvim](https://github.com/black-desk/fcitx5-ui.nvim): for fcitx5
#### IME outside Vim
- support more hotkeys
- same settings as IME for other windows
1. call IME to switch back to ASCII mode when `InsertLeave` by CLI/dbus
##### CLI
Some IMEs provide a CLI program to switch mode.
- [issw](https://github.com/vovkasm/input-source-switcher): for macOS
- [macism](https://github.com/laishulu/macism): for macOS
- [im-select](https://github.com/daipeihust/im-select): for macOS and Windows
- `ibus engine`: for ibus
- `g3kb-switch`: for ibus, and provide a DLL
- `xkb-switch`: for xim, and provide a DLL
- `fcitx-remote`: for fcitx5
Some Vim plugins use CLI:
- [nvim-auto-ime](https://github.com/crispgm/nvim-auto-ime): only support macism
- [im-select.nvim](https://github.com/keaising/im-select.nvim): support
im-select, ibus, fcitx
##### dbus
- [vim-xkbswitch](https://github.com/lyokha/vim-xkbswitch): support g3kb-switch,
xkb-switch and issw by their DLLs, where g3kb-switch utilizes dbus and is
written in C
- [fcitx.vim](https://github.com/lilydjwg/fcitx.vim): support fcitx and
fcitx5-rime. written in python
- This plugin: support
- fcitx5: with or without rime input schema
- ibus
- gnome-shell: you can get IME information from gnome-shell whatever you use
which IME. You need
[unsafe-mode-menu](https://github.com/linushdot/unsafe-mode-menu)
to open unsafe mode in latest gnome-shell.
- g3kb-switch: or use it to bypass security prohibit.
> In Gnome 41 and newer, the switcher will only work with G3kbSwitch Gnome Shell
> extension, because method org.gnome.Shell.Eval which was used in the original
> implementation of the switcher is now disabled for security reasons
>
> -- [g3kb-switch](https://github.com/lyokha/g3kb-switch#gnome-45-and-newer)
### single-mode IME
Editor can provide a popup menu to let user select candidate. If user use
Ctrl + P/N to select, input CJKV characters.
Otherwise, input ASCII characters.
- more key pressing, the 10-th candidation need 10 times
Ctrl + N
- ASCII characters cannot be near CJKV characters.
`hi nihao` will complete `nihao`, `hinihao` will complete `hinihao`.
However, it shouldn't happen. Because:
> 中英文之間需要增加空格
>
> -- [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines#%E4%B8%AD%E8%8B%B1%E6%96%87%E4%B9%8B%E9%96%93%E9%9C%80%E8%A6%81%E5%A2%9E%E5%8A%A0%E7%A9%BA%E6%A0%BC)
We can create:
- a language server to support all editors which supports LSP.
The editor will manage the popup menu according to LSP.
- an editor specific plugin.
- register a completion source of other editor plugins which manage the popup
menu
- manage the popup menu by itself
#### LSP
- [ds-pinyin-lsp](https://github.com/iamcco/ds-pinyin-lsp): only support full
pinyin.
#### [coc.nvim](https://github.com/neoclide/coc.nvim)
- [coc-rime](https://github.com/tonyfettes/coc-rime): written in javascript
#### [nvim-cmp](https://github.com/hrsh7th/nvim-cmp)
- [cmp-rime](https://github.com/Ninlives/cmp-rime): written in python
- [rime.nvim](https://github.com/Freed-Wu/rime.nvim#nvim-cmp): written in lua
##### Manage popup menu by itself
Manage popup menu by itself will result in the conflict with other editor
plugins which manage the popup menu.
At the same time, you must enable one of them.
> Sorry, you have to make the choice.
>
> -- [coc-snippets](https://github.com/neoclide/coc-snippets/issues/137)
- [vimIM](https://github.com/vim-scripts/VimIM): stop maintenance
- [ZFVimIM](https://github.com/ZSaberLv0/ZFVimIM): a rewrite of vimIM.
It will
[disable most completion plugins](https://github.com/ZSaberLv0/ZFVimIM/blob/master/plugin/ZFVimIM_autoDisable.vim)
when it is enabled.
## Dependencies
```sh
# Ubuntu
sudo apt-get -y install libgirepository-1.0-1 libgirepository1.0-dev pkg-config
sudo apt-mark auto libgirepository1.0-dev pkg-config
# ArchLinux
sudo pacman -S libgirepository pkg-config
# Android Termux
apt-get -y install gobject-introspection pkg-config
# Nix
# use nix-shell to create a virtual environment then build
```
## Install
### rocks.nvim
#### Command style
```vim
:Rocks install ime.nvim
```
#### Declare style
`~/.config/nvim/rocks.toml`:
```toml
[plugins]
"ime.nvim" = "scm"
```
Then
```vim
:Rocks sync
```
or:
```sh
$ luarocks --lua-version 5.1 --local --tree ~/.local/share/nvim/rocks install ime.nvim
# ~/.local/share/nvim/rocks is the default rocks tree path
# you can change it according to your vim.g.rocks_nvim.rocks_path
```
For NixOS, `export $GI_TYPELIB_PATH` in your shell profile to make
`require'dbus_proxy'` work. Refer my
[`~/.bash_profile`](https://github.com/Freed-Wu/Freed-Wu/blob/main/.bash_profile).