asdf プラグインの作成 : Vimの場合

asdf-vm プラグインの作成

asdf-vm はバージョニング管理ツール(でいいのかな?)で、プラグイン による複数種のツールの管理、また同機構での拡張ができるのが特徴です。

asdf-vim プラグイン

さて、このプラグインの一覧を見たときに、Vim がないことに気付きました。

Vimはパッチバージョンの更新が頻繁で、リリースという明確な区切りがないので、ときどき不具合ありに当ってしまうことがあります。

このときに回避したり、どこで混入したか調べたりするのに、古いバージョンを簡単に導入・切り替えできると嬉しいところがあります。

(とはいえ、作った者は、普段はLinuxbrewで更新していってるので、これであれこれすることは少なそうですが...)

そこで、練習と環境充実を兼ねてasdf-vimを作成しました。

asdfのプラグインとして

下で作成自体については詳細に説明しますが、asdfのプラグインがどんなことをすればいいのか、簡単に説明します。

• bin/install、bin/list-all というコマンド(基本シェルスクリプトだが)が入ったリポジトリを作る(これは最低限)
• bin/list-all はどうにかやって、対象ツールのインストールとして対応するバージョンリストを出力する
• bin/installは引数で上のバージョン、インストール先などの情報をもらうので、それをもってインストール処理を行う
• asdf plugin-install hoge <git htttps path> でプラグインをインストールして使う

• asdf-pluginsへPRするには、

  • CIテストの追加、GitHub Acitonsならインストールテストをしてくれるactionが用意されている
  • CIテストがGreenであること
  • pluginsディレクトリのhogeファイルにターゲットリポジトリを記載
  • READMEに名前、リンク、Statusなどを入れ、更新
  • これをローカルチェック
  • PRのステータスもGreenであること

  を確認しこれらをもってPRとして追加依頼をする
  Adds vim plugin by tsuyoshicho · Pull Request #289 · asdf-vm/asdf-plugins

オフィシャルへの追加がありうるようなプラグインとしてはかなり簡素ですね。

よくあるOSS派生物作成として

作り方というか、わりとへろっと作ったので、その軌跡は残しておこうかと思います。
今回のもの固有というよりは、なんらかのOSSの派生(forkというよりは類似品作成的なもの)として参考になるように凡例的に書いている(つもり)。

1. 既存のプラグインのコードを眺めてみる
2. オフィシャルドキュメント docs at asdf-vm.com を読む
3. ある程度目処がついたら、自分が作りたい内容に近いものを探す (今回はsrivathsanmurali/asdf-cmakeを派生元にさせてもらった)
4. ライセンスをチェックし、派生できるか確認
5. 大丈夫なので派生する
6. 自分向けに必要箇所を変更(cmake->vim)
7. ビルドするところは完全に新規で作る...が、これも実績あるものを参考にする (継続的にビルドをやってるものとして homebrew-core/vim.rb at master · Homebrew/homebrew-coreを参考にした)
8. これらをもとに自分が思うところも修正する (travis -> GitHub Action化、同処理でshell scriptのlint)
9. 動作確認
10. 完成

こんな感じで既存の動いてるものを参考にすることで、初動の良さ、あまり必要のない詰りをうまくやれたりします。

いかがでしたか?

って書くとアレですね...、他のソフトのプラグインでもですが、1本まるまるソフトを作るにくらべると敷居は下るので、挑戦するに良い題材なのではないでしょうか?