Difit

概要

このスキルはdifit を使用してユーザーからコードレビューをリクエストします。 コマンドを実行する前に、以下のルールに従って <difit-command> を選択してください:

• command -v difit が成功する場合は、difit を使用します。
• それ以外の場合は、npx difit を使用します。
• ネットワークアクセス権限がないサンドボックス環境で npx difit へのフォールバックがネットワークアクセスを必要とする場合は、実行前に昇格した権限とユーザーの承認をリクエストしてください。

ユーザーがレビューコメントを残した場合、それらは選択されたdifitコマンドの終了時に標準出力に出力されます。 レビューコメントが返された場合は、作業を継続してそれらに対応してください。 コメントなしでサーバーがシャットダウンされた場合は、「レビューコメントが提供されなかった」として扱ってください。再起動は不要です。 ページが正しく起動したかどうかの手動確認も不要です。

コマンド

• コミット前の未コミット変更をレビュー: <difit-command> .
• HEAD コミットをレビュー: <difit-command>
• ステージング領域の変更をレビュー: <difit-command> staged
• ステージされていない変更のみをレビュー: <difit-command> working

基本的な使用方法:

<difit-command> <target>                    # View single commit diff. ex: difit 6f4a9b7
<difit-command> <target> [compare-with]     # Compare two commits/branches. ex: difit feature main

オプションのスタートアップコメント

difitが開く際にユーザーに伝えたいことがある場合は、--comment でスタートアップコメントを添付してください。 これはレビュー結果、説明、およびユーザーが diff で直接見るべきコンテキストに役立ちます。

<difit-command> <target> [compare-with] \
  --comment '{"type":"thread","filePath":"src/foobar.ts","position":{"side":"old","line":102},"body":"line 1\nline 2"}' \
  --comment '{"type":"thread","filePath":"src/example.ts","position":{"side":"new","line":{"start":36,"end":39}},"body":"Range comment for L36-L39"}'

• 各コメントに type: "thread" を使用してください。
• コメント本文はユーザーが使用している言語で記述してください。
• diff のターゲット側に存在するラインには position.side: "new" を使用してください。
• 削除側にのみ存在するラインには position.side: "old" を使用してください。
• 複数行にまたがる問題にはrange コメントを使用してください。
• シークレット、トークン、パスワード、API キー、秘密鍵、その他の認証情報のようなマテリアルを diff から --comment 本文やコマンドライン引数にコピーしないでください。

追跡されていないファイルを含める

未コミット変更の場合、git にまだ追加されていないファイルが diff に表示されるべき場合は、--include-untracked を追加してください。

<difit-command> . --include-untracked

制約

Git で管理されているディレクトリ内でのみ使用できます。