CodeRabbitはAIの力でレビューを行うサービスです。GitHubやGitLabと連携し、プルリクエストを自動的にレビューします。最近、VS CodeやCursor、Windsurfで動作する無料の機能拡張もリリースしました。
基本的にはリポジトリを連携したら、PRを送るだけなのですが、より使いこなすためのコマンドが用意されています。Code review commands - CodeRabbitにあるのですが、日本語化されていないので、ここで紹介します。
利用場所
コマンドを使うのは、PRのコメント欄です。 @coderabbitai というプレフィックスをつけてコマンドを入力します。
基本コマンド
@coderabbitai review
新しい変更に対する、インクリメンタルなレビューを行います。自動レビューが無効になっている場合や、手動でレビューを実行させたい場合に利用します。
@coderabbitai full review
すべてのファイルを、ゼロから見直します。PR全体に対して、深いインサイトを得たい場合に利用します。
@coderabbitai summary
PRのサマリーを再生成します。追加コミットなどで、PRの内容が変わった場合に、サマリーを更新したいときに利用します。
コードレビューフローの管理
@coderabbitai pause
レビューを一時的に停止します。複数の大きな変更を行う場合、一時停止してからまとめてレビューを再開することができます。
@coderabbitai resume
一時停止したレビューを再開します。
@coderabbitai ignore
当該PRのレビューを無効にします。
コメント管理
@coderabbitai resolve
すべてのCodeRabbitのコメントを解決済みにします。
ドキュメントコマンド
@coderabbitai generate docstrings
PR内の関数について、ドキュメンテーションコメントを生成します。関数の説明や引数、戻り値の説明を自動で追加する際に利用します。
@coderabbitai generate unit tests
PR内の関数について、ユニットテストを生成します。関数の動作を検証するためのテストコードを自動で追加する際に利用します。
@coderabbitai configuration
現在のCodeRabbitの設定を表示します。設定の確認やエクスポートに利用します。
エージェントチャット
@coderabbitai plan
エージェントチャットに、コメントに基づく修正を提案してもらいます。コード修正も任せたいときに利用します。
ヘルプ
@coderabbitai help
利用できるコマンドと、利用状況を表示します。コマンドの使い方がわからないときに利用します。
まとめ
CodeRabbitは、特に設定しなくともベストプラクティスに基づくレビューを行ってくれます。その結果に対して、さらに深いインサイトを得たい場合や、特定の操作を行いたい場合に、コマンドを利用してください。