scaffold-doc-cli 1.0.7 → 1.0.8

package/index.js

@@ -69,25 +69,25 @@ async function init() {
 -->
 # ${answers.projectName} Documentation
 
-## Overview
+## Vue d'ensemble
 <!-- AI_CONTENT_START -->
-Documentation initialized.
+Documentation initialisée.
 <!-- AI_CONTENT_END -->
 
-## Quick Links
-- [Getting Started](./getting-started.md)
+## Liens Rapides
+- [Démarrage](./getting-started.md)
 - [Architecture](./architecture.md)
 `;
     await fs.writeFile(path.join(docsDir, 'index.md'), indexContent);
 
     // getting-started.md
-    const gettingStartedContent = `# Getting Started
+    const gettingStartedContent = `# Démarrage
 
 <!-- 
-  INSTRUCTION: Document the installation and setup steps.
+  INSTRUCTION: Documentez les étapes d'installation et de configuration.
 -->
 
-## Prerequisites
+## Prérequis
 <!-- AI_CONTENT_START -->
 <!-- AI_CONTENT_END -->
 
@@ -137,10 +137,10 @@ docs_dir: .docs
 theme: readthedocs
 
 nav:
-  - Home: index.md
-  - Getting Started: getting-started.md
+  - Accueil: index.md
+  - Démarrage: getting-started.md
   - Architecture: architecture.md
-  - Reference:
+  - Référence:
 ${referenceNav}
 `;
     await fs.writeFile(path.join(process.cwd(), 'mkdocs.yml'), mkdocsContent);
@@ -189,7 +189,8 @@ jobs:
         run: node .github/scripts/doc-sync.mjs
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v5
+        id: cpr
+        uses: peter-evans/create-pull-request@v7
         with:
           token: \${{ secrets.GITHUB_TOKEN }}
           commit-message: "docs: auto-generated documentation updates"
@@ -202,6 +203,12 @@ jobs:
           base: \${{ github.head_ref || github.ref_name }}
           delete-branch: true
           add-paths: .docs
+
+      - name: Check outputs
+        if: \${{ steps.cpr.outputs.pull-request-number }}
+        run: |
+          echo "Pull Request Number - \${{ steps.cpr.outputs.pull-request-number }}"
+          echo "Pull Request URL - \${{ steps.cpr.outputs.pull-request-url }}"
 `;
       await fs.writeFile(path.join(workflowDir, 'ai-doc-sync.yml'), workflowContent);
       console.log(chalk.green('✔ .github/workflows/ai-doc-sync.yml created'));
@@ -217,13 +224,22 @@ const genAI = new GoogleGenAI({ apiKey: process.env.GEMINI_API_KEY });
 async function main() {
   console.log("Starting AI Doc Sync...");
 
+  // 1. Detect Changed Files
   // 1. Detect Changed Files
   let changedFiles = [];
+  let forceRegenerate = false;
+
   try {
-    const output = execSync('git diff --name-only HEAD~1 HEAD 2>/dev/null').toString();
-    changedFiles = output.split('\\n').filter(f => f && !f.startsWith('.docs') && !f.startsWith('.github'));
+    const commitMsg = execSync('git log -1 --pretty=%B').toString();
+    if (commitMsg.includes('regenerate-doc')) {
+      console.log('Trigger "regenerate-doc" détecté. Synchronisation de tous les fichiers...');
+      forceRegenerate = true;
+    }
   } catch (e) {
-    console.warn("HEAD~1 not found (likely first commit). Syncing all tracked files...");
+    // Ignore error
+  }
+
+  if (forceRegenerate) {
     try {
       const output = execSync('git ls-tree -r HEAD --name-only').toString();
       changedFiles = output.split('\\n').filter(f => f && !f.startsWith('.docs') && !f.startsWith('.github'));
@@ -231,6 +247,20 @@ async function main() {
       console.error("Failed to list files:", err.message);
       return;
     }
+  } else {
+    try {
+      const output = execSync('git diff --name-only HEAD~1 HEAD 2>/dev/null').toString();
+      changedFiles = output.split('\\n').filter(f => f && !f.startsWith('.docs') && !f.startsWith('.github'));
+    } catch (e) {
+      console.warn("HEAD~1 not found (likely first commit). Syncing all tracked files...");
+      try {
+        const output = execSync('git ls-tree -r HEAD --name-only').toString();
+        changedFiles = output.split('\\n').filter(f => f && !f.startsWith('.docs') && !f.startsWith('.github'));
+      } catch (err) {
+        console.error("Failed to list files:", err.message);
+        return;
+      }
+    }
   }
 
   if (changedFiles.length === 0) {
@@ -255,17 +285,18 @@ async function main() {
 
 
   const prompt = \`
-    You are a technical documentation assistant. 
-    Analyze the following code changes and update the documentation in the .docs/ directory.
+    Tu es un assistant de documentation technique expert. 
+    Analyse les modifications de code suivantes et mets à jour la documentation dans le dossier .docs/.
     
-    Rules:
-    1. Output MUST be a valid JSON object where keys are file paths (relative to .docs/, e.g., "reference/controllers.md") and values are the NEW content of that file.
-    2. You can create new files if necessary. 
-    3. You can update existing files (e.g., getting-started.md, architecture.md).
-    4. Focus on accuracy and clarity.
-    5. Do not include markdown code fence blocks in your response, just the raw JSON string.
-
-    Code Context:
+    Règles:
+    1. La langue de sortie DOIT être le FRANÇAIS.
+    2. La sortie DOIT être un objet JSON valide où les clés sont les chemins de fichiers (relatifs à .docs/, ex: "reference/controllers.md") et les valeurs sont le NOUVEAU contenu de ce fichier.
+    3. Tu peux créer de nouveaux fichiers si nécessaire. 
+    4. Tu peux mettre à jour les fichiers existants (ex: getting-started.md, architecture.md).
+    5. Concentre-toi sur la précision et la clarté.
+    6. N'inclus PAS de blocs de code markdown dans ta réponse, juste la chaîne JSON brute.
+
+    Contexte du code:
     \${context}
   \`;
 
@@ -327,9 +358,9 @@ function getStackConfig(stack) {
   if (stack.includes('Symfony')) {
     return {
       files: {
-        'controllers.md': () => `${commonHeader('Controllers')}# Controllers\n\n<!-- INSTRUCTION: Document all Symfony Controllers found in /src/Controller -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'entities.md': () => `${commonHeader('Entities')}# Entities\n\n<!-- INSTRUCTION: Document all Doctrine Entities found in /src/Entity -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'services.md': () => `${commonHeader('Services')}# Services\n\n<!-- INSTRUCTION: Document core application services found in /src/Service -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'controllers.md': () => `${commonHeader('Controllers')}# Contrôleurs\n\n<!-- INSTRUCTION: Documentez tous les contrôleurs Symfony trouvés dans /src/Controller -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'entities.md': () => `${commonHeader('Entities')}# Entités\n\n<!-- INSTRUCTION: Documentez toutes les entités Doctrine trouvées dans /src/Entity -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'services.md': () => `${commonHeader('Services')}# Services\n\n<!-- INSTRUCTION: Documentez les services principaux trouvés dans /src/Service -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
       }
     };
   }
