docstodev 3.0.3 → 3.0.4

package/README.md

@@ -1,60 +1,88 @@
+# 🚀 DocsToDev
 
-DocsToDev 🚀
-Solution d'automatisation de documentation technique intelligente
+**L'intelligence artificielle au service de votre documentation technique.**
 
-DocsToDev est une extension avancée pour Visual Studio Code conçue pour générer automatiquement une documentation technique complète, structurée et compréhensible à partir du code source d'un projet. Elle transforme n'importe quelle base de code complexe en une source de savoir claire et exploitable pour tous les acteurs du projet.
+DocsToDev est une solution d'automatisation avancée qui transforme des bases de code complexes en une documentation structurée, visuelle et compréhensible. Créé par **Chadrack Massamba (EsporDev)**, cet outil comble le fossé entre le code brut et la connaissance métier.
 
-✨ Fonctionnalités Clés
+---
 
-Analyse Statique Profonde : Analyse l'intégralité de l'arborescence en parcourant tous les fichiers et sous-dossiers pertinents.
+## ✨ Fonctionnalités Clés
 
+* **🔍 Analyse Statique Hybride** : Combine l'analyse déterministe (AST) et l'IA (**MakazouIA**) pour interpréter le rôle métier de chaque fichier.
+* **📂 Arborescence Dynamique** : Génère une vue explorateur fidèle à votre structure de dossiers.
+* **📊 Graphes de Dépendances** : Visualisation automatique des flux et interactions via Mermaid.js.
+* **⚡ Mode Incrémental** : Système de cache performant pour n'analyser que les fichiers modifiés.
+* **🌍 Multi-format** : Export interactif en HTML, PDF, Markdown et TXT.
 
-Exclusion Intelligente : Ignore automatiquement les répertoires non essentiels comme node_modules, .git, dist, ou .docstodev.
+---
 
+## 🛠️ Installation & Prérequis
 
-Système Hybride Unique : Combine une analyse statique déterministe (imports, exports, routes) avec une couche d'Intelligence Artificielle (GPT, Grok) pour des descriptions humaines explicites sans "inventer" de données.
+### Installation globale
 
+```bash
+npm install -g docstodev
 
-Visualisation des Dépendances : Génération automatique de graphiques (Mermaid) pour visualiser les interactions entre composants, APIs et services.
+```
 
-Mode Incrémental & Cache : Système de cache performant permettant de n'analyser que les fichiers modifiés depuis la dernière session.
+### 💡 Note importante (Projets non-JS)
 
+> [!IMPORTANT]
+> **NB :** Si votre projet n'est pas un projet Node.js (ex: projet **HTML/CSS pur, PHP, Python, ou C#**), vous devez impérativement initialiser un environnement npm à la racine de votre dossier avant de lancer l'outil :
+> ```bash
+> npm init -y
+> 
+> ```
+> 
+> 
+> Cela permet à DocsToDev de gérer correctement le cache et les dépendances d'analyse.
 
-Multi-formats d'Export : Exportation de la documentation en .md (Markdown), .html (interactif), .pdf et .txt.
+---
 
-🛠️ Installation et Prérequis
-Pour utiliser DocsToDev en ligne de commande, suivez ces étapes :
+## 🚀 Utilisation (CLI)
 
-Installation des dépendances :
+Une fois installé, une seule commande suffit pour documenter tout votre projet :
 
-Compilation du projet (nécessaire pour transformer le TypeScript en JavaScript exécutable) :
+```bash
+npx docstodev run
 
-🚀 Utilisation (CLI)
-Une fois le projet compilé, vous pouvez lancer l'analyse via npx :
+```
 
-Options disponibles :
+### Options disponibles :
 
---lang <fr|en> : Force la langue du rapport (Français ou Anglais).
+| Option | Description |
+| --- | --- |
+| `--lang <fr | en>` |
+| `-i, --incremental` | Analyse uniquement les fichiers modifiés (gain de temps). |
+| `--clear-cache` | Vide le cache et force une analyse complète. |
+| `--no-animation` | Désactive les animations dans le terminal (idéal pour CI/CD). |
 
--i, --incremental : Analyse uniquement les fichiers modifiés pour un gain de temps majeur.
+---
 
