https://github.com/rimeinn/coc-rime
ㄓ Rime input method source for coc.nvim
https://github.com/rimeinn/coc-rime
coc neovim rime vim
Last synced: 9 months ago
JSON representation
ㄓ Rime input method source for coc.nvim
- Host: GitHub
- URL: https://github.com/rimeinn/coc-rime
- Owner: rimeinn
- License: mit
- Created: 2020-08-28T14:44:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-08-18T19:12:52.000Z (10 months ago)
- Last Synced: 2025-08-18T21:19:33.702Z (10 months ago)
- Topics: coc, neovim, rime, vim
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/coc-rime
- Size: 645 KB
- Stars: 34
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# coc-rime
[](https://results.pre-commit.ci/latest/github/rimeinn/coc-rime/master)
[](https://github.com/rimeinn/coc-rime/actions)
Rime input method integration of coc.nvim
> This extension is created by [create-coc-extension](https://github.com/fannheyward/create-coc-extension)
## Dependencies
- [librime](https://github.com/rime/librime)
For build, need extra them:
- [pkg-config](http://pkg-config.freedesktop.org/)
- [xmake](https://github.com/xmake-io/xmake)
```sh
# Ubuntu
sudo apt-get -y install pkg-config librime-dev librime1 xmake
sudo apt-mark auto librime-dev pkg-config xmake
# ArchLinux
sudo pacman -S pkg-config librime xmake
# Android Termux
apt-get -y install pkg-config librime xmake
# Nix
# without any extra operation
# homebrew
brew install pkg-config librime xmake
# Windows msys2
pacboy -S --noconfirm pkg-config librime gcc xmake
```
## Install
- [coc-marketplace](https://github.com/fannheyward/coc-marketplace)
- [npm](https://www.npmjs.com/package/coc-rime)
- vim:
```vim
" command line
CocInstall coc-rime
" or add the following code to your vimrc
let g:coc_global_extensions = ['coc-rime', 'other coc-plugins']
```
## Commands
1. `rime.source.enable`: enable this source temporarily.
2. `rime.source.disable`: disable this source temporarily.
3. `rime.source.toggle`: temporarily toggle the status of the source.
4. `rime.enable`: enable this IME temporarily.
5. `rime.disable`: disable this IME temporarily.
6. `rime.toggle`: toggle this IME temporarily.
## Lists
You could use `CocList` to switch between schema.
```vim
:CocList rime_schema
```
## User Configuration
1. `rime.enabled`: Whether to enable this source.
2. `rime.priority`: The priority of this completion source.
3. `rime.schemaId`: The `schemaId` selected when `coc-rime` start.
You could get it from `rime_schema` list.
4. `rime.priority`: Priority of Rime completion source
5. `rime.traits.shared_data_dir`: Path(s) where rime data stores
6. `rime.traits.user_data_dir`: Path(s) where rime configuration stores
7. `rime.traits.*`: More rime traits
8. `rime.ui.*`: The symbols used for IME UI
## Limitations
- It will break all `imap ` created by other plugins, such as
[vim-peekaboo](http://github.com/junegunn/vim-peekaboo)'s ``.
## License
MIT
## Related Projects
- [rime.nvim](https://github.com/rimeinn/rime.nvim): lua implementation