shadowdocs 2.1.5 → 2.1.7

package/src/services/ai.ts

@@ -5,7 +5,7 @@ import { DocResult } from '../core/types.js';
 const GROQ_API_URL = 'https://api.groq.com/openai/v1/chat/completions';
 const MODEL = 'llama-3.3-70b-versatile';
 
-const SYSTEM_PROMPT = `You are a senior open-source maintainer and technical documentation expert. Generate detailed, professional READMEs with proper sections, realistic content (no fake features), MIT license, contribution guidelines, and security policy.`;
+const SYSTEM_PROMPT = `You are a senior open-source maintainer and technical documentation expert with 15+ years of experience. You generate comprehensive, production-grade documentation that is practical, accurate, and developer-friendly. NEVER hallucinate features - only document what exists in the codebase.`;
 
 const MAX_RETRIES = 3;
 const BASE_DELAY = 1000;
@@ -61,6 +61,14 @@ async function withRetry<T>(
   throw lastError || new Error('Request failed after retries');
 }
 
+export interface GeneratedDocs {
+  content?: string;
+  readme: string;
+  contributing: string;
+  license: string;
+  security: string;
+}
+
 export async function generateDocs(projectData: Record<string, unknown>, mode: 'generate' | 'improve' | 'explain' = 'generate'): Promise<DocResult> {
   const apiKey = await loadApiKey();
   
@@ -68,124 +76,221 @@ export async function generateDocs(projectData: Record<string, unknown>, mode: '
     throw new Error('API key not configured. Run shadowdocs setup.');
   }
 
-  let userPrompt = '';
-
-  switch (mode) {
-    case 'generate':
-      userPrompt = buildGeneratePrompt(projectData);
-      break;
-    case 'improve':
-      userPrompt = buildImprovePrompt(projectData);
-      break;
-    case 'explain':
-      userPrompt = buildExplainPrompt(projectData);
-      break;
-    default:
-      userPrompt = buildGeneratePrompt(projectData);
-  }
-
-  const response = await withRetry(() => makeRequest(apiKey, userPrompt));
-  
   if (mode === 'explain') {
+    const response = await withRetry(() => makeRequest(apiKey, buildExplainPrompt(projectData)));
     return { type: 'text', content: response };
   }
-  
-  return { type: 'markdown', content: response };
+
+  if (mode === 'generate') {
+    const [readme, contributing, license, security] = await Promise.all([
+      withRetry(() => makeRequest(apiKey, buildReadmePrompt(projectData))),
+      withRetry(() => makeRequest(apiKey, buildContributingPrompt(projectData))),
+      withRetry(() => makeRequest(apiKey, buildLicensePrompt(projectData))),
+      withRetry(() => makeRequest(apiKey, buildSecurityPrompt(projectData)))
+    ]);
+
+    return {
+      type: 'markdown',
+      content: readme,
+      contributing,
+      license,
+      security
+    } as unknown as DocResult;
+  }
+
+  if (mode === 'improve') {
+    const [readme, contributing, license, security] = await Promise.all([
+      withRetry(() => makeRequest(apiKey, buildImproveReadmePrompt(projectData))),
+      withRetry(() => makeRequest(apiKey, buildImproveContributingPrompt(projectData))),
+      withRetry(() => makeRequest(apiKey, buildImproveLicensePrompt(projectData))),
+      withRetry(() => makeRequest(apiKey, buildImproveSecurityPrompt(projectData)))
+    ]);
+
+    return {
+      type: 'markdown',
+      content: readme,
+      contributing,
+      license,
+      security
+    } as unknown as DocResult;
+  }
+
+  throw new Error('Unknown mode');
 }
 
