Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lambdalisue/vim-kensaku
🔍 Search Japanese text in Vim's buffer with Roma-ji by Migemo
https://github.com/lambdalisue/vim-kensaku
migemo neovim vim
Last synced: 7 days ago
JSON representation
🔍 Search Japanese text in Vim's buffer with Roma-ji by Migemo
- Host: GitHub
- URL: https://github.com/lambdalisue/vim-kensaku
- Owner: lambdalisue
- License: mit
- Created: 2023-01-16T17:02:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-03T09:51:53.000Z (3 months ago)
- Last Synced: 2024-10-04T11:58:46.491Z (about 1 month ago)
- Topics: migemo, neovim, vim
- Language: TypeScript
- Homepage:
- Size: 69.3 KB
- Stars: 64
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🔍 kensaku.vim
[](https://github.com/denoland/deno/tree/v1.45.0)
[](https://github.com/vim/vim/tree/v9.1.0448)
[](https://github.com/neovim/neovim/tree/v0.10.0)
[](LICENSE)
[](doc/kensaku.jax)
[](https://github.com/lambdalisue/kensaku.vim/actions/workflows/test.yml)
Kensaku (_kensaku.vim_) は Migemo
を利用してローマ字のまま日本語検索を行う最低限の機能を提供するプラグインです。
既存の Migemo プラグインとは異なり JavaScript で実装された [jsmigemo][jsmigemo]
を利用するため [C/Migemo][c/migemo] のインストールは不要です。
[jsmigemo]: https://github.com/oguna/jsmigemo
[c/migemo]: https://www.kaoriya.net/software/cmigemo/
## 必須条件
Kensaku は denops プラグインとして作られているため [Deno](https://deno.land) と
[vim-denops/denops.vim][vim-denops/denops.vim]
がインストールされている必要があります。
- [vim-denops/denops.vim][vim-denops/denops.vim]
An ecosystem for writing
Vim/Neovim plugin in Deno.
[vim-denops/denops.vim]: https://github.com/vim-denops/denops.vim
## インストール
[Deno](https://deno.land) をインストール後
[vim-plug](https://github.com/junegunn/vim-plug)
などを利用して以下の様にインストールします。
```vim
Plug 'vim-denops/denops.vim'
Plug 'lambdalisue/kensaku.vim'
```
## 利用方法
### インテグレーションプラグイン
必要なインターフェースを提供するインテグレーションプラグインを利用します。
- [lambdalisue/kensaku-command.vim](https://github.com/lambdalisue/kensaku-command.vim)
ローマ字によるバッファ内日本語検索を行う
`Kensaku` コマンドを提供するプラグイン
- [lambdalisue/kensaku-search.vim](https://github.com/lambdalisue/kensaku-search.vim)
`/` や `?` による検索にローマ字による日本語検索を自然に提供するプラグイン
- [Milly/ddu-filter-kensaku](https://github.com/Milly/ddu-filter-kensaku)
[Shougo/ddu.vim](https://github.com/Shougo/ddu.vim)
にてローマ字による日本語フィルタを有効にするプラグイン
- [ompugao/ctrlp-kensaku](https://github.com/ompugao/ctrlp-kensaku)
[ctrlpvim/ctrlp.vim](https://github.com/ctrlpvim/ctrlp.vim)
にてローマ字による日本語フィルタを有効にするプラグイン
- [yuki-yano/fuzzy-motion.vim](https://github.com/yuki-yano/fuzzy-motion.vim)
バッファ内の任意の場所にジャンプする際にローマ字指定で日本語を指定可能
### TypeScript からの利用 (denops)
[`denops.dispatch()`](https://jsr.io/@denops/[email protected]/doc/type/~/Denops.dispatch)
を利用して `query` 関数を呼び出します。
```
const pattern = await denops.dispatch("kensaku", "query", "kensaku");
```
### Vim script からの利用
`kensaku#query()` を以下のように呼び出します。
```vim
function! Search(value) abort
let @/ = a:value
normal! n
endfunction
call Search(kensaku#query('kensaku'))
```
上記は処理を同期的に待つので、非同期が必要な場合は代わりに
`kensaku#query_async()` を利用します。
```vim
function! Search(value) abort
let @/ = a:value
normal! n
endfunction
call kensaku#query_async(
\ 'kensaku',
\ { v -> Search(v) },
\)
```
## 正規表現モードに関して (magic/very magic)
`kensaku#query()` がデフォルトで返す正規表現には `\m` が含まれるようになったため
`\v` や `\m` の前置が不要になりました。 なお、この挙動はデフォルトの `"rxop"`
(`g:kensaku#rxop#vim`) で定義されているため、カスタムの `"rxop"`
を指定した場合は別です。
## 参考情報
- [Migemo: ローマ字のまま日本語をインクリメンタル検索](http://0xcc.net/migemo/)
- [辞書構造を工夫した Migemo 実装の紹介](https://qiita.com/oguna/items/c70e8c409b663d74113e)
- [Vim で migemo を使って日本語でもローマ字のまま検索がしたい](http://haya14busa.com/vim_migemo_search/)
## License
The code in this repository follows MIT license, texted in [LICENSE](./LICENSE).
Contributors need to agree that any modifications sent in this repository follow
the license.