commit

Gitリポジトリの変更をコミットします。 AIがコミットメッセージを生成し、 manual確認モードではユーザが確認してからコミットします。 auto確認モードでは確認を省略してそのままコミットします。

確認モードの決定

$ARGUMENTSを確認モードとして解釈してください。

• manual: ユーザに差分とコミットメッセージを提示し、 確認を取ってからコミットします。
• auto: 差分の表示と確認を省略して、 生成したコミットメッセージでそのままコミットします。 コミットメッセージ自体はmanualと同じタイミングで提示します。

引数が省略された場合はmanualとして扱ってください。

manualともautoとも解釈できない値が渡された場合は、 manualとして扱った上で、 解釈できなかった値を完了報告で伝えてください。 勝手にautoとみなして確認を省略してはいけません。

以降の手順のうち、 対象の確認モードが明記されているセクションは、 決定した確認モードに対応するものだけを実行してください。 明記のないセクションはどちらの確認モードでも実行してください。

スタイルガイドラインの適用

Skillツールでcommit-styleスキルを呼び出し、 スタイルガイドラインに従ってください。

コミットメッセージファイルの生成

!commit-prepare

上の埋め込みコマンドが失敗した場合はエラーメッセージを報告してスキルを終了してください。

埋め込みコマンドはJSON形式で結果を出力します。

• editmsgPathにはCOMMIT_EDITMSGファイルのパスが書かれています。
• patchPathにはステージされた差分のパッチファイルのパスが書かれています。

コミットメッセージの内容の生成

ReadツールでpatchPathのパスのファイルを読み、 差分の内容を把握して分析し、 適切なコミットメッセージを生成してください。

WriteツールでeditmsgPathのファイルにコミットメッセージを書き込んでください。

コミットメッセージの検査

コミットメッセージを書き込んだら、 以下のコマンドで検査してください。

値は実際のファイルのパスに置き換えてください。

run-commit-msg-hook <editmsgPathの値>

このコマンドはgit commitが起動するのと同じcommit-msgフックを、 同じ方法で起動します。 グローバル設定のフックも作業中のリポジトリのフックも対象です。 フックが設定されていない場合は何も検査せずに成功します。

コマンドが失敗した場合は、 出力された指摘に従ってコミットメッセージを修正し、 このコマンドを再実行してください。 コミットの実行時ではなくこの時点で直すことで、 ユーザに確認してもらった後で弾かれる手戻りを防げます。

3回修正しても検査を通らない場合は、 指摘の内容をユーザに報告して指示を仰いでください。

フックはコミットメッセージファイルを書き換えることがあるため、 検査を通ったらReadツールでファイルを読み直して、 以降のステップではその内容を使ってください。

ステージされた差分の表示

manual確認モードのみのステップです。 auto確認モードではコミットメッセージの提示へ進んでください。

AskUserQuestionツールを呼び出す直前に、 以下のコマンドでステージされた差分をユーザに表示してください。

値は実際のファイルのパスに置き換えてください。

show-staged-patch <patchPathの値>

このコマンドはdeltaが利用できる環境では、 シンタックスハイライト付きで差分を表示します。 deltaが無い環境では素のパッチをそのまま表示します。

半自動で変更していた場合に、 ユーザが差分を別途追いかけなくてもその場で確認できるようにするためです。

あなた自身が差分をテキストメッセージとして再出力してはいけません。 差分全文を出力トークンとして再生成すると遅く、 差分内にコードフェンス記号が含まれるとMarkdownの表示が壊れるからです。 差分の表示はコマンドの出力に任せて、 あなたは要約や説明を付け加えずに次のステップへ進んでください。

差分はあくまで表示するだけです。 editmsgPathのコミットメッセージファイルに差分を書き込んではいけません。 commitlintを混乱させないためです。