difit-dev

Difit Dev

概要

このスキルは、このリポジトリで pnpm run dev を使用して、ユーザーにコードレビューを依頼します。 pnpm run dev を一度実行するだけで、レビュー依頼のワークフローが開始されます。 ブラウザーを自分で開いたり、ブラウザーが接続されたことを確認したり、サーバーを起動したままにするためだけに再起動したりしないでください。 ユーザーがレビューコメントを残した場合、difit コマンドの終了時に標準出力へ表示されます。 レビューコメントが返されたら、作業を続けて対応してください。 コメントがないままサーバーが終了した場合は、「レビューコメントはありませんでした」として扱ってください。再起動する必要はありません。 コメントなしで Client disconnected, shutting down server... と表示された場合は、コメントがない状態で正常に終了したものとして扱ってください。 ページが正しく起動したかどうかを手動で確認する必要もありません。

コマンド

• コミット前に未コミットの変更をレビューする：pnpm run dev .
• HEAD のコミットをレビューする：pnpm run dev
• ステージングエリアの変更をレビューする：pnpm run dev staged
• ステージングされていない変更のみをレビューする：pnpm run dev working

基本的な使い方：

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

オプションの起動コメント

difit の起動時にユーザーへ伝えたいことがある場合は、--comment を使って起動コメントとして追加します。 これは、レビューで見つかった問題、説明、差分上でユーザーに直接確認してほしい背景情報などを伝えるのに便利です。

pnpm run dev <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"}'

• このリポジトリでは、pnpm run dev の後に -- を挿入しないでください。pnpm run dev -- ... とすると、引数の解析に失敗します。
• 各コメントには type: "thread" を使用してください。
• コメント本文は、ユーザーが使用している言語で記述してください。
• 差分の変更後側に存在する行には position.side: "new" を使用してください。
• 削除された側にのみ存在する行には position.side: "old" を使用してください。
• 複数行にまたがる問題には、範囲コメントを使用してください。
• 差分に含まれるシークレット、トークン、パスワード、API キー、秘密鍵、その他の認証情報に類する内容を、--comment の本文やコマンドライン引数に絶対にコピーしないでください。

未追跡ファイルを含める

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

pnpm run dev . --include-untracked

制約

このツールは、Git 管理下のリポジトリ内でのみ使用できます。