このドキュメントの状態(超ドラフト)

かなりドラフトの状態なのでウソが含まれているかもしれない。

github vital.vim

vital.vim とは

ピュア Vim script で書かれた、便利なライブラリ集 .vimrc の中で気軽に使ったり、プラグイン作成者がライブラリとして利用する。機能毎にモジュール化されており、自分が使用するモジュールの取り込んで利用することが可能。

複数のプラグイン開発者が同じような処理を各自で作る手間が省けて便利。

Quick Start

FAQ

プラグイン作者ではないけど関係ある？

.vimrc の中でも使えるので、.vimrc の記述が楽になるかもしれません。

プラグイン作者だけど、他のライブラリに依存したくないから興味ないです。

依存で面倒な事の一つは、最新バージョンに追随することです。
vital.vim はある特定時点での vital.vim のバージョンを各プラグインのディレクトリに
丸ごとコピーします。
ですので、最新バージョンの vital に追随して、プラグインを変更する必要性は生じません。

バージョンはどうやって管理しているの？バージョン番号は？

バージョン管理は git の hash 値を使用してこれを'特定の時点での vital のバージョン'を
示すものとして使っています。
vital はあなたが組み込んだ時点での git の hash 値を vital のバージョンとして、その内容が固定されます。

いくつかモジュールを使ってるんですが、特定モジュールだけをアップデートしたいんだけど。

可能です。アップデートするモジュールを以下の様に指定します。

TODO

そもそも Vitalize ってなに？プラグインに組み込むってどういうこと？

短い説明:
vital をプラグインに組み込む。

長い説明:
Vitalize とはプラグインから vital.vim のモジュール(ライブラリ)を使えるように、
その時点での vital のモジュール集を、指定したプラグインのディレクトリにコピーすることです。

vital のモジュール集がプラグインのディレクトリ配下にコピーされたプラグインを vitalize されたプラグインと言います。

vitalize されたプラグインを使う時、注意する必要がある事ってなにかある？

使う側にとっては特に vital を意識する必要はありません。
すでにあなたが使用しているプラグインも裏で vital を使っているかもしれません。

自分のプラグインを vitalize したんだけど、どういう事に気をつける必要がある？

必要なモジュールのみ取り込む。
モジュールのアップデート時にはアップデートしたモジュールに関わる部分の動作を確認する。
プラグイン名を変えた時は vital のどこか変えなきゃいけない？

インストール

NeoBundle 'vim-jp/vital.vim'

使い方

vital は vital オブジェクト(辞書)を取得して、その辞書関数を使う。

" vital オブジェクトを取得して V にセット
let V = vital#of('vital')

" vital.import({モジュール名}) でモジュール(ジャンル分けされた関数セット)を取得
" して、List という変数にセット
let List = V.import('Data.List')

" List モジュールの uniq 関数を読んで、重複のないエントリを取得。
echo List.uniq([1,2,2,3,3])
 " => [1, 2, 3]

上記のように、各モジュールが提供する便利な関数を利用することで、uniq() を各自が実装する必要がなくなる。

.vimrc の中で使う

使い方の例と特別な違いはない。

let s:V = vital#of('vital')
let s:List = V.import('Data.List')

t9md/vital_doc.md