🖤

新世代の自動補完プラグイン ddc.vim

14 min read

始めに

ここ数ヵ月力を入れてddc.vimの開発をしていて、ようやく一通りの機能がそろいましたので、広くユーザーに使ってもらうフェーズに進めたいと考えています。
ユーザーからの要望やバグ報告に対応が終わってから正式版の1.0となりますのでよろしくお願いします。

https://github.com/Shougo/ddc.vim

私が以前に作成した自動補完プラグインであるdeoplete.nvimは既に開発を終了しました。
私自身は既にdeoplete.nvimからddc.vimに移行しており、もはや何の不便も感じていません。動作も最初から安定していますし、自信をもってユーザーに使用を推奨することができます。

自動補完フレームワーク開発の歴史

私はこれまで数々の自動補完フレームワークを開発してきました。ここでその歴史を簡単に振り返ってみましょう。

neocomplcache.vim 2008/12 頃開発

https://github.com/Shougo/neocomplcache.vim

私が始めて作成した自動補完フレームワークは neocomplcache.vim です。
当時は Vim 7.0 となりスクリプト機能が強化され、Vim 界隈でようやくプラグインが本格的に作られはじめていた黎明期です。

私はEmacsのauto-complete.elに感銘を受け、それをVimで実装しようと考え本格的にプラグイン開発に目覚めていくことになります。

https://www.emacswiki.org/emacs/auto-complete.el

当時Vimには自動補完という概念が少しずつ登場はしてきていましたが、それらはVimの組込み補完を自動的に呼び出すものでしかなく、本格的フレームワークは登場していませんでした。
neocomplcache.vimは自動補完フレームワークとして国内を中心に爆発的な人気となり、自動補完プラグインの代名詞となりました。

neocomplcache.vimは最初から拡張性を考えられて設計されており、10 年以上前とは思えない先進的な設計とインタフェースを兼ね備えています。
その代償として内部実装は複雑化しており、オリジナル開発者の私でもメンテナンスは困難となってしまいました。
後継となるneocomplete.vimはif_lua環境でないと動作しなくなったので、neocomplete.vimが登場してもしばらくはneocomplcache.vimを愛用する人がいました。

neocomplcache.vimは2013年に開発完了しています。

neocomplete.vim 2013/06 頃開発

https://github.com/Shougo/neocomplete.vim

neocomplcache.vimは内部構造が複雑化してしまっていたのと、実装にVim scriptを用いていることによりパフォーマンスの問題が存在していました。
neocomplete.vimでは内部構造を整理、if_luaを用いることで高速化を図りました。

if_luaを用いた高速化はもちろん効果があったのですが、if_luaを用いた実装の難しさ、if_luaを用いていかに高速化を行っても補完処理が動いている最中にVimが止まるという問題点を抱えていました。
結局、その問題点を改善するためにはdeoplete.nvimを待つことになります。

neocomplete.vimは2016年に開発完了しています。

Vim 8.2.1066でif_luaに破壊的変更が加わったことでneocomplete.vimは本格的にメンテナンス不能となりました。現在使用は推奨されません。

https://github.com/vim/vim/commit/bd84617d1a6766efd59c94aabebb044bef805b99

deoplete.nvim 2015/06 頃開発

https://github.com/Shougo/deoplete.nvim

deoplete.nvimはneovimのリモートプラグイン機構を用いることでneocomplete.vimの欠点を解消することを目指して開発されました。
実装にはPythonを用いることでVim scriptよりパフォーマンスの向上を達成し、補完中にもVimが固まることを防ぎます。
PythonのほうがVim scriptより簡潔な表現が可能であるため、deoplete.nvimではメンテナンス性の向上を果たしてもいます。

deoplete.nvimは実装にPythonを用いているので読み書きできる人がVim scriptより圧倒的に多いのが利点です。
開発に貢献してくれる人もneocomplcache,neocompleteと比較して大幅に増えました。

