Skip to content
Apothem
Примеры

Пользовательское правило

Создание пользовательского постоянного правила для вашего проекта.

Этот пример добавляет специфичное для проекта постоянное правило, которое обеспечивает соблюдение соглашения об именовании для всех файлов.

Файл правила

---
name: "kebab-filenames"
description: "Enforce kebab-case filenames in the src/ tree"
pathFilter: ""
alwaysApply: true
---

# Kebab-case filenames

All new files created under `src/` MUST use kebab-case naming
(lowercase letters, digits, and hyphens only — no underscores,
no camelCase, no PascalCase).

**Correct:** `src/styles/button-group.css`, `src/components/nav-bar.css`
**Incorrect:** `src/styles/buttonGroup.css`, `src/components/NavBar.css`

When in doubt, err on the side of more hyphens.

Сохраните это в rules/kebab-filenames.md внутри каталога установки вашего окружения (~/.claude/ для адаптера Claude Code; для других окружений используйте нативный путь этого окружения).

Проверьте, что правило составлено корректно

Запустите валидатор frontmatter для файла правила, который вы только что написали. Первую команду используйте из чекаута Apothem, где PYTHONPATH=src делает пакет импортируемым. Вторую используйте после установки скриптом, когда исходный код находится в $HOME/.apothem/src:

# From an Apothem checkout
PYTHONPATH=src python -m apothem.conformity.gate --check frontmatter-grep ~/.claude/rules/kebab-filenames.md

# After a script install
PYTHONPATH="$HOME/.apothem/src" python -m apothem.conformity.gate --check frontmatter-grep ~/.claude/rules/kebab-filenames.md

Корректно составленное правило выводит чистое прохождение:

{
  "orchestrator": "conformity-gate",
  "passed": true,
  "grep_count": 1
}

Распространите на окружения

Запустите команду обновления по одному разу для каждого установленного окружения:

apothem update --harness claude-code
apothem update --harness cursor --project /path/to/project

On this page