-function buildGeneratePrompt(projectData: Record<string, unknown>): string {
-  return `Generate a detailed, professional README.md for this project with these exact sections:
+function buildReadmePrompt(projectData: Record<string, unknown>): string {
+  return `You are an expert technical writer. Generate a comprehensive, production-ready README.md for this project.
+
+Analyze the project structure and package.json thoroughly. Document ONLY what's actually present in the codebase.
 
-# Project Name
+Requirements:
+1. Overview: What the project does, target audience, primary use case
+2. Features: List ACTUAL features from package.json scripts and dependencies - NO made-up features
+3. Installation: Exact commands for npm/pnpm/yarn
+4. Usage: Real code examples based on actual entry points and exports
+5. API: Document actual functions/endpoints/components found in the code
+6. Configuration: Actual config options if any
+7. Development: Real npm scripts from package.json
+8. Testing: How tests are run (from scripts)
+9. Project Structure: Actual directory layout
+10. Technologies: Real stack based on dependencies
 
-## Overview
-2-3 sentences about what this project does and its purpose.
+IMPORTANT: Use the project data provided and INFER realistic content. Don't leave placeholder text.
 
-## Version
-Current version: X.X.X
+Project Data:
+${JSON.stringify(projectData, null, 2)}
 
-## Description
-Detailed description of what this project does, who it's for, and why to use it.
+Return ONLY complete README.md markdown.`;
+}
 
-## Features
-- List real features (infer from package.json scripts and dependencies)
-- Do NOT add fake features
+function buildContributingPrompt(projectData: Record<string, unknown>): string {
+  return `Generate a professional CONTRIBUTING.md for this project.
 
-## Installation
-Provide the exact npm/pnpm/yarn install command.
+Requirements:
+1. How to contribute (fork, clone, branch workflow)
+2. Development setup steps
+3. Code style guidelines (linting, formatting)
+4. Commit message conventions
+5. PR process and requirements
+6. Testing requirements
+7. Types of contributions welcome
+8. Issue templates or guidelines
+9. Recognition for contributors
+10. Code of conduct reference
 
-## Usage
-Show actual usage examples with code snippets.
+Base it on the project's package.json scripts and known best practices.
 
-## API Reference
-If backend: document endpoints
-If frontend: document components/hooks
-If library: document exports/functions
+Project Data:
+${JSON.stringify(projectData, null, 2)}
 
-## Configuration
-Any config options available.
+Return ONLY complete CONTRIBUTING.md markdown.`;
+}
 
-## Development
-How to set up dev environment:
-npm install
-npm run [script] - description
+function buildLicensePrompt(projectData: Record<string, unknown>): string {
+  return `Generate a complete LICENSE file. Use MIT License as default. Include:
 
-## Testing
-How to run tests.
+1. Full MIT License text
+2. Copyright year (current year: ${new Date().getFullYear()})
+3. Project name: ${projectData.name || 'Project'}
+4. Author name if available in package.json
 
-## License
-MIT License - include full license text
+Project Data:
+${JSON.stringify(projectData, null, 2)}
 
-## Contributing
-Contribution Guidelines:
-- Fork and create feature branch
-- Follow existing code style
-- Add tests if applicable
-- Submit PR
+Return ONLY complete LICENSE file content (plain text, not markdown).`;
+}
 
-## Security Policy
-How to report vulnerabilities.
+function buildSecurityPrompt(projectData: Record<string, unknown>): string {
+  return `Generate a professional SECURITY.md for this project.
 
-## Code of Conduct
-Be respectful, inclusive, no harassment. violations will result in immediate suspension.
+Requirements:
+1. How to report vulnerabilities
+2. Security policy scope
+3. Response timeline
+4. Disclosure guidelines
+5. Security update process
+6. Contact information
+7. Dependencies security info if applicable
 
 Project Data:
 ${JSON.stringify(projectData, null, 2)}
 
-Return ONLY complete markdown.`;
+Return ONLY complete SECURITY.md markdown.`;
 }
 
