CLIツールの色指定について、その役割・典型的な用途・具体的なプロダクトでの利用例をまとめました。

3つのgemからRubyのCLIツールの設計について学びます。 今回コールドリーディングをするのは bundler itamae serverkit です。

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Add Color Formatting and Interactivity いつ表形式の出力を使うか レコードと列からなる大量のデータを扱う場合。 DBの表データが典型的な例。 他のアプリケーションが利用しやすいフォー…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Add Color Formatting and Interactivity いつ色付きの出力を使うか 状態を表す Cucumberは色を効果的に使ったCLI Toolの良い例です。 テストが失敗していれば、赤。 成功していれば緑で表示…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Add Color Formatting and Interactivity 詳細 例えばCucumberはカラフルな出力でユーザーにテスト結果をわかりやすく伝えます。 例えばSQLクライアントはユーザーに優しい表形式の出力を行…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Be Easy to Maintain 詳細 どのようにアプリケーションの複雑性の増加を防ぐか？ アプリケーションをわかりやすく保つことは,アプリケーションの開発に協力してくれるくれる人を増やすのに役…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Make Configration Easy 詳細 Command Suitesのように複数のコマンドを持つ場合、コマンドごとの引数やオプションの設定が必要です。 サンプル仕様 下記記事のサンプルをベースに設定を追加…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Make Configration Easy 詳細 外部設定ファイルを利用すると、ユーザーはコマンドラインの引数やオプションを与えることなく アプリケーションの振る舞いを制御できる。例えばあるオプション…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Make Configration Easy 詳細 なぜ外部設定が必要になるのか？アプリケーションの基本的な振る舞いや、新規ユーザーが使いやすく・覚えやすいように作られるが、 パワーユーザーの複雑な作業…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Delight Casual Users 詳細 ls はコンテキストに合わせてベストなデフォルト値を適用しています。 ls をオプションなしで、単独実行した場合は 下記のように、人間向けのフォーマットになり…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Delight Casual Users 詳細 UNIXの rm は破壊的なコマンドの良い例です。 rm は指定ファイルを削除します。デフォルトの rm はHelpfulなだけではなく、破壊的ではありません。 rm のみだと削…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Delight Casual Users 詳細 アプリケーションのデフォルトの振る舞いは、オプションを省略した際の動作です。 適切なデフォルトの振る舞いを選ぶことは、アプリケーションが何をするか、に依…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Delight Casual Users 詳細 多くのコマンドラインは引数としてファイルリストや標準入力を使用します。 その際に、入力があれば引数から値を取得。 入力がなければ標準入力から値を取得する…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Delight Casual Users 詳細 フラグの典型的な利用方法として出力フォーマットの変更がある。 典型的なのはアプリケーション向けの標準フォーマットと人間向けのPrettyフォーマット。どちらを…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Delight Casual Users 詳細 ユーザーがコマンドを実行する際に毎回フラグを指定しなければならないのなら、 ユーザーフレンドリーではありません。デフォルト値の設定は設計の決定事項です。…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Delight Casual Users 詳細 Command suit において全てのコマンドは簡潔で明確な名前を持つこと。 もし、意味をなすことができるならコマンドは短いニーモニックを持つのも良い。 良い例は l…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Delight Casual Users 詳細 Short-form optionは何のためにあるか？ => アプリケーションを使い慣れたユーザーが少ないタイプで素早く実行するため。Long-form optionは何のためにあるか？ =…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 長い処理を行うアプリケーションを作った場合などに、途中で処理を中止することがあります。 そのような際に行う処理を記述しておき、中途半端な処理にならない…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 CLIアプリケーションは、他のアプリケーション向けの「機械的に読み取りやすいデータ」と 「人間が読みやすいデータ」の両面をサポートすることが重要です。この…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 ユーザーが対象データを抽出しやすいように、フラグやステータスを表す内容を レコードに含めることも有効。 サンプル仕様 引数1 〜 引数2 の範囲数値を配列化し…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 1レコード、デリミタ区切りのフィールドの構成にすることによって 後続のアプリケーションが加工しやすいフォーマットになります。 サンプル 引数1〜引数2の数値…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 あるアプリケーションの出力が他のアプリケーションの入力になる例として、 ls と sort の組み合わせを見る。ls には数値順にソートする機能はない。 しかし、ls…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 標準出力はSTDOUTに、標準エラーはSTDERRに出力します。 標準エラーの出力には STDERR.puts "エラーメッセージ" warn "エラーメッセージ" の両方が利用できます…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 Rubyではバッククォートもしくは、 %x[] によって標準出力を取得できるが 標準エラーは取得できない。標準エラーにもアクセスするには Open3ライブラリを利用す…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 exit code は一つの数値しか取れません。 ビットマスクとして扱うことで各ビットに意味を持たせることができます、 サンプルコード 引数に応じて exit code を設…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 exit code の設定は非常にシンプルです。 Rubyは組み込みのメソッドとして exit メソッドを持っています。 引数を省略して exit すると、$? は 0 = 成功になりま…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 $? という名前はBashをやっている人には慣れ親しんだ変数名だが その他人にはわかりにくい。 より人間に読みやすくするため、標準ライブラリの English を利用し…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 exit code はアプリケーション終了時の成否を伝える。 exit code が 0 なら成功。 それ以外なら失敗。シェルの $? にステータスが格納されています。 サンプル仕…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Play Well with Others 詳細 CLIアプリケーションを利用する直接のユーザーは利用者の一部。 利用者には他のCLIアプリケーションもいる。他のアプリケーションとコミュニケーションをとる手…

概要 書籍 Build Awesome Command-Line Applications in Ruby2 章 Be Helpful 詳細 man page など、helpオプション以外のより詳細を記述するドキュメントについて。 このドキュメントはセクションによって分類されるべき。一般的なカテゴリは以下 カテゴリ …