@@ -338,9 +369,9 @@ function getStackConfig(stack) {
   if (stack.includes('Laravel')) {
     return {
       files: {
-        'controllers.md': () => `${commonHeader('Controllers')}# Controllers\n\n<!-- INSTRUCTION: Document Http Controllers found in /app/Http/Controllers -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'models.md': () => `${commonHeader('Models')}# Models\n\n<!-- INSTRUCTION: Document Eloquent Models found in /app/Models -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'routes.md': () => `${commonHeader('Routes')}# Routes\n\n<!-- INSTRUCTION: Document application routes found in /routes -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'controllers.md': () => `${commonHeader('Controllers')}# Contrôleurs\n\n<!-- INSTRUCTION: Documentez les contrôleurs Http trouvés dans /app/Http/Controllers -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'models.md': () => `${commonHeader('Models')}# Modèles\n\n<!-- INSTRUCTION: Documentez les modèles Eloquent trouvés dans /app/Models -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'routes.md': () => `${commonHeader('Routes')}# Routes\n\n<!-- INSTRUCTION: Documentez les routes trouvées dans /routes -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
       }
     };
   }
@@ -349,9 +380,9 @@ function getStackConfig(stack) {
   if (stack.includes('Nuxt')) {
     return {
       files: {
-        'components.md': () => `${commonHeader('Components')}# Components\n\n<!-- INSTRUCTION: Document Vue components in /components -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'composables.md': () => `${commonHeader('Composables')}# Composables\n\n<!-- INSTRUCTION: Document auto-imported composables in /composables -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'server-routes.md': () => `${commonHeader('Server Routes')}# Server Routes\n\n<!-- INSTRUCTION: Document Nitro server routes in /server/api -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'components.md': () => `${commonHeader('Components')}# Composants\n\n<!-- INSTRUCTION: Documentez les composants Vue dans /components -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'composables.md': () => `${commonHeader('Composables')}# Composables\n\n<!-- INSTRUCTION: Documentez les composables auto-importés dans /composables -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'server-routes.md': () => `${commonHeader('Server Routes')}# Routes Serveur\n\n<!-- INSTRUCTION: Documentez les routes serveur Nitro dans /server/api -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
       }
     };
   }
@@ -360,9 +391,9 @@ function getStackConfig(stack) {
   if (stack.includes('React') || stack.includes('Next') || stack.includes('Vue') || stack.includes('Angular') || stack.includes('Svelte')) {
     return {
       files: {
-        'components.md': () => `${commonHeader('Components')}# Components\n\n<!-- INSTRUCTION: Document UI components -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'hooks.md': () => `${commonHeader('Hooks')}# Hooks\n\n<!-- INSTRUCTION: Document custom hooks/composables -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'api.md': () => `${commonHeader('API')}# API Integration\n\n<!-- INSTRUCTION: Document API clients or fetch wrappers -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'components.md': () => `${commonHeader('Components')}# Composants\n\n<!-- INSTRUCTION: Documentez les composants UI -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'hooks.md': () => `${commonHeader('Hooks')}# Hooks\n\n<!-- INSTRUCTION: Documentez les hooks personnalisés -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'api.md': () => `${commonHeader('API')}# Intégration API\n\n<!-- INSTRUCTION: Documentez les clients API -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
       }
     };
   }
@@ -371,9 +402,9 @@ function getStackConfig(stack) {
   if (stack.includes('Django')) {
     return {
       files: {
-        'models.md': () => `${commonHeader('Models')}# Models\n\n<!-- INSTRUCTION: Document Django Models -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'views.md': () => `${commonHeader('Views')}# Views\n\n<!-- INSTRUCTION: Document Django Views/ViewSets -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'admin.md': () => `${commonHeader('Admin')}# Admin Customization\n\n<!-- INSTRUCTION: Document Admin classes -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'models.md': () => `${commonHeader('Models')}# Modèles\n\n<!-- INSTRUCTION: Documentez les modèles Django -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'views.md': () => `${commonHeader('Views')}# Vues\n\n<!-- INSTRUCTION: Documentez les Vues/ViewSets Django -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'admin.md': () => `${commonHeader('Admin')}# Administration\n\n<!-- INSTRUCTION: Documentez les classes d'administration -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
       }
     };
   }
@@ -382,8 +413,8 @@ function getStackConfig(stack) {
   if (stack.includes('FastAPI')) {
     return {
       files: {
-        'endpoints.md': () => `${commonHeader('Endpoints')}# Endpoints\n\n<!-- INSTRUCTION: Document FastAPI routes and decorators -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'models.md': () => `${commonHeader('Models')}# Pydantic Models\n\n<!-- INSTRUCTION: Document Pydantic models -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'endpoints.md': () => `${commonHeader('Endpoints')}# Endpoints\n\n<!-- INSTRUCTION: Documentez les routes et décorateurs FastAPI -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'models.md': () => `${commonHeader('Models')}# Modèles Pydantic\n\n<!-- INSTRUCTION: Documentez les modèles Pydantic -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
       }
     };
   }
@@ -392,9 +423,9 @@ function getStackConfig(stack) {
   if (stack.includes('Spring') || stack.includes('Java')) {
     return {
       files: {
-        'controllers.md': () => `${commonHeader('Controllers')}# Controllers\n\n<!-- INSTRUCTION: Document REST Controllers -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'services.md': () => `${commonHeader('Services')}# Services\n\n<!-- INSTRUCTION: Document Service beans -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-        'domain.md': () => `${commonHeader('Domain')}# Domain Models\n\n<!-- INSTRUCTION: Document Entity classes -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'controllers.md': () => `${commonHeader('Controllers')}# Contrôleurs\n\n<!-- INSTRUCTION: Documentez les contrôleurs REST -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'services.md': () => `${commonHeader('Services')}# Services\n\n<!-- INSTRUCTION: Documentez les beans Service -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+        'domain.md': () => `${commonHeader('Domain')}# Modèles de Domaine\n\n<!-- INSTRUCTION: Documentez les classes d'Entité -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
       }
     };
   }
@@ -402,8 +433,8 @@ function getStackConfig(stack) {
   // --- Default Fallback ---
   return {
     files: {
-      'api.md': () => `${commonHeader('API')}# API Reference\n\n<!-- INSTRUCTION: Document public API endpoints -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
-      'modules.md': () => `${commonHeader('Modules')}# Core Modules\n\n<!-- INSTRUCTION: Document core logical modules -->\n\n## List\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+      'api.md': () => `${commonHeader('API')}# Référence API\n\n<!-- INSTRUCTION: Documentez les endpoints API publics -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
+      'modules.md': () => `${commonHeader('Modules')}# Modules principaux\n\n<!-- INSTRUCTION: Documentez les modules logiques principaux -->\n\n## Liste\n<!-- AI_CONTENT_START -->\n<!-- AI_CONTENT_END -->`,
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scaffold-doc-cli",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "CLI tool to scaffold standardized documentation structure for projects.",
   "main": "index.js",
   "type": "module",