eskk.vim コーディング規約

追記:thincaさんがwikiにまとめてくれました。


またthincaさんがツッコんでくれたので今決めます。
言われないと直さないと言われ続けたアレな人間ですので、みなさんどんどん意見してくださると助かります。

@tyru 以前にもちらっと呟いたのですが、eskk.vim のコーディング規約、と言うかそんな大それたものではなくてもいいので指針のようなものがあるとやりやすいと思います。変数名の命名規則やインデント幅、あとブランチ名の命名規則もあると嬉しい。 #eskk

thinca on Twitter: "@tyru 以前にもちらっと呟いたのですが、eskk.vim のコーディング規約、と言うかそんな大それたものではなくてもいいので指針のようなものがあるとやりやすいと思います。変数名の命名規則やインデント幅、あとブランチ名の命名規則もあると嬉しい。 #eskk"

インデント

これは一応4タブで統一してます。
thincaさんは2タブ派っぽいですが。
今更直すのもskk7.vimからeskk.vimにリネームした時のコンフリクト地獄が蘇るので
4タブのままでいきたいと思います。

あとVimスクリプトで、複数行に渡る

let foo =
\   'bar'
\   . 'hoge'

という風な場合の「\」の位置は、位置行目のletと同じ位置に置いてます。
これもできれば守ってほしいです。

ブランチ名

これは前skk.vimの構造について - Humanityで決めながらも、自分ですっかり忘れてて守ってませんでしたorz

  • ブランチのフォーマットは/<タイプ>/<好きな名前>
  • タイプは機能修正なら頭にfix、機能追加ならhack、それ以外なら何もつけない
skk.vimの構造について - Humanity

今はskk.vimとeskk.vimリポジトリを分けることにしたので

  • <タイプ>/<好きな名前>
  • タイプは機能修正なら頭にfix、機能追加ならhack、それ以外なら何もつけない

という風にします。
でもそれ以外ってどんな場合だろ。

命名規則

これは難しいですねー。
というのもあまり決めずに書いてしまったので...

最低限決めているのはスネークケース(snake_case)ということぐらいです。

あと末尾にたまに「***_p」とついてるのはそれがブール値ということを表します。
kanaさんのスタイルというかLisp風のスタイルなのですが、
これはあんまり統一されてないので守らなくてもいいです...

やること

他に何か決めるべきことあったらツッコミお願いします。
とりあえずやるべきこととして、funcをfunctionに置き換えるくらいですかね...
ずっとfuncで書いてたんですがfunctionのがみんな慣れてるだろうし補完も効くし。
まぁそんな感じ。