Vim/Neovim両対応とテストで試行錯誤している話

機能毎にコンポーネント化

テスト時にはモック化したい

これらを現状どう解決しようとしているかについて簡単にまとめたいと思います。

なお後述しますが未だに試行錯誤している段階なので、こんな方法もあるんだなぁくらいの軽い気持ちでお読みください。

同じインターフェイスの提供

vim プラグインを書いている方であればおなじみかと思いますが辞書を使っています。

例えば以下のような感じです。

code:vim

let s:vim = {}

function! s:vim.say(s) abort

echo printf('Hello vim %s', a:s)

endfunction

let s:nvim = {}

function! s:nvim.say(s) abort

echo printf('Hello neovim %s', a:s)

endfunction

let s:common = has('nvim')

\ ? s:nvim

\ : s:vim

call s:common.say('hello')

また機能毎のコンポーネント化についてはこの辞書を細分化するのみです。

vim の channel と neovim の job に関する処理のみ

vim の popup と neovim の floatingwindow に関する処理のみ

/icons/point.icon

これで同じインターフェイスを vim/neovim 向けに提供はできるのですが、それぞれの辞書で用意する関数を自力で合わせる必要があるのが無駄に脳の領域を使っている感があり改善したいポイントです。

java の interface や clojure の protorol のように間違いを自動で検知できたら嬉しいです。

テスト時のモック化

上記の辞書をグローバルスコープにおいて書き換えれば可能といえば可能ですが、グローバルスコープの変数はユーザー設定につかうものだけに限りたいです。

またコンポーネントを複数に分割するとコンポーネント内で別のコンポーネントを利用したい(依存したい)ケースも出てきます。

それらを単なる辞書が格納された変数だけで管理するのは限界があります。

そこで以下のようにコンポーネントを管理する関数を用意しました。

code:system.vim

let s:nvim = has('nvim')

let s:system_map = {

\ 'foo': {'start': (s:nvim ? {_ -> {'who': 'nvim foo'}}

\ : {_ -> {'who': 'vim foo'}})},

\ }

" 依存するコンポーネントを返す

function! s:requires(name) abort

return copy(requires)

endfunction

" コンポーネントを開始して辞書を返す

function! s:get(name) abort

let params = {}

for required_component_name in s:requires(a:name)

endfor

if type(StartFn) == v:t_string

let StartFn = function(StartFn)

endif

return StartFn(params)

endfunction

" => {'foo': {'who': 'vim foo'}, 'who': 'bar'}

echo s:get('bar')

code:vim

function! s:set(name, component_map) abort

endfunction

" foo コンポーネントを書き換える

call s:set('foo', {'start': {_ -> {'who': 'nisemono'}}})

" => {'foo': {'who': 'nisemono'}, 'who': 'bar'}

echo s:get('bar')

/icons/point.icon

vim/neovim の違いは起動時にわかり途中で変わるものでないので、多少乱暴ですが autoload な関数を直接書き換えて以降それを使うだけのようなことができたらより良いのかなぁなどと考えていたります。

最後に

拙作のプラグインでの vim/neovim 両対応ならびにテストにおける現対応をまとめたわけですが、前述の通りまだ納得がいっているわけではないのでこれで確定版ではありません。ちなみに試行錯誤は結構前からやっていて、今の形になるまで2回くらいはコンポーネントまわりをゼロから書き直していたりします。