posted with カエレバ

技術評論社 2018-06-18

Amazonで探す

楽天市場で探す

Yahooショッピングで探す

はじめに

vim scriptでpythonが使えるという

街の噂を聞いたので、

急にvim プラグインを作りたくなりました。

myenigma.hatenablog.com

そこでvimプラグインの作り方を調べてみたので、

まとめておきます。

vimプラグインのひな形を作る

vimプラグインには、

ディレクトリ構成やファイルの配置が

ある程度に決まっているので

自分は下記のvimプラグインのひな形を作るための

vimプラグインを使うことにしました。

mopp/layoutplugin.vim

使い方は(Neobundleを使っている場合)、

vimrcに

NeoBundleLazy 'mopp/layoutplugin.vim', { 'autoload' : { 'commands' : 'LayoutPlugin'} }

と書いて、

:NeoBundleInstall

して、vim上で

:LayoutPlugin sample.vim

とすると、sample.vimというプラグインディレクトリができます。

あとはGithubなどにリポジトリを作って、

このディレクトリをコミット＆pushするようにすれば

誰でも使えるようになります。

そして、そのプラグインを使いたい場合はvimrcで

NeoBundle 'AtsushiSakai/sample.vim'

のようにユーザ名とプラグイン名を指定して、

NeoBunbleInstallすれば、

自作のvimプラグインが/bundle/pluginの下に

インストールされます。

autoloadとpluginフォルダ

先ほど作成したvim pluginのフォルダには、

README以外に、autoloadとpluginフォルダがあると思います。

どちらもvimスクリプトを入れる場所なのですが、

使用する用途が違います。

まず、pluginフォルダは

毎回vimが立ち上がる時に読み込まれるvimスクリプトを入れます。

しかし、このpluginフォルダスクリプトの数が多かったり、

処理が重かったりすると、

vimを立ち上げるのに時間がかかってしまいます。

そこで使用されるのがautoloadフォルダです。

この中のフォルダのvimscriptは、

そのvimscript内で定義されたメソッドが呼ばれた時に、

初めてロードされるようになります。

(使う時にしか処理されないようになる)

ですので、これらのフォルダの使い分けとしては、

pluginフォルダ

commandの設定など、そのプラグインを呼ぶための

必要最小限の処理を記述するスクリプトを置く

autoloadフォルダ

プラグインのメインの処理を書いたスクリプトを置く

といった感じです。

詳しいことは下記の資料が参考になります。

Big Sky :: モテる男のVim Script短期集中講座

vim pluginのお約束

先ほどのLayoutPluginで生成される

.vimファイルを見ると、

.vimファイルのvim pluginでのお約束を勉強することができます。

"=============================================================================
" File: bookmarklet.vim
" Author: AtsushiSakai
" Created: 2015-07-24
"=============================================================================

scriptencoding utf-8

if exists('g:loaded_bookmarklet')
    finish
endif
let g:loaded_bookmarklet = 1

let s:save_cpo = &cpo
set cpo&vim

" vim script

let &cpo = s:save_cpo
unlet s:save_cpo