К основному содержанию
правило CX Codex

index — правило для Claude Code: обзор и установка

Правило index для Claude Code описывает состав набора правил проверки кода и порядок их поиска. Проектный набор заменяет встроенный целиком, а не дополняет его.

MIT ★ 517 обновлён 2026-11-16

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/rules/index.md
Открыть на GitHub

Что делает index

index перечисляет встроенные файлы правил: среди них проверки Java, конкурентного кода, безопасности, Spring и тестов. Часть файлов содержит текстовые рекомендации, а baseline-java.md включает девять базовых правил машинной и смысловой проверки.

Набор ищется сначала в $CODE_REVIEW_RULES_DIR, затем в .code-review/rules/ проекта и после этого во встроенной папке references/rules/. Проектные правила полностью заменяют встроенные. Скрипт bash "$CODE_REVIEW_SKILL_DIR/scripts/rule-grep" использует тот же порядок и запускает regex-шаблоны из строк Detection pattern; для его работы нужны bash и переменная CODE_REVIEW_SKILL_DIR.

Правила оформляются заголовком с ID и уровнем HIGH, MEDIUM или LOW. Без ID вывод проверки не считается подтверждённым. Собственные regex рекомендуют делать узкими, чтобы сократить ложные срабатывания.

Какие задачи решает

  • найти, какие правила входят во встроенный набор
  • задать порядок поиска файлов правил
  • оформить проверку с ID и уровнем серьёзности
  • просканировать код по regex-шаблонам из правил

Примеры запросов агенту

  • Проверь Java-код на нарушения правил из набора index.
  • Просканируй проект по regex-шаблонам правил и укажи ID каждого найденного нарушения.

Как установить index

Вручную: положить файлы

.claude/rules/index.md

Поле paths во frontmatter ограничивает файлы

По шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать

Вопросы об index

Как установить index в Claude Code?

Поместить файл в .claude/rules/index.md.

Что делает index?

Перечисляет встроенные файлы правил и объясняет порядок их поиска. Также описывает формат правила и работу regex-проверки.

Что нужно для работы regex-проверки index?

Нужны bash и переменная CODE_REVIEW_SKILL_DIR, указывающая на каталог скилла: скрипт запускается по пути $CODE_REVIEW_SKILL_DIR/scripts/rule-grep.

Исходный текст

index.md · MIT
# Rule pack

This index lists the built-in rule files and their purposes; see the [repo-guard probe](../probes/repo-guard.md) for the loading and checking flow.

## Location priority

1. `$CODE_REVIEW_RULES_DIR`
2. Project root `.code-review/rules/`
3. Skill built-in: `references/rules/`

A project-provided rule pack replaces the built-in pack entirely (it is not merged). `bash "$CODE_REVIEW_SKILL_DIR/scripts/rule-grep"` uses the same priority order.

## Built-in files

| File | Type | Content |
|---|---|---|
| `baseline-java.md` | Machine-checkable / semantic check | 9 baseline rules |
| `concurrency.md` | Prose | Thread pools, SimpleDateFormat, lock ordering |
| `exception-logging.md` | Prose | Exception catching, transaction rollback, logging |
| `naming-format.md` | Prose | Naming and formatting |
| `oop-collection.md` | Prose | Immutability, defensive programming, collections |
| `spring-performance.md` | Prose | Spring / JPA / transactions / performance |
| `testing-engineering.md` | Prose | Unit-test conventions |
| `security.md` | Prose | Security baseline |

## Rule file format

Each rule has one heading, followed by an optional `Detection pattern` line:

```markdown
### SEC-001 [HIGH] SQL string concatenation

Why this rule matters.

**Detection pattern** (any hit is a violation):
- `regex-one`
- `regex-two`
```