---clear-cache : Vide le cache avant de démarrer l'analyse.
+## 🏗️ Architecture et Langages Supportés
 
---no-animation : Désactive les animations dans le terminal.
+DocsToDev identifie automatiquement le rôle exact de chaque fichier (Page, UI Component, API endpoint, Service, etc.).
 
-Gestion du cache :
-🏗️ Architecture et Langages Supportés
-DocsToDev repose sur un moteur capable d'identifier automatiquement le rôle exact de chaque fichier (Page, UI Component, API endpoint, Service, etc.).
+* **Web** : TypeScript (`.ts`, `.tsx`), JavaScript (`.js`, `.jsx`).
+* **Backend** : Python (`.py`), Java (`.java`), C# (`.cs`), Go (`.go`), Rust (`.rs`), PHP (`.php`).
+* **Design** : CSS, SCSS, HTML.
 
-Langages supportés :
+---
 
-Web : TypeScript (.ts, .tsx), JavaScript (.js, .jsx, .mjs, .cjs).
+## 👥 Bénéficiaires et Cas d'Usage
 
-Backend & Système : Python (.py), Java (.java), C# (.cs), Go (.go), Rust (.rs).
+* **Onboarding** : Intégrez un nouveau développeur sur un projet existant en quelques minutes.
+* **Audit technique** : Visualisez instantanément la complexité et les risques d'une base de code.
+* **Documentation continue** : Maintenez une doc à jour à chaque commit sans effort manuel.
 
-👥 Bénéficiaires et Cas d'Usage
-📄 Licence et Crédits
-Développé par EspoirDev Massamba Kiminou Chadrack Delmard.
+---
 
+## 📄 Licence et Crédits
 
-Date du projet : 6 janvier 2026.
+**Développeur** : Chadrack Massamba (EsporDev)
+
+**Date du projet** : 6 janvier 2026
+
+**Contact** : espoirdev2006@gmail.com
+
+---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docstodev",
-  "version": "3.0.3",
+  "version": "3.0.4",
   "description": "Solution d’automatisation de documentation technique intelligente avec IA",
   "type": "module",
   "main": "dist/cli/index.js",
