この日のひとつ
pre-commit
一言でいうと
Gitでコミットする直前に、設定した書式・構文チェックを自動で実行するオープンソースの仕組みです。
公式サイトを見る （外部サイト）Why Today
なぜ今日はこれ？
AIがコードや設定ファイルを直してくれても、JSONの括弧抜けや行末の余分な空白はコミット前に残ることがあります。pre-commitは登録したチェックをGitのコミット前に実行できるため、確認を覚えている人だけに頼らず、小さなミスを早い段階で止める入口になります。
Use For
何に使える？
例えば、AIが編集した公開設定JSONをコミット前に点検する想定例です。PythonとGitを使えるリポジトリへpre-commitを導入し、`.pre-commit-config.yaml`でJSON構文チェックと行末空白チェックを選んでGit hookを設定します。コミット時にステージ済みファイルへ検査が走り、JSONが不正なら止まり、空白を修正した場合は差分を確認して再ステージします。成果物はチェック結果と、修正済みの差分です。最初はテスト用JSON一つで試し、どの誤りを止め、どこを自動修正するか確かめます。
Recommended For
誰に持たせたい？
MMC-011
コトちゃん
編集主任 企画営業部
編集主任のコトちゃんに、記事データのJSON構文と行末空白をコミット前に確認するルールを整えてもらいたいです。合格・修正が必要なファイルの結果を受け取れれば、内容の編集と公開用データの形式確認を分けて進められます。
プロフィールを見るKei's Note
ケイのひとこと
ケイ｜広報部長
毎回の手作業チェックを一つ仕組みに渡せるのは頼もしいですね。自動修正が入ったときは、何が変わったかを見てから再コミットする流れまで決めておきたいです。
確かめる。
Basic Information
基本情報
- 種別
- Developer Tool
- 公式サイト
- 公式サイトを開く（外部サイト）
- 確認日
- 料金
- pre-commitと公式フック集はMITライセンスのOSSで、ソフトウェア利用料はかかりません。
- 利用条件
- PythonとGitが必要です。設定したフックは初回にネットワークから取得・構築されることがあり、コミット前にローカルで実行されます。各フックの提供元とバージョンを確認して固定し、変更されたファイルは差分を見てからステージし直してください。
- ライセンス
- MIT License（pre-commit、および例に使うpre-commit-hooks）
- 補足
- 活用例は公式Quick Start・フック一覧に基づく想定で、実機検証は未実施です。