0e7097ed1b
First-attempt commit3a5c6e184only captured the .gitignore change; the pre-commit hook silently dropped the 343 staged moves/deletes during lint-staged's "no matching task" path. This commit re-applies the intended J1 content on top ofbec75f143(which was pushed in parallel). Uses --no-verify because: - J1 only touches .md/.json/.log/.png/binaries — zero code that would benefit from lint-staged, typecheck, or vitest - The hook demonstrated it corrupts pure-rename commits in this repo - Explicitly authorized by user for this one commit Changes (343 total: 169 deletions + 174 renames): Binaries purged (~167 MB): - veza-backend-api/{server,modern-server,encrypt_oauth_tokens,seed,seed-v2} Generated reports purged: - 9 apps/web/lint_report*.json (~32 MB) - 8 apps/web/tsc_*.{log,txt} + ts_*.log (TS error snapshots) - 3 apps/web/storybook_*.json (1375+ stored errors) - apps/web/{build_errors*,build_output,final_errors}.txt - 70 veza-backend-api/coverage*.out + coverage_groups/ (~4 MB) - 3 veza-backend-api/internal/handlers/*.bak Root cleanup: - 54 audit-*.png (visual regression baselines, ~11 MB) - 9 stale MVP-era scripts (Jan 27, hardcoded v0.101): start_{iteration,mvp,recovery}.sh, test_{mvp_endpoints,protected_endpoints,user_journey}.sh, validate_v0101.sh, verify_logs_setup.sh, gen_hash.py Session docs archived (not deleted — preserved under docs/archive/): - 78 apps/web/*.md → docs/archive/frontend-sessions-2026/ - 43 veza-backend-api/*.md → docs/archive/backend-sessions-2026/ - 53 docs/{RETROSPECTIVE_V,SMOKE_TEST_V,PLAN_V0_,V0_*_RELEASE_SCOPE, AUDIT_,PLAN_ACTION_AUDIT,REMEDIATION_PROGRESS}*.md → docs/archive/v0-history/ README.md and CONTRIBUTING.md preserved in apps/web/ and veza-backend-api/. Note: The .gitignore rules preventing recurrence were already pushed in3a5c6e184and remain in place — this commit does not modify .gitignore. Refs: AUDIT_REPORT.md §11
86 lines
4.4 KiB
Markdown
86 lines
4.4 KiB
Markdown
# Plan de Documentation des Composants UI
|
|
|
|
## 🎯 Objectif
|
|
Documenter tous les composants UI avec JSDoc pour améliorer la maintenabilité et l'expérience développeur.
|
|
|
|
## 📋 Composants à Documenter (54 composants)
|
|
|
|
### Phase 1 : Composants de Base (✅ Complétée)
|
|
1. ✅ Button - Documenté avec JSDoc complet (variants, sizes, exemples)
|
|
2. ✅ Input - Documenté avec JSDoc complet (label, icon, exemples)
|
|
3. ✅ Card - Documenté avec JSDoc complet (variants, sous-composants, exemples)
|
|
4. ✅ Checkbox - Documenté avec JSDoc complet (label, onCheckedChange, exemples)
|
|
5. ✅ Alert - Documenté avec JSDoc complet (variants, title, onClose, exemples)
|
|
6. ✅ Textarea - Documenté avec JSDoc complet (label, error, exemples)
|
|
7. ✅ Progress - Documenté avec JSDoc complet (variants, colors, labels, exemples)
|
|
8. ✅ Tabs - Documenté avec JSDoc complet (Tabs, TabsList, TabsTrigger, TabsContent)
|
|
9. ✅ Label - Documenté avec JSDoc complet
|
|
10. ✅ Switch - Documenté avec JSDoc complet (checked, onCheckedChange, exemples)
|
|
11. ✅ RadioGroup - Documenté avec JSDoc complet (RadioGroup, RadioGroupItem)
|
|
12. ✅ EmptyState - Documenté avec JSDoc complet (icon, title, description, action, size)
|
|
13. ✅ Table - Documenté avec JSDoc complet (Table, TableHeader, TableBody, TableRow, TableCell, etc.)
|
|
14. ✅ ScrollArea - Documenté avec JSDoc complet (ScrollArea, ScrollBar)
|
|
15. ✅ Slider - Documenté avec JSDoc complet (value, min, max, step, exemples)
|
|
16. ✅ Toast - Documenté avec JSDoc complet (type, message, onClose, exemples)
|
|
17. ✅ FormField - Documenté avec JSDoc complet (label, error, required, helpText)
|
|
18. ✅ HelpText - Documenté avec JSDoc complet (text, position, exemples)
|
|
19. ✅ ConfirmationDialog - Documenté avec JSDoc complet (open, onConfirm, variant, isLoading)
|
|
20. ✅ ButtonLoading - Documenté avec JSDoc complet (isLoading, loadingText, exemples)
|
|
|
|
### Phase 2 : Composants Avancés (✅ Complétée)
|
|
21. ✅ DataList - Documenté avec JSDoc complet (items, renderItem, keyExtractor, états)
|
|
22. ✅ FocusTrap - Documenté avec JSDoc complet (active, onEscape, exemples)
|
|
23. ✅ DropdownMenu - Documenté avec JSDoc complet (DropdownMenu, DropdownMenuTrigger, DropdownMenuContent)
|
|
24. ✅ ImageCropper - Documenté avec JSDoc complet (aspectRatio, circularCrop, contrôles)
|
|
25. ✅ ImageViewerModal - Documenté avec JSDoc complet (navigation, téléchargement)
|
|
26. ✅ LazyComponent - Documenté avec JSDoc complet (createLazyComponent factory)
|
|
27. ✅ OptimizedImage - Documenté avec JSDoc complet (lazy loading, formats multiples, blur)
|
|
28. ✅ VirtualizedList - Documenté avec JSDoc complet (virtualisation, callbacks)
|
|
29. ✅ WaveformVisualizer - Documenté avec JSDoc complet (waveformData, progress, onSeek)
|
|
30. ✅ AvatarUpload - Documenté avec JSDoc complet (drag-drop, preview, validation)
|
|
31. ✅ Dialog - Documenté avec JSDoc complet (variants, actions, tailles)
|
|
32. ✅ Modal - Documenté avec JSDoc complet (backdrop, header, footer)
|
|
33. ✅ Select - Documenté avec JSDoc complet (multi-select, recherche, groupes)
|
|
34. ✅ Dropdown - Documenté avec JSDoc complet (trigger, align, backdrop)
|
|
35. ✅ Tooltip - Documenté avec JSDoc complet (positionnement, triggers, délai)
|
|
36. ✅ Badge - Documenté avec JSDoc complet (variants, tailles, count, dot)
|
|
37. ✅ Avatar - Documenté avec JSDoc complet (tailles, statuts, initiales)
|
|
38. ✅ Skeleton - Documenté avec JSDoc complet (variants, dimensions)
|
|
39. ✅ LoadingSpinner - Documenté avec JSDoc complet (tailles, texte)
|
|
40. ✅ DatePicker - Documenté avec JSDoc complet (single/range, validation)
|
|
|
|
### Phase 3 : Composants Spécialisés (✅ Complétée)
|
|
41. ✅ FileUpload - Documenté avec JSDoc complet (drag-drop, preview, validation, multi-fichiers)
|
|
42. ⏳ ViewToggle - À documenter (composant de navigation)
|
|
43. ⏳ Tabs (navigation) - À documenter (composant de navigation)
|
|
|
|
## 📝 Format de Documentation JSDoc
|
|
|
|
Chaque composant doit avoir :
|
|
- Description du composant
|
|
- Description de chaque prop
|
|
- Exemples d'utilisation
|
|
- Notes sur les variants disponibles
|
|
- Notes sur l'accessibilité si applicable
|
|
|
|
## 🔧 Template JSDoc
|
|
|
|
```typescript
|
|
/**
|
|
* [Nom du composant] - [Description courte]
|
|
*
|
|
* [Description détaillée du composant et de son usage]
|
|
*
|
|
* @example
|
|
* ```tsx
|
|
* <Component prop1="value" prop2={value} />
|
|
* ```
|
|
*
|
|
* @example
|
|
* ```tsx
|
|
* // Exemple avec variant
|
|
* <Component variant="primary" />
|
|
* ```
|
|
*/
|
|
```
|
|
|