docstodev 1.1.1 → 2.0.1

package/docs/docs-to-dev.md

@@ -0,0 +1,225 @@
+# Rapport Technique DocsToDev
+
+> 📅 Généré le : vendredi 9 janvier 2026 à 09:22
+> 📊 7 fichiers analysés • 15 dépendances identifiées
+
+## 💡 Analyse Intelligente
+
+## 1.
+
+**`But` du `Projet`**
+`Le` projet `DocsToDev` vise à analyser des données techniques brutes et à les transformer en documentation métier claire et structurée.
+
+`Il` résout les problèmes de compréhension et d'analyse de données techniques complexes pour les développeurs et les équipes de développement.
+
+`Le` public cible de ce projet inclut les développeurs, les architectes logiciels, et les équipes de développement qui cherchent à améliorer la qualité et la compréhension de leurs projets logiciels.
+
+## 2.
+
+**`Design` `System` Détecté**
+`Le` design system détecté dans le projet inclut :
+- **`Palette` de couleurs** : `Les` couleurs primaires et secondaires utilisées dans le projet ne sont pas explicitement définies dans les extraits de code fournis, mais il est mentionné que la palette de couleurs fait partie de l'analyse du design system.
+
+- **`Typographie`** : `Les` polices utilisées ne sont pas spécifiquement mentionnées dans les extraits de code fournis.
+
+- **`Patterns` de composants** : `Les` patterns de composants, tels que les cartes, les modales, les formulaires, etc., sont détectés et documentés dans le projet.
+
+## 3.
+
+**⚠️ `Risques` `Identifi`és**
+`Les` risques potentiels identifiés dans le projet sont classés par niveau :
+- 🔴 **`Critique`** : 
+  - `La` sécurité du projet pourrait être compromise si les clés API comme `GROQ_API_KEY` ne sont pas sécurisées correctement.
+
+- L'architecture du projet pourrait être affectée par la complexité et la maintenance des fichiers et des dépendances.
+
+- 🟡 **`Moyen`** : 
+  - `La` dette technique et les performances du projet pourraient être impactées par la complexité croissante des analyses et des exports.
+
+- 🟢 **`Faible`** : 
+  - `Les` améliorations mineures pourraient inclure la optimisation des requêtes, la mise à jour des dépendances, et la réduction de la duplication de code.
+
+## 4.
+
+**💡 `Recommandations`**
+`Les` actions concrètes pour améliorer le projet sont :
+- **`Refactoring`** : Réorganiser le code pour améliorer la lisibilité et la maintainabilité.
+
+- **`Optimisations`** : `Optimiser` les performances en utilisant des méthodes plus efficaces pour les analyses et les exports.
+
+- **`Bonnes` pratiques** : `Adopter` des bonnes pratiques de développement telles que les tests unitaires et d'intégration, et la mise à jour régulière des dépendances.
+
+## 5.
+
+**`Analyse` Détaillée des `Fichiers`**
+- **`src/ai/`analyzer.ts`** : `Ce` fichier contient les fonctions d'analyse de l'IA, notamment `askAI` et `askAIDetailed`, qui analysent les données techniques et retournent des résultats détaillés.
+
+- **`src/analyzers/`languageAnalyzer`.ts`** : `Ce` fichier contient les classes et les fonctions d'analyse de langage, notamment `TSJSAnalyzer`, qui analyse les fichiers de code et retourne des informations sur les exports, les imports, les fonctions, les classes, etc.
+
+- **`src/cache/`cacheManager`.ts`** : `Ce` fichier contient la classe `CacheManager`, qui gère le cache des analyses pour améliorer les performances.
+
+- **`src/cli/`index.ts`** : `Ce` fichier contient le point d'entrée de la ligne de commande, qui utilise les commandes pour exécuter les analyses et générer les rapports.
+
+- **`src/commands/`generateSummary`.ts`** : `Ce` fichier contient la fonction `generateSummary`, qui génère un résumé du projet en fonction des données d'analyse.
+
+- **`src/commands/`run.ts`** : `Ce` fichier contient la fonction `runCommand`, qui exécute les analyses et génère les rapports en fonction des options de la ligne de commande.
+
+- **`src/exporters/`html.ts`** : `Ce` fichier contient la fonction `exportToHTML`, qui exporte les résultats des analyses en format HTML.
+
+## 📂 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/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/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/cli/index.ts`](../src/cli/index.ts)
+
+**Complexité et maintenance** : 355 lignes • 🟡 Modérée (77)
+
+**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 |