deoplete.nvimはneocomplete.vimより明らかにプルリクエストが多いです。

https://github.com/Shougo/neocomplete.vim/pulls

https://github.com/Shougo/deoplete.nvim/pulls

deoplete.nvimは当初neovim専用のプラグインでしたが、後にvim-hug-neovim-rpcとnvim-yarpを用いることでVim8への対応を実現します。
それでもdeoplete.nvimはneovimでの用途を優先して開発したプラグインであり、Vim8との互換性には大きな制限がありました。

https://github.com/roxma/vim-hug-neovim-rpc
https://github.com/roxma/nvim-yarp

deoplete.nvimでは他プラグイン開発の経験をフィードバックしました。deoplete.nvimは変数を廃止して関数に統一することで設定項目を整理しています。従来のものより分かりやすくはなっていますが、まだ旧来の仕様を引きずっている部分があります。
設定に関する抜本的な改革はddc.vim世代を待つ必要があります。

deoplete.nvimは2021年に開発完了しています。

ddc.vim 2021/06 頃開発

https://github.com/Shougo/ddc.vim

deoplete.nvimの開発から長い年月が経過したことで、自動補完関連のトレンドも大きく変化しています。
昔は過渡的な技術であったLSP による補完は一般的なものとなり、neovimはリモートプラグインのサポートからLuaに大きく軸足を移しています。
Vimとneovimの仕様の乖離は年を重ねる毎に大きくなっており、Vim/neovim両対応のプラグイン開発は困難になりつつありました。

ddc.vimは実装にDenops.vimを用いることによりdeoplete.nvimの欠点を解消するべく開発が開始されました。その結果、自分がやりたかったものはほとんど全て盛り込むことができたと考えています。

ddc.vim は現在絶賛開発中です。

ddc.vim の特徴

Vim8/neovim 両対応、環境依存が少なくインストールが容易

deoplete.nvimでもvim-hug-neovim-rpcを用いることによりVimに対応していました。
しかしインストールが煩雑になる、neovimと比較してパフォーマンスに問題がある、安定性への問題がありました。

ddc.vimではdenops.vimというフレームワークを利用することにより、Vim/neovimの両方で安定して動作するようになっています。
昨今新しく開発される自動補完プラグインはneovimに特化したものが多いので、両対応しているのは大きな利点だと思います。

ddc.vimはWindows環境でも十分な速度が出ることが分かっています。広く宣伝してしばらくたちましたが、ddc.vimのユーザーにはVim8/Windowsでの使用者が多いようです。
従来の自動補完プラグインではそれらの環境でうまく動かなかったということでしょう。

Python 非依存、Deno 依存

deoplete.nvimはプラグインの実装にPythonを利用していました。Pythonはライブラリが充実しておりよい言語であるのですが、あまりにいろんな環境で使われているがゆえに特殊な環境だとプラグインがうまく動作しないということがよくありました。
deoplete.nvimを開発した当時はPythonでリモートプラグインという選択は間違っていなかったと思うのですが、deoplete.nvimの開発から6年も経過しておりデメリットを無視するのも難しくなってきました。
neovim開発やユーザーがLuaでのプラグイン開発に傾倒しており、今後のリモートプラグインの改善に期待できなくなったのも理由です。Vimの開発もVim scriptを強化してVim9 scriptの推進をしていくようですので、Vimでの外部インタフェース機能についても同じ道をたどっています。
かといって、プラグイン開発をLuaやVim 9に移行するわけにはいきません。
Lua, Vim9への移行は移植性が低下しVim/neovim両方で動作することが難しくなりますし、それらはあくまで高速なVim scriptの立ち位置です。
Vim script部分がいくら高速になろうとも、処理を別のプロセスに委譲しない限りテキストエディタの負荷を下げることはできません。Vim scriptを高速化するその道は私がすでにneocomplete.vim(2014/01開発)で実践し挫折しています。

