Skip to content
Apothem
Exemplos

Regra personalizada

Criar uma regra permanente personalizada para o seu projeto.

Este exemplo adiciona uma regra permanente específica do projeto que impõe uma convenção de nomenclatura em todos os arquivos.

Arquivo da regra

---
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.

Salve isto em rules/kebab-filenames.md dentro da raiz de instalação do seu harness (~/.claude/ para o adaptador do Claude Code; caso contrário, substitua pelo caminho nativo do harness).

Verifique se a regra está bem formada

Execute o validador de frontmatter sobre o arquivo de regra que você acabou de escrever. Use o primeiro comando a partir de um checkout do Apothem, em que PYTHONPATH=src torna o pacote importável. Use o segundo após uma instalação por script, em que o código-fonte fica em $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

Uma regra bem formada gera uma aprovação limpa:

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

Propagar para os harnesses

Execute o comando de atualização uma vez para cada harness instalado:

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

On this page