Skip to content
Apothem
Exemples

Règle personnalisée

Rédiger une règle permanente personnalisée pour votre projet.

Cet exemple ajoute une règle permanente propre au projet qui impose une convention de nommage à tous les fichiers.

Fichier de la règle

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

Enregistrez ceci dans rules/kebab-filenames.md au sein de la racine d'installation de votre environnement (~/.claude/ pour l'adaptateur Claude Code ; pour les autres environnements, remplacez-la par leur chemin natif).

Vérifier que la règle est bien formée

Lancez le validateur de frontmatter sur le fichier de règle que vous venez d'écrire. Utilisez la première commande depuis un checkout d'Apothem, où PYTHONPATH=src rend le paquet importable. Utilisez la seconde après une installation par script, où les sources se trouvent sous $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

Une règle bien formée signale une réussite sans réserve :

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

Propager vers les environnements

Exécutez la commande de mise à jour une fois par environnement installé :

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

On this page