Denoはnode.jsの後継というだけあり、node.jsに似ていますがインストールアップデートが楽、依存関係の自動解決、スクリプト言語のような使い心地、環境を汚しにくいという
利点があります。ライブラリが自動的にインストールされるのはプラグイン開発にとって有用であり、これからに期待できます。私の目的にとってはDenoが最適であり、他の言語は選択肢になかったのです。

Pythonの代わりにDeno(denops.vim)に依存するのは欠点に見えるかもしれません。
しかし今後Denoで作られたツールやdenops.vimで作られたプラグインが増えることを考えると、この依存は無駄にはなりません。

Denoを用いたことにより、ddc.vim本体やsource, filterの実装はTypeScriptになりました。使用する正規表現もTypeScriptで扱えるものが基本となっています。Web 技術者にとってはコードを作りやすくなりうれしいかもしれません。

非同期処理

ddc.vimはdeoplete.nvimと同様に別プロセスで処理をしているだけでなく、プラグイン内部で非同期処理を扱うことで処理を高速化しています。これはプラグイン実装にDenoを用いたことによる利点です。
もちろんdeoplete.nvimでも非同期処理を扱うことはできたのですが、さまざまな制限が存在し自由に非同期処理を扱えるとはほど遠いものでした。これは私がdeoplete.nvimの開発を終了した理由のひとつとなります。

設定項目、設定方法の整理

ddc.vimでは従来のプラグインであるdeoplete.nvim, denite.nvimでの設定項目をより整理して汎用化することにしました。ddc.vimでは以下の設定項目があります。

  • 本体の設定
  • source/filterの設定
  • source/filter独自の設定

本体の設定はdeoplete.nvimでいう deoplete#custom#option() に相当する機能です。

source/filterの設定はdeoplete.nvimでいう deoplete#custom#source() に相当する機能です。

source/filter独自の設定はdeoplete.nvimでいう deoplete#custom#var() に相当する機能です。source/filter固有のパラメータを制御するときに使用します。

ddc.vimの設定には変数は一切存在せず、すべての設定は以下のcustom APIを用いて行うことになります。

  • グローバル設定 (ddc#custom#patch_global())
  • filetype local設定 (ddc#custom#patch_filetype())
  • バッファlocal設定 (ddc#custom#patch_buffer())

deoplete.nvim時代には、一部オプションがfiletypeを解釈していました(例:keyword_patterns)。
ddc.vimにはそのようなオプションはありません。オプションをfiletype local設定することで同じ役割を行います。

call ddc#custom#patch_filetype(['vim'], {
\ 'keywordPattern': '[a-zA-Z_][a-zA-Z_0-9:#]*',
\ })

これはdeoplete.nvimでいうと以下に相当します。

call deoplete#custom#option('keyword_patterns', {
\ 'vim': '[a-zA-Z_][a-zA-Z_0-9:#]*',
\})

source/filterの設定に関してですが、ddc.vimにはsource固有のデフォルト値は存在しません。すべてのsourceが決まったデフォルト値を持っており、ユーザーが自由に
カスタマイズできます。deoplete.nvimではsourceがユーザーのsource固有でないカスタマイズ値を上書きしてデフォルト値を設定できるという仕様でした。
つまりsourceの推奨設定をsource側でセットできたのです。たしかにこの仕様だとユーザーの設定を減らすことができると思いますが、ユーザーが自分の思う通りにsourceを制御したいと思ったときに、source側のコードを確認しないといけません。これはかなりの手間です。

ddc.vimでは、source側が何か推奨する設定をユーザーにしてほしいと思った場合、sourceのドキュメントにてサンプルを提示することが推奨されます。
ユーザーがその指示に従うかどうかは自由です。ユーザーが選択できることこそが価値なのです。

source, filter を本体から分離