@@ -32,6 +32,7 @@
   "dependencies": {
     "chalk": "^5.4.1",
     "commander": "^13.1.0",
+    "docstodev": "^3.0.3",
     "dotenv": "^16.4.7",
     "globby": "^14.0.2",
     "puppeteer": "^24.1.1"

package/src/commands/run.ts

@@ -316,13 +316,11 @@ export async function runCommand(
     }
     finalMD += `\n`;
 
-    // Section BUT DU PROJET (PRIORITÉ ABSOLUE)
     if (aiResult.projectGoal) {
         finalMD += `## 🎯 ${t.projectGoal}\n\n`;
         finalMD += `${aiResult.projectGoal}\n\n`;
     }
 
-    // Section DESIGN SYSTEM
     if (aiResult.designSystem && aiOptions.includeDesignSystem) {
         finalMD += `## 🎨 ${t.designSystem}\n\n`;
         if (aiResult.designSystem.primaryColors && aiResult.designSystem.primaryColors.length > 0) {
@@ -336,7 +334,6 @@ export async function runCommand(
         }
     }
 
-    // Section RISQUES
     if (aiResult.risks && aiOptions.includeRisks && aiResult.risks.length > 0) {
         finalMD += `## ⚠️ ${t.risks}\n\n`;
         aiResult.risks.forEach(risk => {
@@ -346,7 +343,6 @@ export async function runCommand(
         });
     }
 
-    // Section RECOMMANDATIONS
     if (aiResult.recommendations && aiOptions.includeRecommendations && aiResult.recommendations.length > 0) {
         finalMD += `## 💡 ${t.recommendations}\n\n`;
         aiResult.recommendations.forEach(reco => {
@@ -355,19 +351,13 @@ export async function runCommand(
         finalMD += `\n`;
     }
 
-    // Analyse IA complète
     finalMD += `## 💡 ${t.aiTitle}\n\n${formattedAiSummary}\n\n`;
-    
-    // Structure du projet
     finalMD += `## 📂 ${t.structure}\n\n`;
     finalMD += "```\n";
     finalMD += renderTree(buildTree(files));
     finalMD += "```\n\n";
-    
-    // Analyse détaillée
     finalMD += detailContent;
     
-    // Dépendances
     finalMD += `## 📦 ${t.deps}\n\n`;
     finalMD += `| Module | Type | Occurrences |\n`;
     finalMD += `| :--- | :--- | :---: |\n`;
@@ -393,10 +383,6 @@ export async function runCommand(
     exportToHTML(docsDir, finalMD, mermaidGraph, language, fileTreeStructure);
     console.log(`   ✓ Rapport HTML généré : docs/report.html\n`);
 
-    // console.log("📄 Étape 6/6 : Génération du PDF...");
-    // await generatePDF(path.join(docsDir, "report.html"), path.join(docsDir, "report.pdf"));
-    // console.log(`   ✓ PDF exporté : docs/report.pdf\n`);
-
     console.log("╔══════════════════════════════════════════╗");
     console.log("║   ✨ Analyse terminée avec succès !      ║");
     console.log("╚══════════════════════════════════════════╝\n");

package/src/exporters/html.ts

@@ -765,7 +765,8 @@ function generateHierarchyGraph(tree: TreeStructure, maxDepth: number = 4): stri
     let nodeId = 0;
 
     function sanitizeLabel(label: string): string {
-        return label.replace(/["\[\]]/g, '').replace(/\//g, '');
+        // Ne pas supprimer les slashes, juste nettoyer les caractères problématiques
+        return label.replace(/["\[\]]/g, '');
     }
 
     function getFileExtension(filename: string): string {
@@ -791,17 +792,34 @@ function generateHierarchyGraph(tree: TreeStructure, maxDepth: number = 4): stri
         return styleMap[ext] || ':::fileStyle';
     }
 
-    function traverse(obj: TreeStructure, parentId: string | null, depth: number): void {
+    function traverse(obj: TreeStructure, parentId: string | null, depth: number, parentPath: string = ''): void {
         if (depth > maxDepth) return;
 
         const entries = Object.entries(obj);
-
+        
+        // Séparer dossiers et fichiers
+        const folders: [string, TreeStructure | null][] = [];
+        const files: [string, TreeStructure | null][] = [];
+        
         entries.forEach(([key, value]) => {
+            const isFolder = value !== null && typeof value === 'object' && Object.keys(value).length > 0;
+            if (isFolder) {
+                folders.push([key, value]);
+            } else {
+                files.push([key, value]);
+            }
+        });
+
+        // Traiter d'abord les dossiers
+        folders.forEach(([key, value]) => {
             const currentId = `node${nodeId++}`;
-            const isFolder = value && typeof value === 'object' && Object.keys(value).length > 0;
-            const label = sanitizeLabel(key);
-            const displayLabel = isFolder ? `📁 ${label}` : `📄 ${label}`;
-            const style = getNodeStyle(key, isFolder || false);
+            const currentPath = parentPath ? `${parentPath}/${key}` : key;
+            
+            // Afficher seulement le nom du dossier, pas le chemin complet
+            const displayName = key.split('/').pop() || key;
+            const label = sanitizeLabel(displayName);
+            const displayLabel = `📁 ${label}`;
+            const style = ':::folderStyle';
 
             graph += `    ${currentId}["${displayLabel}"]${style}\n`;
 
@@ -809,8 +827,25 @@ function generateHierarchyGraph(tree: TreeStructure, maxDepth: number = 4): stri
                 graph += `    ${parentId} --> ${currentId}\n`;
             }
 
-            if (isFolder && value && depth < maxDepth) {
-                traverse(value, currentId, depth + 1);
+            if (value && depth < maxDepth) {
+                traverse(value, currentId, depth + 1, currentPath);
+            }
+        });
+
+        // Ensuite traiter les fichiers
+        files.forEach(([key, value]) => {
+            const currentId = `node${nodeId++}`;
+            
+            // Afficher seulement le nom du fichier
+            const displayName = key.split('/').pop() || key;
+            const label = sanitizeLabel(displayName);
+            const displayLabel = `📄 ${label}`;
+            const style = getNodeStyle(key, false);
+
+            graph += `    ${currentId}["${displayLabel}"]${style}\n`;
+
+            if (parentId) {
+                graph += `    ${parentId} --> ${currentId}\n`;
             }
         });
     }