docstodev 1.0.3 → 2.0.0

package/docs/docs-to-dev.md

@@ -0,0 +1,240 @@
+# Rapport Technique DocsToDev
+
+> 📅 Généré le : vendredi 9 janvier 2026 à 09:13
+> 📊 7 fichiers analysés • 15 dépendances identifiées
+
+## 💡 Analyse Intelligente
+
+### 1.
+
+**`But` du `Projet`**
+`Le` projet `DocsToDev` est conçu pour analyser et documenter des projets logiciels de manière automatique.
+
+`Il` utilise l'intelligence artificielle pour comprendre la structure, les dépendances et la complexité du code, puis génère une documentation claire et lisible.
+
+`Le` but principal est de faciliter la compréhension et la maintenance des projets logiciels en fournissant une vue d'ensemble détaillée de leur architecture, de leurs composants et de leurs interactions.
+
+### 2.
+
+**`Design` `System` Détecté**
+`Le` projet semble utiliser un design system personnalisé, avec les éléments suivants détectés :
+- **`Palette` de couleurs** : `Les` couleurs spécifiques utilisées ne sont pas explicitement définies dans les extraits de code fournis, mais il est mentionné que l'analyse peut inclure la détection de la palette de couleurs (`primaryColors`) dans le design system.
+
+- **`Typographie`** : `Il` n'y a pas d'informations spécifiques sur les polices utilisées, mais l'analyse du code peut inclure la détection de la typographie utilisée dans le projet.
+
+- **`Patterns` de composants** : `Les` patterns de composants (comme les cards, les modals, les formulaires, etc.) peuvent être détectés et analysés comme partie du design system du projet.
+
+### 3.
+
+**⚠️ `Risques` `Identifi`és**
+`Les` risques potentiels incluent :
+- 🔴 **`Critique`** : Dépendance à des clés API externes (comme la clé GROQ_API_KEY) qui pourraient être exposées ou non sécurisées.
+
+`Une` faille de sécurité dans le stockage ou l'utilisation de ces clés pourrait compromettre la sécurité du projet.
+
+- 🟡 **`Moyen`** : `La` complexité du code dans certains fichiers (comme `languageAnalyzer`.ts`) pourrait rendre la maintenance difficile.
+
+`Il` est important de maintenir une dette technique faible pour assurer la facilité de modification et d'extension du code.
+
+- 🟢 **`Faible`** : L'utilisation de versions spécifiques de bibliothèques et frameworks pourrait nécessiter des mises à jour régulières pour garantir la compatibilité et la sécurité.
+
+### 4.
+
+**💡 `Recommandations`**
+`Pour` améliorer le projet, les actions suivantes sont recommandées :
+1.
+
+**`Refactoring`** : `Simplifier` et modulariser le code complexe pour améliorer la lisibilité et la maintenabilité.
+
+2.
+
+**`Optimisations`** : `Utiliser` des techniques d'optimisation pour améliorer les performances, comme la mise en cache des résultats d'analyse ou l'utilisation de workers pour les tâches longues.
+
+3.
+
+**Sécurité** : `Mettre` en place des mesures de sécurité robustes pour protéger les clés API et les données sensibles, comme l'utilisation de variables d'environnement sécurisées ou de services de gestion de secrets.
+
+4.
+
+**`Tests` `Automatis`és** : Développer des tests unitaires et d'intégration pour garantir la stabilité et la qualité du code.
+
+5.
+
+**`Documentation`** : `Maintenir` une documentation claire et à jour sur l'architecture, les APIs, et les bonnes pratiques de développement pour faciliter la contribution et la maintenance.
+
+### 5.
+
+**`Analyse` Détaillée des `Fichiers`**
+- **`src/ai/`analyzer.ts`** : `Ce` fichier est responsable de l'analyse intelligente du projet, utilisant des options configurables pour déterminer ce qui doit être analysé.
+
+`Il` exporte des fonctions pour demander une analyse simplifiée ou détaillée.
+
+- **`src/cache/`cacheManager`.ts`** : Gère le système de cache pour stocker les résultats d'analyse, améliorant ainsi les performances en évitant les analyses redondantes.
+
+- **`src/analyzers/`languageAnalyzer`.ts`** : `Contient` des analyseurs pour différents langages de programmation, permettant d'extraire des informations spécifiques à chaque langage.
+
+- **`src/cli/`index.ts`** : `Point` d'entrée de l'interface de ligne de commande, permettant aux utilisateurs d'exécuter des commandes pour analyser des projets et générer des rapports.
+
+- **`src/commands/`generateSummary`.ts`** : Génère un résumé du projet analysé, incluant des informations sur les fichiers, la complexité, et les langages détectés.
+
+- **`src/commands/`run.ts`** : `Ex`écute l'analyse du projet et génère un rapport détaillé, utilisant les informations collectées par les analyseurs.
+
+- **`src/exporters/`html.ts`** : `Exporte` le rapport d'analyse au format HTML, permettant une visualisation facile des résultats dans un navigateur web.
+
+## 📂 Architecture du projet
+
+```
+├─ [package-lock.json](../package-lock.json)
+├─ [package.json](../package.json)
+├─ [src/ai/analyzer.ts](../src/ai/analyzer.ts)
+├─ [src/analyzers/languageAnalyzer.ts](../src/analyzers/languageAnalyzer.ts)
+├─ [src/cache/cacheManager.ts](../src/cache/cacheManager.ts)
+├─ [src/cli/index.ts](../src/cli/index.ts)
+├─ [src/commands/generateSummary.ts](../src/commands/generateSummary.ts)
+├─ [src/commands/run.ts](../src/commands/run.ts)
+├─ [src/exporters/html.ts](../src/exporters/html.ts)
+└─ [tsconfig.json](../tsconfig.json)
+```
+
+## 🔬 Analyse détaillée des composants
+
+### 📄 [`src/ai/analyzer.ts`](../src/ai/analyzer.ts)
+
+**Complexité et maintenance** : 289 lignes • 🟢 Faible (46)
+
+**Fonctions** : `askAI()`, `askAIDetailed()`, `buildSystemPrompt()`, `parseAIResponse()`
+
+**Types/Interfaces** : `AIAnalysisOptions`, `AIAnalysisResult`
+
+**Exports publics** : `AIAnalysisOptions`, `AIAnalysisResult`, `askAI`, `askAIDetailed`
+
+---
+
+### 📄 [`src/cache/cacheManager.ts`](../src/cache/cacheManager.ts)
+
+**Complexité et maintenance** : 179 lignes • 🟢 Faible (36)
+
+**Classes** : `CacheManager`
+
+**Types/Interfaces** : `CacheEntry`, `CacheManifest`
+
+**Exports publics** : `CacheEntry`, `CacheManifest`, `CacheManager`
+
+**Dépendances** :
+
+• `node:crypto` (Node.js) → utilise `createHash`
+• `node:fs` (Node.js) → utilise `readFileSync, writeFileSync, existsSync, statSync, mkdirSync`
+• `node:path` (Node.js) → utilise `path`
+
+---
+
+### 📄 [`src/analyzers/languageAnalyzer.ts`](../src/analyzers/languageAnalyzer.ts)
+
+**Complexité et maintenance** : 580 lignes • 🟠 Élevée (270)
+
+**Fonctions** : `getAnalyzer()`, `getSupportedExtensions()`, `isExplicitlySupported()`
+
+**Classes** : `TSJSAnalyzer`, `PythonAnalyzer`, `JavaAnalyzer`, `CSharpAnalyzer`, `GoAnalyzer`, `RustAnalyzer`, `HTMLAnalyzer`, `CSSAnalyzer`, `PHPAnalyzer`, `RubyAnalyzer`, `SQLAnalyzer`, `DefaultAnalyzer`
+
+**Types/Interfaces** : `LanguageAnalyzer`, `FileAnalysisResult`
+
+**Exports publics** : `LanguageAnalyzer`, `FileAnalysisResult`, `getAnalyzer`, `getSupportedExtensions`, `isExplicitlySupported`
+
+---
+
+### 📄 [`src/cli/index.ts`](../src/cli/index.ts)
+
+**Complexité et maintenance** : 354 lignes • 🟡 Modérée (76)
+
+**Fonctions** : `typeWriter()`, `showBanner()`, `selectLanguage()`, `showTransition()`
+
+**Classes** : `Spinner`, `ProgressBar`
+
+**Dépendances** :
+
+• `commander` (NPM) → utilise `Command`
+• `../commands/run.js` (Interne) → utilise `runCommand`
+• `../commands/generateSummary.js` (Interne) → utilise `generateSummary`
+• `node:readline/promises` (Node.js) → utilise `readline`
+• `node:process` (Node.js) → utilise `stdin as input, stdout as output`
+• `node:path` (Node.js) → utilise `path`
+
+---
+
+### 📄 [`src/commands/generateSummary.ts`](../src/commands/generateSummary.ts)
+
+**Complexité et maintenance** : 150 lignes • 🟢 Faible (27)
+
+**Fonctions** : `generateSummary()`
+
+**Types/Interfaces** : `SummaryData`
+
+**Exports publics** : `generateSummary`
+
+**Dépendances** :
+
+• `node:fs` (Node.js) → utilise `writeFileSync, mkdirSync`
+• `node:path` (Node.js) → utilise `path`
+
+---
+
+### 📄 [`src/commands/run.ts`](../src/commands/run.ts)
+
+**Complexité et maintenance** : 459 lignes • 🟡 Modérée (108)
+
+**Fonctions** : `buildTree()`, `renderTree()`, `analyzeFile()`, `getComplexityLevel()`, `formatAISummary()`, `runCommand()`, `generatePDF()`
+
+**Types/Interfaces** : `AIAnalysisOptions`, `TreeNode`, `FileAnalysis`
+
+**Exports publics** : `runCommand`
+
+**Dépendances** :
+
+• `globby` (NPM) → utilise `globby`
+• `node:fs` (Node.js) → utilise `writeFileSync, readFileSync, existsSync, mkdirSync`
+• `node:path` (Node.js) → utilise `path`
+• `puppeteer` (NPM) → utilise `puppeteer`
+• `../exporters/html.js` (Interne) → utilise `exportToHTML`
+• `../ai/analyzer.js` (Interne) → utilise `askAIDetailed, type AIAnalysisOptions`
+• `../analyzers/languageAnalyzer.js` (Interne) → utilise `getAnalyzer, getSupportedExtensions`
+• `../cache/cacheManager.js` (Interne) → utilise `CacheManager`
+
+---
+
+### 📄 [`src/exporters/html.ts`](../src/exporters/html.ts)
+
+**Complexité et maintenance** : 894 lignes • 🟠 Élevée (152)
+
+**Fonctions** : `exportToHTML()`, `toggleTheme()`, `sanitizeMermaidGraph()`, `generateHierarchyGraph()`, `sanitizeLabel()`, `getFileExtension()`, `getNodeStyle()`, `traverse()`, `getDefaultHierarchyGraph()`, `generateDataFlowGraph()`, `formatRisksSection()`, `formatText()`
+
+**Types/Interfaces** : `TreeStructure`
+
+**Exports publics** : `exportToHTML`
+
+**Dépendances** :
+
+• `node:fs` (Node.js) → utilise `writeFileSync`
+• `node:path` (Node.js) → utilise `path`
+• `https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs` (NPM) → utilise `mermaid`
+
+---
+
+## 📦 Modules externes
+
+| Module | Type | Occurrences |
+| :--- | :--- | :---: |
+| `../ai/analyzer.js` | Interne | 1 |
+| `../analyzers/languageAnalyzer.js` | Interne | 1 |
+| `../cache/cacheManager.js` | Interne | 1 |
+| `../commands/generateSummary.js` | Interne | 1 |
+| `../commands/run.js` | Interne | 1 |
+| `../exporters/html.js` | Interne | 1 |
+| `commander` | NPM | 1 |
+| `globby` | NPM | 1 |
+| `https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs` | NPM | 1 |
+| `node:crypto` | Node.js | 1 |
+| `node:fs` | Node.js | 4 |
+| `node:path` | Node.js | 5 |
+| `node:process` | Node.js | 1 |
+| `node:readline/promises` | Node.js | 1 |
+| `puppeteer` | NPM | 1 |