ddc.vimでは標準のsource, filterを用意せず、すべて分離しています。
これによりユーザーの設定が若干増える、それぞれのsource, filterを管理する手間がかかってくるのですが利点があります。
ユーザーは好きなsource, filterを組み合わせられるということです。
キーマッピングについてもそうですが、何を標準とするかは人によって異なります。開発者が標準を押し付けるべきではない、使用する機能をユーザーが選択できることこそVimの強みなのです。
ほかは開発上の利点として、本体の開発に集中できること、個別のsourceの問題で本体のissuesが汚れないことがあげられます。
これに伴い、ddc.vimでは本体だけをインストールしても何も動かなくなっています。ddc.vimを使うにはsource, filterを適切にインストールし設定をしなければいけませんが特に難しいことはないはずです。

すべてのsourceを同梱する思想の補完プラグインもあります。YouCompleteMeがその代表です。この方式には利点があって、中央集権的に管理できてsourceの仕様変更にもすぐに対応が可能です。

基本的な補完機能のみを提供する

ddc.vim では補完機能のみを提供しており、以下のような機能は実装しません。

  • スニペット展開機能、引数の補完

  • LSP auto import の処理

  • 引数情報の表示

  • 補完候補の floating window によるプレビュー

上記の機能はIDEなら当たり前ですし、最近登場した他の補完プラグインにはあたり前のように実装されています。
なぜ機能を実装しないのかというと、これはddc.vimの設計思想と関係しています。

ddc.vimはユーザーの自由を尊重し、設定を邪魔したくないのです。例えばddc.vimがスニペット機能を組み込んでしまうと他のスニペットプラグインとは競合しますし併用できなくなります。
スニペット機能は専門のプラグインに任せるべきということです。他の入力補助機能についても同様です。

ddc.vimは純粋な補完機能のみを提供することで実装をシンプルにし拡張性を担保、ユーザーは好きなプラグインを組み合わせて目的を達成することが可能になります。
以下はddc.vimの拡張例となります。

https://zenn.dev/matsui54/articles/2021-09-03-ddc-lsp

ddc.vimと思想が対極にあるのはcoc.nvimやYouCompleteMeでしょう。それらはIDEに関連する全ての機能を一つのプラグインに取り込むことを目的としています。
そのプラグインの世界だけで完結する作業ならば極上の快適さが約束されますが、自由に設定し他のプラグインを組み合わせようとすると容易に破綻します。
私は好きにプラグインを導入して機能を自由に拡張したり、設定して自分好みにカスタマイズできることがVimの良さだと思っているので、このIDE的な思想にはどうしても納得ができませんでした。
だから機能がシンプルで好きに組み合わせられるddc.vimを作成したのです。

ddc.vim の速度について

ddc.vimは以下のような環境ではdeoplete.nvimより高速に動作します。

  • ddc-nextwordのような外部コマンドを使うsourceを利用している

  • Windows環境やVim8環境である

  • マシンの性能が低い、ssh 先の Vim/neovim、仮想環境である

deoplete.nvimは十分に最適化しているせいもあり、deoplete.nvimを遅いと思わないような環境だとddc.vimに移行しても高速化の恩恵は受けづらいかと思います。
その場合でもCPUの負荷が減ったり、マシンの処理が重くなりにくいという面での恩恵は受けることができます。

廃止した機能について

ddc.vimでは時代に合わせて一部機能を廃止しています。要望されても実装しません。

omni_patterns

deopleteから生のオムニ補完(<C-x><C-o>)を呼び出す機能です。機能制限はあるもののオムニ補完sourceでは呼び出せない副作用のあるomnifuncを自動的に呼ぶのに重宝していました。昨今ではLSP server/clientの完成度が上がったため、昔のようにオムニ補完関数を直接呼ぶことは少なくなっているので廃止としました。

補完候補の動的な更新

deoplete.nvimはdenite.nvimのように補完候補を動的に追加していくことが可能でした。これに対応するほうが便利だろうと思い導入したのですが、自動補完の場合動的に補完ウィンドウを更新するとチラつくうえ、これが必要なケースがとても少ないです。よってddc.vimでは廃止することにしました。
その代わりに後からコールバックにより補完候補を更新することが可能になっているので代用してください。コールバックによる更新はddc-nvim-lsp にて使用されています。