-function buildImprovePrompt(projectData: Record<string, unknown>): string {
+function buildImproveReadmePrompt(projectData: Record<string, unknown>): string {
   return `Improve the existing README.md for this project.
 
-Current README:
-${projectData.existingReadme}
+Requirements:
+1. Fix unclear sections
+2. Add missing important sections
+3. Improve code examples to be more practical
+4. Make installation more clear
+5. Enhance usage examples with real code
+6. Add API documentation if missing
+7. Improve structure and readability
+8. Keep existing good content
+9. Add project structure visualization if missing
+
+EXISTING README:
+${projectData.existingReadme || 'No existing README'}
+
+Project Data:
+${JSON.stringify(projectData, null, 2)}
+
+Return ONLY improved README.md markdown.`;
+}
+
+function buildImproveContributingPrompt(projectData: Record<string, unknown>): string {
+  return `Improve the existing CONTRIBUTING.md for this project.
+
+Requirements:
+1. Make contribution process clearer
+2. Add missing guidelines
+3. Improve development setup instructions
+4. Add testing requirements
+5. Update for current project state
+
+EXISTING CONTRIBUTING:
+${projectData.existingContributing || 'No existing CONTRIBUTING.md'}
+
+Project Data:
+${JSON.stringify(projectData, null, 2)}
+
+Return ONLY improved CONTRIBUTING.md markdown.`;
+}
+
+function buildImproveLicensePrompt(projectData: Record<string, unknown>): string {
+  return `Review and improve the LICENSE if needed.
+
+Requirements:
+1. Ensure correct copyright year
+2. Verify project name is correct
+3. Add any missing clauses
+
+EXISTING LICENSE:
+${projectData.existingLicense || 'No existing LICENSE'}
 
 Project Data:
 ${JSON.stringify(projectData, null, 2)}
 
-Rules:
-- Keep improvements practical and factual
-- Do NOT add hallucinated features
-- Maintain existing structure
-- Make it more useful for developers
+Return ONLY complete LICENSE file content.`;
+}
+
+function buildImproveSecurityPrompt(projectData: Record<string, unknown>): string {
+  return `Improve the existing SECURITY.md for this project.
+
+Requirements:
+1. Make reporting process clearer
+2. Add missing security information
+3. Update contact info if needed
+4. Improve response timeline clarity
+
+EXISTING SECURITY:
+${projectData.existingSecurity || 'No existing SECURITY.md'}
 
-Return ONLY the improved markdown.`;
+Project Data:
+${JSON.stringify(projectData, null, 2)}
+
+Return ONLY improved SECURITY.md markdown.`;
 }
 
 function buildExplainPrompt(projectData: Record<string, unknown>): string {
-  return `Explain this project in simple terms for developers.
+  return `Explain this project in simple, practical terms for developers.
+
+Requirements:
+1. What the project does (one sentence)
+2. Who it's for
+3. Main features (top 3-5)
+4. How to use it (quick start)
+5. Why someone would use it
+6. Tech stack briefly
+
+Be conversational but professional. No markdown.
 
 Project Data:
 ${JSON.stringify(projectData, null, 2)}
 
-Rules:
-- Be concise
-- Explain what the project does
-- Explain how to use it
-- Mention key features
-- Keep it conversational
-
 Return as plain text explanation.`;
 }
 
@@ -198,7 +303,7 @@ async function makeRequest(apiKey: string, userPrompt: string): Promise<string>
         { role: 'system', content: SYSTEM_PROMPT },
         { role: 'user', content: userPrompt }
       ],
