プラグインのルール

mikutterプラグインはRubyのコードなので、Rubyのコーディング規約に従って、読み手（あなたのプラグインを修正しようとしている人、勉強中の人、将来のあなた自身等）がスムーズに読めるように心がけると良いでしょう。

こういったものを見て、どのコーディング規約でも一貫して言われているようなことには従い、意見が別れているような項目については自分の好みで選んでいったりすると良いと思います。 mikutterもそのようになんとなくやっているだけなので、残念ながらmikutterコーディングスタイルという明確な文書があるわけではありません。そもそもプラグインがmikutterと同じコーディング規約に従う必要はありません。

しかし、プラグインはオープンソースとなるはずなので、他の人がコントリビュートすることがあることを考えると、近年の主要なコーディングスタイルで意見が一致している項目を無視するのはやめるべきでしょう。例えばRubyを書いたことがない人がタブや4文字のスペースでインデントをしているのをたまに見ますが、前述したようなコーディング規約では全て2文字のスペースでインデントを行うことになっているので、Rubyを書く場合はこれに従ったほうが良いです。

mikutterは2009年から開発しているため、時期によって微妙にコーディング規約が変わっています。よって、mikutterがやっていることが常に正しいというわけではなく、その書き方は数年前は由とされていたが今はそうではない、というものがいくつもあります。

mikutterでは、そういったものをその時の思いつきで全部直してしまうのではなく、関連するコードを直したときにコーディング規約に沿うように書き換えています。ここでいう関連するコードというのは、ファイル単位ではなくメソッド単位です。要するに、あるメソッドの一部を修正するときに、そのメソッドの他の部分がコーディング規約にそっていなければ修正する、ということです。このルールによって、古いコーディング規約と新しいコーディング規約が混在することがありますが、ほぼ全てのファイルのすべての行に影響が及ぶような規約の変更をしても、巨大なdiffが生成されて変更を追いかけづらくなることを防いでいます。

したがって、mikutter本体のコーディングに従うのではなく、前述したようなRubyで広く支持されているコーディング規約の方に従うべきです。

プラグインの名前は、Specファイルの name キーの値にあたるもので、ユーザに表示されるプラグイン名です。現状のmikutterではプラグイン名を表示しないので特に利用されていませんが、ここには人間がプラグインの名前を呼ぶときに使う正式名称をいれておきます。

ここには特に制約はありません。アルファベットの大文字や、日本語、半角スペースなどの記号も利用できます。適切な理由があれば「mikutter」という単語を含めることも可能です。また、他のプラグインと同じ名前をつけても構いません。

プラグインスラッグはプラグインの固有IDのようなものです。人間が見るための値ではありませんが、開発者のために、説明的な値にすることも出来ます。

GitHubのリポジトリ名には 特に制約はありません 。しかし、mikutterプラグインのほとんどがGitHubに公開されているため、参考となる指標を書いておきます。