Hookify ルールの記述

概要

Hookify ルールは YAML フロントマターを含む Markdown ファイルで、監視するパターンと一致したときに表示するメッセージを定義します。ルールは .claude/hookify.{rule-name}.local.md ファイルに保存されます。

ルールファイル形式

基本構造

---
name: rule-identifier
enabled: true
event: bash|file|stop|prompt|all
pattern: regex-pattern-here
---

このルールが発火したときに Claude に表示するメッセージ。
Markdown 形式、警告、提案などのコンテンツを含めることができます。

フロントマターフィールド

フィールド	必須	値	説明
name	はい	kebab-case 文字列	一意の識別子（動詞優先：warn-、block-、require-*）
enabled	はい	true/false	削除せずに切り替え可能
event	はい	bash/file/stop/prompt/all	ルールをトリガーするフックイベント
action	いいえ	warn/block	warn（デフォルト）はメッセージを表示；block は操作をブロック
pattern	はい*	正規表現文字列	マッチするパターン（*または conditions で複雑なルール実装）

高度な形式（複数条件）

---
name: warn-env-api-keys
enabled: true
event: file
conditions:
  - field: file_path
    operator: regex_match
    pattern: \.env$
  - field: new_text
    operator: contains
    pattern: API_KEY
---

.env ファイルに API キーを追加しています。このファイルが .gitignore に含まれていることを確認してください！

イベント別の条件フィールド：

• bash：command
• file：file_path、new_text、old_text、content
• prompt：user_prompt

演算子： regex_match、contains、equals、not_contains、starts_with、ends_with

すべての条件を同時に満たす必要があります。

イベントタイプのガイド

bash イベント

Bash コマンドパターンをマッチ：

• 危険なコマンド：rm\s+-rf、dd\s+if=、mkfs
• 権限昇格：sudo\s+、su\s+
• 権限問題：chmod\s+777

file イベント

編集/書き込み/複数編集操作をマッチ：

• デバッグコード：console\.log\(、debugger
• セキュリティリスク：eval\(、innerHTML\s*=
• 機密ファイル：\.env$、credentials、\.pem$

stop イベント

完了チェックとリマインダー。パターン .* は常にマッチします。

prompt イベント

ワークフロー実行を強制するためにユーザープロンプトコンテンツをマッチ。

パターン記述のコツ

正規表現の基本

• 特殊文字のエスケープ：. は \.、( は \(
• \s 空白文字、\d 数字、\w 単語文字
• + 1 個以上、* 0 個以上、? オプション
• | OR 演算子

よくある落とし穴

• 範囲が広すぎる：log は "login"、"dialog" にもマッチ――console\.log\( を使用
• 範囲が狭すぎる：rm -rf /tmp ――rm\s+-rf を使用
• YAML エスケープ：引用符なしのパターンを使用；引用文字列は \\s が必要

テスト

python3 -c "import re; print(re.search(r'your_pattern', 'test text'))"

ファイル構成

• 場所：プロジェクトルートの .claude/ ディレクトリ
• 命名：.claude/hookify.{descriptive-name}.local.md
• Gitignore：.claude/*.local.md を .gitignore に追加

コマンド

• /hookify [description] - 新規ルール作成（引数なしで会話を自動分析）
• /hookify-list - すべてのルールをテーブル形式で表示
• /hookify-configure - ルールのオン/オフを対話的に切り替え
• /hookify-help - 完全なドキュメント

クイックリファレンス

最小限の実行可能なルール：

---
name: my-rule
enabled: true
event: bash
pattern: dangerous_command
---
ここに警告メッセージを表示