prev_completion

prev_completionは補完の高速化を行うためのひとつの機能です。新しい補完の計算が終わるまで以前の補完結果を利用して補完候補の表示します。
ddc.vimではdeoplete.nvimより補完が高速化しており、このようなhackは必要ないと結論付けました。

バックスペースによる補完継続

ddc.vimではバックスペースを行ったときに補完の継続しません。仕様を変更した理由はチラつきを抑えるのが困難だからです。deoplete.nvimではhackを用いて無理矢理実装していましたがddc.vimでは効果がないことが分かりました。この仕様変更で私は特に困っていませんが、どうしても補完を出したければ手動で呼び出すことができます。

source の rank

ddc.vimにはdeoplete.nvimとは異なりsourceにrankが存在しません。では、どのように候補の順番を制御するかというと、sourcesオプションに与えた順番がそのまま利用されます。これはdenite.nvimの挙動とほとんど同じです。
なぜこのようにしたのかというと、実装を単純にするためとユーザーにとって分かりやすいからです。ddc.vimでは使用するすべてのsourceをリストで宣言する必要があるので、リストの順番通りに候補が表示されると設定が簡単になると考えました。

ignore_sources

deoplete.nvimでは基本的にすべてのインストールしたsourceが有効になり、ignore_sourcesオプションによって特定のsourceを無視できました。
ddc.vimではすべての使用するsourceをユーザーが指定することになり、特定のsourceを無視するオプションは無意味なので廃止となりました。

自分では実装しない機能について

完全に廃止した機能ではないですが、諸事情により自分では実装しない機能について説明します。ユーザーは独自に実装できます。

ファイルパス補完 source

ファイルパス補完 source は他のsourceと比較して重要度が高いsourceであることは私も分かっています。
しかし経験上LSP関連を除いた通常sourceにて一番トラブルのある補完sourceです(次点はオムニ補完sourceです)。もちろん、適当に実装するのは簡単です。

ファイルパス補完はファイルの探索でエラーになりやすい、ファイル補完開始位置の計算が難しい、他のsourceと補完開始位置が違うので容易にコンフリクト、といった問題点を抱えています。

トラブルが起こったときに対応するのがたいへんですので、私は実装しないという判断をしました。

追記: その後 file source を作成した人が現れたのでここに紹介しておきます。

https://github.com/LumaKernel/ddc-file

オムニ補完 source

omni_patterns の廃止と同じ理由です。現在オムニ補完に頼るべき場面はとても少ないうえにオムニ補完は計算中にVimを停止させるのでパフォーマンス上の問題があります。オムニ補完関数の実装により副作用があったり挙動が違うためサポートするのも大変です。

追記: ここではそんなことを書いていたんですが、omni sourceを追加することにしました。ただし使用頻度の低い一部機能は省略しています。
ddc.vimで書き直されたインタフェースの美しさを知ってもらえればと思います。

https://github.com/Shougo/ddc-omni

include 補完 source, tag 補完 source

こちらもLSPの進化によりほとんど必要がなくなっています。過渡的な技術であったという印象です。tag補完sourceは巨大なタグがある場合にパフォーマンスの問題を引き起こします。

ddc.vim の使用方法

詳しい使用方法はドキュメントを参照してください、としたいのですが簡単に説明をしておきます。

前述の通り、ddc.vimの導入にはDenoとdenops.vimが必須となります。先に導入をしておいてください。

ここではプラグインと依存関係はすでにインストール済み、ロード済みとして話を続けます。

必須の依存関係のほかにも、ddc.vimではデフォルトのsources, filtersを廃止しているためsources, filtersのインストールが必須となります。
自分が必要となるsource, filterをインストールしましょう。以下のリンクから探すと良いです。

https://github.com/topics/ddc-source
https://github.com/topics/ddc-filter

