Skip to content

ターミナル UI ​

veritas を引数なしで実行すると、ターミナルで操作する画面が開きます。コマンドを入力しなくても、結果の確認、仕様のレビュー、実行、テストの改善、設定の編集ができます。

bash
npm install -g @under18dev/veritas
cd your-project
veritas

開くのは、カレントディレクトリのプロジェクトです。

開く条件 ​

次の条件をすべて満たしたときだけ開きます。

  • veritas を引数なしで実行した(コマンドも、-C や --json などのオプションも付けていない)。
  • stdin と stdout が、どちらも対話的なターミナルである。
  • 環境変数 CI が設定されていない(または false か 0)。

それ以外のときは、これまでどおり help を stderr に出し、終了コード 2 で終わります。引数なしで veritas を呼んでいるスクリプトやパイプラインには影響しません。

画面の構成とキー ​

上部にプロジェクト名と最新の run(verdict、終了コード、開始時刻)、左にメニュー、右に選んだ画面、下部にキーの説明が表示されます。

場所キー操作
メニュー↑ ↓ または j k画面を選ぶ
メニューEnter または →画面に入る
メニュー?キーの説明を表示する・閉じる
メニューq終了する
どこでもCtrl+C終了する
画面の中↑ ↓ または j k一覧で移動する、テキストをスクロールする
画面の中Enter選ぶ
画面の中Esc戻る。画面の最初の階層ではメニューに戻る

画面 ​

ホーム ​

プロジェクトのディレクトリ、設定ファイル、veritas doctor が報告する各機能の状態を表示します。設定がまだないプロジェクトでは、veritas init と同じように、検出した設定で .veritas/config.json を作るかを確認します。

結果 ​

run を新しい順に一覧します。run を選ぶと、コマンド、profile、verdict、終了コード、policy の理由、ステージ、finding が表示されます。finding を選ぶと、その根拠(説明、場所、引用した出典、Property、テスト、mutant、ソルバーの claim、次の対応)が表示されます。表示する行は veritas explain <finding-id> の出力と同じです。

仕様 ​

Property を生成した最新の run の Property を一覧します。

キー場所操作
f一覧status で絞り込む(all、proposed、reviewed、accepted、rejected、conflicted、superseded)
d一覧前回の run からの変化を表示する(veritas spec diff)
Enter一覧Property を表示する(対象、引用した文、衝突している Property、これまでの決定)
aProperty理由を入力して accept する
rProperty理由を入力して reject する

理由は必須で、空のときは何も記録しません。決定は .veritas/approvals.json に記録されます。actor は VERITAS_ACTOR、設定されていなければ git の user.name です。veritas spec accept と veritas spec reject と同じ形で記録されます。

実行 ​

オプションを選んでから Start を選びます。

オプション既定値対応するオプション
Profilequick--profile
Offlineyes--offline
Include proposed specificationsno--include-proposed
Sinceプロジェクト全体--since <ref>

実行中は、各ステージの開始と終了が表示されます。Esc で実行をキャンセルします。終わると verdict、終了コード、finding の数が表示されるので、内容は 結果 の画面で確認します。実行中に画面を離れたり TUI を終了したりした場合も、実行はキャンセルされます。

テストの改善 ​

Create a plan は veritas improve と同じで、accepted の仕様から期待値を取ったテストを提案します。プロジェクトのファイルは書き換えません。Also use proposed specifications をオンにすると、--include-proposed と同じく proposed の仕様も使います。

計画には、目標、提案するテスト、リスク、パッチが表示されます。適用できるものがあれば、a を押して y で確定します。TUI はその計画の承認トークンを使って、veritas improve --apply --plan <id> --approve <token> と同じように適用します。計画の適用の検査はすべてそのまま行われます。テストは隔離したコピーで実行し、条件をすべて満たしたときだけ新しいテストファイルを書き込みます。CI では適用を拒否します。Esc で計画の作成や適用をキャンセルできます。

設定 ​

.veritas/config.json の値を、mutation.timeoutMs のようなパスごとに一覧します。値を選ぶと編集できます。数値、真偽値、リストは JSON で入力します(5000、true、["src"])。文字列はそのまま入力できます。

書き込む前に、veritas が設定ファイルを読み込むときと同じスキーマで、新しい設定を検査します。不正な値はパスと理由を表示し、保存しません。正しい変更は変更前と変更後を表示し、y で確定したときだけ保存します。書き込むのは .veritas/config.json だけです。

veritas.config.ts、.mjs、.js で設定しているプロジェクトでは、読み込むとプロジェクトのコードが実行されるため、読み取り専用で表示します。これらのファイルは直接編集してください。

Apache-2.0 ライセンスで公開しています。