📌

たった3STEPでプラグイン開発者に喜ばれる報告者になれる?!~Vimプラグイン最小構成の作りかた~

1 min read

なぜ最小構成を作るのか

一言で言うならば、 「開発者の負担を減らせるから」 だと筆者は考えています。

まず、Vimプラグインにおいてはissueの内容がプラグインのバグではないと言う場合もよくあります。(むしろこっちの方が比率としては高め)
では何が問題なのかと言われると以下の原因が一例として考えられます。

  • key mappingの重複
  • 設定ミス
  • プラグインの使用要件を満していない
    (バージョンが古い、Vim or Neovimどちらかにしか対応していない)

プラグイン開発者には日々たくさんのissueが飛んできます。
もし最小構成が無ければ全issueに対しプラグインのバグかどうかを判断するプロセスが発生します。

このような開発者のプロセスを減らすために「最小構成の作成」が求められると筆者は考えています。

最小構成の作りかた

ここでは一例として、ddc.vimの最小構成を作成する手順を書いていきます。

  1. 必要なプラグインをローカルにクローン
shell
$ git clone https://github.com/Shougo/ddc.vim ~/hoge
  1. まっさらなvimrcを新規作成
shell
$ touch ~/.vimrc
  1. 作ったvimrcに set rtp^={クローンしたディレクトリへのパス} を追記
vimrc
set rtp^=~/hoge/ddc.vim

これで最小構成の完成です。

最小構成を作ってどうするか

最小構成できちんと動いた
→自分のvimの設定を見直す

最小構成でも動かなかった
→最小構成と一緒にバグ報告

筆者の経験上、上記の行動に分かれるかなと思います。

最後に

この記事に書いた最小構成の作りかたはおそらく最も標準的な作りかたになると思います。他にもdockerを使ったやり方などがあります。

「最小構成を作ってから報告」というプロセスを踏むだけでプラグイン開発者に喜ばれ、対応してもらいやすくなります。
この記事が、最小構成の重要さを知るきっかけになり、最小構成を作る人が増えれば嬉しいです。

Discussion

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