ここでは、比較的一般的なsourceであるddc-around, ddc-matcher_head, ddc-sorter_rankを使用するものとします。

https://github.com/Shougo/ddc-around
https://github.com/Shougo/ddc-matcher_head
https://github.com/Shougo/ddc-sorter_rank

ddc.vimの設定は以下のように行います。

call ddc#custom#patch_global('sources', ['around'])
call ddc#custom#patch_global('sourceOptions', {
      \ '_': {
      \   'matchers': ['matcher_head'],
      \   'sorters': ['sorter_rank']},
      \ })
call ddc#enable()

ddc#custom#patch_global() によりグローバル設定を変更します。デフォルトではsourceは何も指定されていないため、around sourceを利用するために sources オプションを設定する必要があります。

sourceOptions によりsource固有の設定をします。source名に _ を与えることでデフォルトの設定を変更します。ここではsourceを設定しても入力の絞り込みを行う matchers、候補のソートを行う sorters をセットしています。

deoplete.nvimと同様にddc.vimもインストールするだけでは有効になりません。ddc#enable() を呼ぶことにより有効化します。

それでは続いてsourceを追加してみましょう。今回はddc-nextwordを用います。

https://github.com/Shougo/ddc-nextword

ddc.vimの設定を以下のように変更します。

call ddc#custom#patch_global('sources', ['around', 'nextword'])
call ddc#custom#patch_global('sourceOptions', {
      \ 'around': {'mark': 'A'},
      \ 'nextword': {'mark': 'nextword'},
      \ '_': {
      \   'matchers': ['matcher_head'],
      \   'sorters': ['sorter_rank']},
      \ })
call ddc#enable()

補完を動かしてみると、以下のような表示になるかと思います。

ddc.vim

sources オプションにsource名のリストをセットしますが、このリストの順番がそのまま候補の順番となります。ここでは ['around', 'nextword'] ですので、around sourceの候補の次にnextword sourceの候補が必ず現れます。

sourceOptions にsource名を指定したのでsource固有にオプションの変更します。ここではaround sourceとnextword sourceの mark を変更します。

mark とはsourceを追加したときに、どれがどのsourceの補完候補か分からなくなるので、わかりやすく表示するための機能です。deoplete.nvimとは異なり、markはデフォルトではセットされていません。ユーザーが明示的にセットする必要があります。

ちなみに、sourcesmatchers, sorters, converters は名前のチェック機能が存在しており、インストールしていないものを指定するとエラーになります。

これで最低限の解説は終了です。基本は分かったはずですので、あとはddc.vimを設定していきながら学んでいきましょう。

これからのプラグイン開発について

ddc.vimの開発は一通り完了し、自分が日常的に使う上で困らなくなりました。ddc.vimの今後は機能追加より機能の安定化に注力し、正式版のリリースを目指す予定です。

ddc.vimの次はdenops.vim製ファジーファインダーであるddu.vimの開発を進める予定となっています。
もうすぐ開発を開始できると思うので、お待ちください。
ddu.vimではddc.vimの経験をベースにより完成度の高いものを作りたいと考えています。私自身denite.nvimのパフォーマンスに納得がいっていないので、denite.nvimを 越えるものを作らなければ意味はありません。

https://github.com/Shougo/ddu.vim

GitHub sponsors について

今回のddc.vimプラグインの開発はGitHub sponsorsの皆さんの支援によって行われました。

https://zenn.dev/shougo/articles/github-sponsors

GitHubのコミット数を見てもらえれば、GitHub sponsorsを開始した6月7月8月とコミット数が劇的に伸びているのを確認できるかと思います。

https://github.com/Shougo

https://github.com/sponsors/Shougo/

GitHub sponsorsでの支援は確実に自分のプラグインの開発意欲の向上に役立っているので、プラグインのユーザーに広く支援をお願いします。

この記事に贈られたバッジ

Discussion

ログインするとコメントできます