コマンドの命名規約

Qithub コマンドの命名ルール

• すべて小文字
• [DO]-[WHAT]-[OF WHAT]-[...] の形式でハイフン（「-」）区切り

例外

• 例外1: DO だけで完結し、直感的にわかるもの 。例）echo（おうむ返し）など。
• 例外2: 固有名詞。単機能でなく複雑な処理をするため固有名を使う場合など。例）mastoownなど

命名例

• NG: GetWeather（キャメル・ケース）、get_weather（スネーク・ケース）
• OK: get-weather-tokyo

WHAT と OF WHAT の違い

DO の対象となる WHAT のカテゴリの大きい（より汎用的）な方を前に持っていきます。

• get-weather-tokyo
• get-weather-kyoto
• search-toot-qiitadon
• search-toot-pawoo
• search-reply-qiitadon
• search-post-qiita
• get-post-qiita-new

※ 上記はコマンドの命名例で、実際には実装されていません。

もちろん、複数コマンドを引数で操作する場合はシンプルにしても構いません。

1. get-weather-tokyo
2. get-weather-kyoto

↓

1. get-weather
   • get-weather tokyo
   • get-weather yokohama