- The heading must be `### <rule-id> [<severity>] <title>`; the severity is one of `HIGH` / `MEDIUM` / `LOW`
- Backtick fragments in `Detection pattern` are extracted by `bash "$CODE_REVIEW_SKILL_DIR/scripts/rule-grep"` and run as regexes
- Rules without a detection pattern do not participate in regex scanning
- **The rule ID is the finding's evidence**; a judgment without an ID does not count
- Legacy localized rule packs may use their own detection-marker label; `rule-grep` accepts the supported aliases

## Constraints

- Only write your team's own rules; do not copy internal standards of unknown origin
- Keep regexes as narrow as possible; prefer missing a hit over producing many false positives

© kyy-logs · MIT · kyy-logs/code-review-gate-skill

Похожие правила IDE

Все правила IDE по теме «Код-ревью и рефакторинг» →
mantis-structural-index официальный google Скилл mantis-structural-index для Claude Code строит семантический индекс исходников с адресацией по содержимому. Запускается перед анализом архитектуры для структурной перекрёстной навигации по коду. CX Codex +1 1 500установок js-index-maps tech-leads-club Правило js-index-maps заменяет повторные .find() по одному ключу на индекс Map. Оно пригодится при частых поисках в массивах. CX Codex +1 ★ 7 191звёзд репо llama-index sanjeed5 Задаёт структуру кода на LlamaIndex. Включается при работе с любым Python-файлом проекта и навязывает модульность, типизацию и облачные сервисы вместо монолитных скриптов. CX Codex +1 ★ 3 589звёзд репо mcp-codebase-index MikeRecognex MCP-сервер mcp-codebase-index разбирает проект на функции, классы и зависимости и отдаёт агенту 18 инструментов запросов вместо чтения файлов целиком. CX Codex +1 ★ 63звёзд репо arch-index coco-research Создаёт проверяемую карту компонентов репозитория в .arch/index.json и ищет расхождения с кодом. Пригодится после рефакторинга или когда нужно понять, какие файлы реализуют компонент. CX Codex +1 ★ 328звёзд репо firecrawl-research-index firecrawl Скилл firecrawl-research-index для поиска статей в индексе Firecrawl, который содержит абстракты из PubMed, bioRxiv, medRxiv и arXiv. CX Codex +1 25 900установок

Из того же набора10

Весь набор →
baseline-java Правило baseline-java для Claude Code добавляет проверки безопасности, многопоточности и обработки исключений в Java. Агент применяет его при разборе Java-кода. CX Codex +1 ★ 517звёзд репо spring-performance Правило spring-performance для Claude Code задаёт практики Spring/JPA и оптимизации производительности. Агент применяет их при работе с Java-кодом и запросами к базе данных. CX Codex +1 ★ 517звёзд репо spring-performance Правило spring-performance для Claude Code задаёт проверки Spring/JPA и производительности. Оно помогает находить ошибки валидации, транзакциях, запросах и пакетной обработке. CX Codex +1 ★ 517звёзд репо concurrency Правило concurrency для Claude Code задаёт требования к многопоточности в Java-коде. Оно охватывает пулы потоков, блокировки, общие данные и другие источники ошибок конкурентного доступа. CX Codex +1 ★ 517звёзд репо exception-logging Правило exception-logging для Claude Code проверяет обработку исключений и логирование в коде на Java. Контролирует пустые блоки catch, вызовы SLF4J, маскирование данных и откат транзакций. CX Codex +1 ★ 517звёзд репо naming-format Правило naming-format для Claude Code задаёт соглашения об именах и форматировании Java-кода. Оно охватывает классы, методы, константы и управляющие конструкции. CX Codex +1 ★ 517звёзд репо testing-engineering Правило testing-engineering для Claude Code задаёт требования к юнит-тестам, архитектуре проекта и зависимостям. Оно охватывает проектирование слоёв, обработку исключений и соглашения для моделей данных. CX Codex +1 ★ 517звёзд репо code-review-gate Скилл code-review-gate для Claude Code проверяет изменения в коде перед коммитом или слиянием PR. Агент собирает diff, запускает проверки и фиксирует найденные проблемы. CX Codex +1 ★ 517звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой