public

Published on 5/28/2025

etbat

Rules

🚀 Règles de Développement EtBat

Build & Development Commands

Langue : uniquement en Français
Démarrage développement : npm run dev ou npm run dev:tracked pour le suivi automatique
Build production : npm run build - obligatoire avant tout déploiement
Vérification types : npm run type-check - doit passer sans erreur
Lint automatique : npm run lint:fix - corrige automatiquement les erreurs
Analyse bundle : npm run analyze - pour optimiser la taille des bundles
Environnement Safari : npm run dev:safari - pour tests spécifiques Safari
Kill serveur : npm run dev:kill - arrêt propre du serveur de développement
Synchronisation complète : npm run sync:all - lint + tests + commit automatique
Audit sécurité : npm run security:audit - vérification complète sécurité
Validation SEO : npm run seo:validate - tests complets SEO et performances

Testing Guidelines

Tests unitaires : npm run test:unit - obligatoire avant chaque commit
Tests d'intégration : npm run test:integration - validation des API et DB
Tests E2E : npm run test:e2e - parcours utilisateur complets
Tests avec UI : npm run test:e2e:ui - interface graphique Playwright
Couverture de code : npm run test:coverage - minimum 80% requis
Tests en mode watch : npm run test:watch - développement continu
Tests complets : npm run test:all - toute la suite de tests
Tests trackés : npm run test:tracked - avec suivi automatique des métriques
Tests sécurité : npm run security:test - validation des vulnérabilités
Setup base test : npm run db:test:setup - réinitialisation environnement test

Règles de Test Obligatoires

✅ Chaque nouveau composant React doit avoir des tests unitaires
✅ Chaque nouvelle route API doit avoir des tests d'intégration
✅ Les fonctionnalités critiques doivent avoir des tests E2E
✅ Couverture minimum 80% pour les nouvelles fonctionnalités
✅ Tests de sécurité obligatoires pour les endpoints sensibles
❌ Aucun commit sans que npm run test:unit passe

Code Style & Guidelines

Prettier : Formatage automatique avec prettier --write
ESLint : Configuration Next.js stricte + règles personnalisées
TypeScript : Mode strict activé - types explicites obligatoires
Husky : Hooks Git automatiques pour validation pre-commit
Lint-staged : Validation automatique des fichiers modifiés

Standards de Code Obligatoires

✅ TypeScript strict : Pas de any, interfaces explicites
✅ Nomenclature : PascalCase pour composants, camelCase pour fonctions
✅ Imports : Chemins absolus avec alias @/ obligatoires
✅ Composants : Props typées avec interfaces dédiées
✅ Hooks : Préfixe use et logique métier externalisée
✅ API Routes : Validation Zod obligatoire sur toutes entrées
✅ Error Handling : Try-catch systématique + logs Sentry
✅ Performance : React.memo, useCallback, useMemo quand approprié
✅ Sécurité : Validation CSRF, rate limiting, échappement XSS
❌ Interdictions : console.log en production, any TypeScript

Architecture des Dossiers

src/
├── app/                 # Next.js App Router
├── components/          # Composants réutilisables
│   ├── ui/             # Composants UI de base
│   ├── location/       # Composants métier location
│   └── simulator/      # Composants simulateur
├── hooks/              # Hooks personnalisés
├── lib/                # Utilitaires et configurations
├── types/              # Types TypeScript globaux
└── utils/              # Fonctions utilitaires

Documentation Guidelines

Standards stricts : Suivre docs/DOCUMENTATION_STANDARDS.md obligatoirement
Validation automatique : ./scripts/validate-docs.sh doit passer
Composants : Documentation .md obligatoire pour chaque composant
API Routes : Documentation complète avec exemples JSON et TypeScript
Changelog : Mise à jour obligatoire avant chaque merge en main

Documentation Obligatoire

✅ Chaque composant React → docs/COMPONENTS/[category]/ComponentName.md
✅ Chaque route API → docs/API/[RESOURCE]_ENDPOINTS.md
✅ Modèles Prisma → docs/DATABASE/PRISMA_MODELS.md
✅ Modifications → CHANGELOG.md mis à jour avant merge
✅ Breaking changes → Documentation migration fournie
✅ Exemples fonctionnels → Tous les exemples doivent être testés

Scripts de Validation Documentation

# Validation complète documentation
./scripts/validate-docs.sh

# Validation composants uniquement
./scripts/validate-components-docs.sh

# Validation API uniquement
./scripts/validate-api-docs.sh

# Génération auto documentation composant
node scripts/generate-component-doc.js ComponentName category

Template Structure Obligatoire

# 🧩 ComponentName

## 📋 Description

[Description détaillée obligatoire]

## 🎯 Utilisation

[Import et exemple basique]

## 🔧 Props TypeScript

[Interface complète avec tableau détaillé]

## 🧪 Tests

[Tests unitaires et d'accessibilité]

## 📝 Exemples Complets

[Exemples simples et avancés fonctionnels]

Base de Données & Prisma

Génération client : npm run db:generate après modification schema
Push développement : npm run db:push pour changements rapides
Migrations : npm run db:migrate pour changements versionnés
Production : npm run db:migrate:prod déploiement production uniquement
Seeding : npm run db:seed données de test et démo
Interface graphique : npm run db:studio exploration des données

Règles Base de Données

✅ Migrations : Obligatoires pour tous changements de schema
✅ Relations : Contraintes Foreign Keys strictes
✅ Index : Performance sur les champs de recherche fréquents
✅ Validation : Types Zod coherents avec schema Prisma
✅ Seeds : Données de test cohérentes et réalistes
❌ Direct DB changes : Pas de modification directe en production

Workflow Git Obligatoire

Pre-commit (Automatique)

npm run pre-commit
# Exécute : lint:fix + type-check + test:unit

Post-commit (Automatique)

npm run post-commit
# Exécute : update-progress (tracking)

Pre-push (Automatique)

npm run test:unit
# Validation finale avant push

Branches et Merges

✅ Feature branches : feature/nom-fonctionnalite
✅ Hotfix branches : hotfix/description-probleme
✅ Documentation : Obligatoire avant merge main
✅ Tests : Tous les tests doivent passer
✅ Review : Code review obligatoire par un pair
❌ Direct push main : Interdit, passer par PR uniquement

Sécurité & Performance

Sécurité Obligatoire

✅ Rate limiting : 100 req/min par IP sur APIs publiques
✅ CSRF Protection : Tokens sur tous POST/PUT/DELETE
✅ Input validation : Zod schemas sur toutes entrées
✅ SQL Injection : Prisma ORM uniquement, pas de raw queries
✅ XSS Protection : Échappement automatique, validation HTML
✅ Helmet CSP : Content Security Policy strict
✅ Audit régulier : npm audit + scan sécurité automatique

Performance Requise

✅ LCP < 2.5s : Largest Contentful Paint
✅ FID < 100ms : First Input Delay
✅ CLS < 0.1 : Cumulative Layout Shift
✅ Lighthouse Score > 90 : Performance, Accessibilité, SEO
✅ Bundle size : Monitoring avec npm run analyze
✅ Cache Redis : Données fréquentes en cache
✅ Images optimisées : WebP + responsive + lazy loading

Monitoring & Logs

Systèmes Activés

Sentry : Erreurs et performance en temps réel
Datadog RUM : Monitoring utilisateur réel
Vercel Analytics : Métriques de performance
Custom Logs : Système de logging personnalisé

Métriques Surveillées

✅ Uptime > 99.9% : Disponibilité service
✅ Error Rate < 0.1% : Taux d'erreur accepté
✅ Response Time < 500ms : Temps de réponse API
✅ User Experience : Core Web Vitals en continu

Scripts de Maintenance

Backups Automatiques

npm run security:backup        # Backup manuel complet
npm run security:backup:schedule  # Backup programmé

Tracking et Progress

npm run dev:tracked           # Développement avec tracking
npm run test:tracked          # Tests avec métriques
npm run update-progress       # Mise à jour métriques projet

Tests Spécialisés

npm run static:test           # Tests génération statique
npm run static:build          # Build et tests statiques
npm run lighthouse:test       # Tests Lighthouse automatiques

🚫 Interdictions Absolues

❌ Merge sans tests : Tous les tests doivent passer
❌ Push sans documentation : Documentation obligatoire
❌ console.log production : Utiliser le système de logs
❌ Types any : TypeScript strict obligatoire
❌ Credentials en dur : Variables d'environnement uniquement
❌ Direct DB queries : Prisma ORM obligatoire
❌ Dependances non auditées : npm audit doit passer

✅ Checklist Pre-Merge

[ ] Tests unitaires passent : npm run test:unit
[ ] Tests d'intégration passent : npm run test:integration
[ ] Validation TypeScript : npm run type-check
[ ] Lint sans erreur : npm run lint
[ ] Documentation complète et validée : ./scripts/validate-docs.sh
[ ] Changelog mis à jour avec détails précis
[ ] Audit sécurité passé : npm run security:audit
[ ] Performance validée : npm run lighthouse:test
[ ] Review de code effectuée par un pair
[ ] Breaking changes documentés si applicable

📝 Note : Ces règles sont obligatoires et non négociables. Elles garantissent la qualité, la sécurité et la maintenabilité du projet EtBat. En cas de doute, consultez docs/DOCUMENTATION_STANDARDS.md ou demandez une review d'équipe.