-      temperature: 0.7,
+      temperature: 0.5,
       max_tokens: 8192
     },
     {

package/src/ui/components/Generator.tsx

@@ -2,7 +2,7 @@ import React, { useState, useEffect } from 'react';
 import { Box, Text, useInput } from 'ink';
 import ora from 'ora';
 import { loadApiKey } from '../../core/config.js';
-import { generateDocs } from '../../services/ai.js';
+import { generateDocs, GeneratedDocs } from '../../services/ai.js';
 import { analyzeProject, summarizeProject } from '../../services/analyzer.js';
 import fs from 'fs/promises';
 import path from 'path';
@@ -13,8 +13,8 @@ interface GeneratorProps {
 }
 
 const titles = {
-	generate: 'Generate README',
-	improve: 'Improve README',
+	generate: 'Generate Documentation',
+	improve: 'Improve Documentation',
 	explain: 'Explain Project',
 };
 
@@ -64,16 +64,34 @@ export default function Generator({ mode, onBack }: GeneratorProps) {
 			setStatus('generating');
 			spinner.text = 'Generating documentation...';
 
-			const docResult = await generateDocs(summary as unknown as Record<string, unknown>, mode);
+			const docResult = await generateDocs(summary as unknown as Record<string, unknown>, mode) as unknown as GeneratedDocs;
 
-			if (mode === 'generate') {
-				const readmePath = path.join(projectPath, 'README.md');
-				await fs.writeFile(readmePath, docResult.content);
-				setResult('README.md created successfully!');
+			if (mode === 'generate' || mode === 'improve') {
+				const files: string[] = [];
+
+				if (docResult.content) {
+					await fs.writeFile(path.join(projectPath, 'README.md'), docResult.content);
+					files.push('README.md');
+				}
+
+				if (docResult.contributing) {
+					await fs.writeFile(path.join(projectPath, 'CONTRIBUTING.md'), docResult.contributing);
+					files.push('CONTRIBUTING.md');
+				}
+
+				if (docResult.license) {
+					await fs.writeFile(path.join(projectPath, 'LICENSE'), docResult.license);
+					files.push('LICENSE');
+				}
+
+				if (docResult.security) {
+					await fs.writeFile(path.join(projectPath, 'SECURITY.md'), docResult.security);
+					files.push('SECURITY.md');
+				}
+
+				setResult(`${files.join(', ')} ${files.length === 1 ? 'created' : 'created'} successfully!`);
 			} else if (mode === 'explain') {
-				setResult(docResult.content);
-			} else {
-				setResult('Documentation improved!');
+				setResult(docResult.content as string);
 			}
 
 			spinner.succeed('Done!');
@@ -94,7 +112,7 @@ export default function Generator({ mode, onBack }: GeneratorProps) {
 			{status === 'checking' && <Text>Checking API key...</Text>}
 			{status === 'scanning' && <Text>Scanning project...</Text>}
 			{status === 'analyzing' && <Text>Analyzing project...</Text>}
-			{status === 'generating' && <Text>Generating documentation...</Text>}
+			{status === 'generating' && <Text>Generating documentation (README, CONTRIBUTING, LICENSE, SECURITY)...</Text>}
 
 			{status === 'done' && (
 				<>

package/src/ui/components/Menu.tsx

@@ -12,8 +12,8 @@ interface MenuProps {
 }
 
 const menuItems: MenuItem[] = [
-	{ key: 'g', label: 'Generate README', desc: 'Create new documentation' },
-	{ key: 'i', label: 'Improve README', desc: 'Enhance existing docs' },
+	{ key: 'g', label: 'Generate Docs', desc: 'Create README, CONTRIBUTING, LICENSE, SECURITY' },
+	{ key: 'i', label: 'Improve Docs', desc: 'Enhance existing documentation' },
 	{ key: 'e', label: 'Explain Project', desc: 'Terminal explanation' },
 	{ key: 's', label: 'Settings', desc: 'Configure API key' },
 	{ key: 'h', label: 'Help', desc: 'Usage guide' },
@@ -41,14 +41,9 @@ export default function Menu({ onSelect }: MenuProps) {
 	return (
 		<Box flexDirection="column" padding={1}>
 			<Text bold color="cyan">
-				
-  ██████╗ ██████╗ ██████╗ ██╗   ██╗██╗     ███████╗███████╗
- ██╔════╝ ██╔══██╗██╔══██╗██║   ██║██║     ██╔════╝██╔════╝
- ██║  ███╗██████╔╝██████╔╝██║   ██║██║     █████╗  ███████╗
- ██║   ██║██╔══██╗██╔══██╗██║   ██║██║     ██╔══╝  ╚════██║
- ╚██████╔╝██║  ██║██║  ██║╚██████╔╝███████╗███████╗███████║
-  ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝ ╚══════╝╚══════╝╚══════╝
- 
+  .-.   . .   .-.   .-.   .-.   . . .   .-.   .-.   .-. .-. 
+`-.   |-|   |-|   |  )  | |   | | |   |  )  | |   |   `-. 
+`-'   ' `   ` '   `-'   `-'   `.'.'   `-'   `-'   `-' `-'   
 			</Text>
 
 			<Text dimColor>AI-Powered Documentation Generator</Text>
@@ -75,7 +70,7 @@ export default function Menu({ onSelect }: MenuProps) {
 
 			<Text>{"\n"}</Text>
 			<Text dimColor>Use w/s or arrow keys to navigate, Enter or key to select, q to quit</Text>
-			<Text dimColor>Version 2.1.4</Text>
+			<Text dimColor>Version 2.1.6</Text>
 		</Box>
 	);
 }