rule について
ruleは、ユーザーの明示的な修正や要求を簡潔なルールとして記録し、既存の違反箇所を探して修正するコーディングスキルです。ルールチェックの報告形式も定めています。
主な機能
- 01既存のプロジェクトルールを確認
- 02変更前後の例付きで簡潔なルールを作成
- 03各ルールを担当ファイルに集約
- 04既存の違反を検索して修正
- 05重大度別に問題を報告
活用シーン
- 01繰り返されたコード修正をルール化
- 02ユーザー指定の必須・禁止事項を追加
- 03記載済みルールに照らしてコードベースを確認
- 04新しいルールに違反するコードを修正
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/インストール後、Claude Code で/ruleを入力して読み込まれたか確認します。
同梱ファイルagents/openai.yaml
詳細
ルール
このスキルは、修正内容を文書化されたルールに変換します。適切なファイルにルールを一度だけ記述し、その後、すでにルールに違反しているコードを修正します。
2回でルールにする
ユーザーが「ルールにして」「常に」「決して〜しないで」「覚えておいて」と言ったら、書き留めます。同じことを2回指摘されたら、ルールにすることを提案します。ルールは、編集のたびに確認できる短さのペアです。
編集中にルールに従うことは scope の役割です。コードベース全体がすべてのルールに準拠しているか確認するのは audit で行います。
1. 既存の内容を読む
作業に取りかかる前に、AGENTS.md、CLAUDE.md、エディターのルール用フォルダーを読みます。文書化されたルールに反する行為は rule-read-before-acting です。
2. ペアを書く
ルールを1文で述べ、その後に違反している行と、それを置き換える行を示します。例のないルールは rule-write-the-pair です。
3. 短く保つ
1つのルールは、ペアと合わせて1〜3文にします。理由を長々と説明する段落は rule-keep-it-short です。
4. 1か所に置く
そのトピックを担当するファイルにルールを記述します。2つ目のファイルにもコピーすることは rule-one-home です。新しいルールが古いルールと矛盾する場合は、古いルールを置き換え、その旨を記します。矛盾する2つのルールを並べて残すことは rule-resolve-conflicts です。
5. コードを一掃する
新しいルールに違反するコードを検索して修正し、ファイルを列挙します。以前からの違反を残したままルールを書くことは rule-sweep-existing です。
ペア
すべてのチェックはペアです。違反している行と、それを置き換える行を並べます。
| ルール | 違反例 | 置き換え |
|---|---|---|
rule-read-before-acting | ピル型ボタンが禁止されているリポジトリに、ピル型ボタンを追加する | 先にルールを読み、角丸ボタンにする |
rule-write-the-pair | 「適切な大文字・小文字の表記を使う」 | 「ラベルにはタイトルケースを使う。Add to library は Add to Library にする」 |
rule-keep-it-short | 理由を長々と説明する段落 | 1文とペア |
rule-one-home | 1つのルールを3つのファイルに記載する | 1つのファイルに記載し、他のファイルからはそこを参照する |
rule-resolve-conflicts | 「枠線を使う」と「枠線は決して使わない」を並べる | 古いルールを置き換え、変更を記録する |
rule-sweep-existing | ルールを追加する一方で、12件の違反を残す | 違反を修正して列挙する |
報告
重大度。 HIGH は、文書化されたルールに違反する編集、または互いに矛盾する2つのルールです。MEDIUM は、ペアのないルール、または新しいルールの追加後も残っている以前からの違反です。LOW は、必要以上に長いルールです。
形式。 根本原因ごとに指摘事項を1件記載します。
file:line - [rule-id] what is wrong
続けて Rule | Count | Severity の概要を示します。HIGH が1件でも残っている場合は「ブロック」、それ以外の場合は「承認」とします。読み取れなかったルールファイルはすべて「未検証」と記載します。