Simpl-Resultat/CLAUDE.md
le king fu d41ccbd618 docs(balance): ADR 0015 + guide + architecture + CHANGELOG for per-security detail (#218)
Final docs link of the Étape 2 stack (#210-#217).

- ADR 0015 (Accepted): holdings-per-snapshot model; aggregated-line-is-source-of-truth invariant (why non-breaking, cites ADR 0008 Modified Dietz per account); transaction-based alternative rejected (PP PR #779); latent gain vs per-security Modified Dietz (out of scope); detailed_since authoritative pivot; security-immortal-once-referenced (ON DELETE RESTRICT). Mirrors ADR 0014 structure.
- Guide: new 'Détail par titre' section in docs/guide-utilisateur.md (per-security entry, detail-account wizard, latent gain) + matching docs.balance.* i18n keys (FR + EN, in-app guide surface).
- architecture.md + CLAUDE.md: reconciled stale DB counters to real values — 20 tables / 24 indexes / 16 migrations (were 13/15/7 and 18/16/v9). Étape 2 delta: +2 tables (balance_securities, balance_snapshot_holdings) + 2 indexes + migrations v14/v15/v16. Backfilled v10-v16 in the migrations table, ADR table (0012 Rejected, +0013/0014/0015), new securities/detailed-save/latent-gain service surface.
- CHANGELOG.md + CHANGELOG.fr.md [Unreleased]: extended with #215 (wizard), #216 (drill-down + latent gain), #211 (auto-conversion note); did not duplicate #214's per-security entry. Bilingual parity.

Docs-only: no production TS/Rust logic touched. Gate green: build (tsc+vite) + 627 tests pass.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-06 14:17:03 -04:00

9.1 KiB

CLAUDE.md — Simpl'Résultat

@STATE.md

Contexte du projet

Simpl'Résultat est une application de bureau desktop privacy-first pour la gestion des finances personnelles. Elle traite localement les fichiers CSV bancaires sans aucune dépendance cloud. Projet solo entrepreneurial, en développement par Max.

Stack technique : Tauri v2 + React 19 + TypeScript + Tailwind CSS v4 Backend : Rust (commandes Tauri) Stockage : SQLite local (tauri-plugin-sql) Langues supportées : Français (FR) et Anglais (EN) Plateformes : Windows, Linux Version actuelle : 0.6.3 Licence : GPL-3.0-only


Principes fondamentaux

Privacy-first — NON NÉGOCIABLE

  • Zéro donnée envoyée vers un serveur tiers
  • Tout le traitement CSV et toutes les données financières restent en local
  • Aucune télémétrie, aucun analytics cloud

Précision financière

  • Toujours valider les montants selon les règles de parsing configurables (gestion des virgules/points, espaces, symboles monétaires)
  • Gérer l'encodage des fichiers CSV (UTF-8, Windows-1252, ISO-8859-15)

Internationalisation (i18n)

  • Toute chaîne affichée à l'utilisateur doit passer par le système i18n (i18next + react-i18next)
  • Jamais de texte en dur dans les composants React
  • Fichiers de traduction : src/i18n/locales/fr.json et src/i18n/locales/en.json

Architecture & structure du code

src/
├── components/          # 53 composants React organisés par domaine
│   ├── adjustments/     # Ajustements
│   ├── budget/          # Budget
│   ├── categories/      # Catégories hiérarchiques
│   ├── dashboard/       # Tableau de bord
│   ├── import/          # Wizard d'import (13 composants)
│   ├── layout/          # AppShell, Sidebar
│   ├── profile/         # Profils (PIN, formulaire, switcher)
│   ├── reports/         # Graphiques et rapports
│   ├── settings/        # Paramètres
│   ├── shared/          # Composants réutilisables
│   └── transactions/    # Transactions
├── contexts/            # ProfileContext (état global profil)
├── hooks/               # 13 hooks custom (useReducer)
├── pages/               # 11 pages
├── services/            # 14 services métier
├── shared/              # Types et constantes partagés
├── utils/               # Utilitaires (parsing, CSV, charts)
├── i18n/                # Config i18next + locales FR/EN
├── App.tsx              # Router principal (react-router-dom)
└── main.tsx             # Point d'entrée

src-tauri/
├── src/
│   ├── commands/        # 3 modules, 17 commandes Tauri
│   │   ├── fs_commands.rs           # Système de fichiers (6 commandes)
│   │   ├── export_import_commands.rs # Export/import chiffré (5 commandes)
│   │   └── profile_commands.rs      # Gestion des profils (6 commandes)
│   ├── database/        # Schémas SQL et migrations
│   │   ├── schema.sql               # Schéma initial (v1)
│   │   ├── seed_categories.sql      # Seed catégories (v2)
│   │   └── consolidated_schema.sql  # Schéma complet (nouveaux profils)
│   ├── lib.rs           # Point d'entrée, 7 migrations inline, plugins
│   └── main.rs
└── Cargo.toml

Règles d'architecture :

  • La logique métier va dans services/, jamais directement dans les composants
  • L'état de chaque domaine est géré par un hook useReducer dédié dans hooks/
  • Les composants React sont responsables de l'affichage uniquement
  • Toute opération sur les fichiers système passe par les commandes Tauri (Rust)
  • Les requêtes SQL passent par les services TypeScript via tauri-plugin-sql

Fonctionnalités principales

  • Import CSV : wizard multi-étapes, détection auto de l'encodage/délimiteur, templates de config, déduplication par fichier
  • Catégorisation : automatique (mots-clés avec priorité) et manuelle, drag-and-drop pour réorganiser
  • Transactions : filtrage, tri, split sur plusieurs catégories, notes
  • Budget : grille 12 mois, templates réutilisables, budget vs réel
  • Rapports : tendances mensuelles, répartition par catégorie, évolution dans le temps, graphiques interactifs (SVG patterns, menu contextuel)
  • Multi-profils : bases de données séparées, protection par PIN (Argon2), switching rapide
  • Export/Import : JSON/CSV avec chiffrement AES-256-GCM optionnel (format SREF)
  • Mises à jour : auto-updater intégré (tauri-plugin-updater)
  • Changelog bilingue : page /changelog avec historique complet, notes de version dynamiques FR/EN depuis CHANGELOG.md / CHANGELOG.fr.md (bundlés dans public/)

Conventions de code

React / TypeScript

  • Un composant = un fichier .tsx, nommé en PascalCase
  • Hooks custom dans hooks/, services dans services/
  • État local via useReducer dans les hooks de domaine

Rust / Tauri

  • Toutes les commandes Tauri retournent Result<T, String> pour la gestion d'erreurs
  • Documenter chaque commande avec un commentaire sur son rôle

Général

  • Commits en anglais, commentaires de code en anglais
  • Messages d'interface en français ET anglais (via i18n)
  • Tester les cas limites de parsing CSV (montants négatifs, cellules vides, formats inattendus)

Base de données

  • 20 tables SQLite, 24 index (voir docs/architecture.md pour le détail). Le module Bilan en représente 7 tables (balance_categories, balance_accounts, balance_snapshots, balance_snapshot_lines, balance_account_transfers, puis balance_securities + balance_snapshot_holdings ajoutées en Étape 2 — détail par titre) et 9 index
  • 16 migrations inline dans lib.rs (v1→v16, via tauri_plugin_sql::Migration). Étape 2 (détail par titre) : v14 (balance_securities + balance_snapshot_holdings + 2 index), v15 (balance_accounts.kind + detailed_since + backfill), v16 (conversion des comptes cotés existants en détaillés 1-position). Voir ADR 0015
  • Schéma consolidé (consolidated_schema.sql) pour l'initialisation des nouveaux profils
  • Les migrations appliquées sont protégées par checksum — ne jamais modifier une migration existante, toujours en créer une nouvelle

Documentation technique

La documentation technique est centralisée dans docs/ :

  • docs/architecture.md — Architecture technique complète (stack, BDD, services, hooks, commandes Tauri, routing, i18n, CI/CD)
  • docs/adr/ — Architecture Decision Records (décisions techniques structurantes)
  • docs/guide-utilisateur.md — Guide utilisateur
  • docs/archive/ — Anciennes spécifications archivées

Règle : quand un changement touche l'architecture, mettre à jour la documentation :

  • Nouveau service, hook, commande Tauri, page/route, ou table SQL → mettre à jour docs/architecture.md
  • Décision technique structurante (choix de librairie, pattern architectural, changement de stratégie) → créer un nouvel ADR dans docs/adr/
  • Changement affectant l'utilisation de l'app → mettre à jour docs/guide-utilisateur.md et les traductions i18n correspondantes (src/i18n/locales/fr.json, src/i18n/locales/en.json, clés sous docs.*)

Règle CHANGELOG : tout changement affectant le comportement utilisateur → ajouter une entrée sous ## [Unreleased] dans les deux fichiers :

  • CHANGELOG.md (anglais) — source principale
  • CHANGELOG.fr.md (français) — traduction
  • Catégories : Added/Ajouté, Changed/Modifié, Fixed/Corrigé, Removed/Supprimé
  • Format Keep a Changelog. Le contenu est extrait automatiquement par le CI pour les release notes et affiché dans l'app selon la langue de l'utilisateur.
  • The public/ copies are synced automatically: Vite copies them on dev/build start via syncChangelogs() in vite.config.ts. No manual sync needed.

Points d'attention RS&DE / CRIC

Pour maintenir l'éligibilité aux crédits d'impôt R&D (RS&DE fédéral + CRIC Québec) :

  • Documenter les incertitudes technologiques rencontrées pendant le développement
  • Noter les expérimentations et les approches alternatives testées
  • Garder un journal des avancées techniques (dans /docs/rnd-journal/)
  • Les algorithmes de catégorisation automatique et le parsing multi-format sont des activités R&D éligibles

CI/CD

  • check.yml (Forgejo Actions + miroir GitHub) — déclenché sur chaque push de branche (sauf main) et chaque PR vers main. Lance cargo check, cargo test, npm run build (tsc + vite) et npm test (vitest). Doit être vert avant tout merge.
  • release.yml — déclenché par les tags v*. Build Windows (NSIS .exe) + Linux (.deb, .rpm), signe les binaires et publie le JSON d'updater pour les mises à jour automatiques.

Ressources clés