Vim の help を見せてくれる hubot スクリプトを作った

vim javascript hubot bot

先週は Vim で help が引ける npm パッケージを作ったのだけど、そもそもなぜ作りたかったかというと、bot で使いたかったから。 と言うわけで vimhelp パッケージを使って、hubot-vimhelp を作りました。

https://www.npmjs.com/package/hubot-vimhelp
https://github.com/thinca/hubot-vimhelp

README は面倒になってあまりちゃんと書いてない。

導入方法

hubot スクリプトなので、hubot の使い方や hubot スクリプトの導入自体は省略(README に簡単には書いてあるけど)。 このスクリプト自体の導入については、スクリプトのソースの先頭にコメントで簡単な設定用の変数について書いてあるのだけど、ひとまず使いたいのであれば、

  • bot が動いている環境に vim コマンドが必要
  • プラグインマネージャ機能が使いたい場合は、
    • bot が動いている環境に git コマンドが必要。Git 2.3 以降じゃないと存在しないプラグインをうっかり指定した際に面倒なことになる可能性が高い
    • プラグインを入れておくディレクトリを用意して、そのパスを HUBOT_VIMHELP_PLUGINS_DIR 環境変数で指定する
  • 日本語ヘルプを優先して出してほしい場合は HUBOT_VIMHELP_HELPLANG 環境変数に ja,en などと設定しておくとよい

以上で動く。

使い方

help の引き方

bot が動いたら、:help word もしくは :h word などで help が見れる。カンタン。手抜きをしているので、:he とかだと動きません。注意。

markdown が使える前提で、``` で囲まれた状態で発言されるので、そうじゃない環境だとおかしくなるかも。要望があればオプションなりで制御できるようにします(使いたい人いるんかな)。

プラグインマネージャ

プラグインマネージャは、/vimhelp plugin {cmd} で使える。 プラグインをインストールすると、そのプラグインの help も引けるようになる。 プラグインの指定({plugin-name})は、GitHub の vim-scripts ユーザーのリポジトリ名か、<user>/<repos> 形式か、もしくは Git リポジトリのフルパスを指定できる。

  • /vimhelp plugin add {plugin-name}
  • /vimhelp plugin remove {plugin-name}
  • /vimhelp plugin update {plugin-name}
  • /vimhelp plugin list
    • インストール済みのプラグイン一覧の表示
    • (なんか条件によってはうまく動いてないっぽい…)

以上

まだバグが多い気がしてますが(特にプラグインマネージャ付近)、使ってみたい物好きな方がいればどうぞお使いください。