react-code-smell-detector 1.4.2 → 1.5.1

package/dist/docGenerator.js

@@ -0,0 +1,306 @@
+import path from 'path';
+import fs from 'fs/promises';
+/**
+ * Generate documentation from component analysis
+ */
+export async function generateComponentDocs(result, rootDir, options = { format: 'markdown' }) {
+    const docs = extractComponentDocs(result, rootDir);
+    switch (options.format) {
+        case 'html':
+            return generateHTMLDocs(docs, result, options);
+        case 'json':
+            return JSON.stringify(docs, null, 2);
+        case 'markdown':
+        default:
+            return generateMarkdownDocs(docs, result, options);
+    }
+}
+/**
+ * Extract documentation data from analysis
+ */
+function extractComponentDocs(result, rootDir) {
+    const docs = [];
+    for (const file of result.files) {
+        for (const component of file.components) {
+            const relativePath = file.file.replace(rootDir, '').replace(/^\//, '');
+            const componentSmells = file.smells.filter(s => s.line >= component.startLine && s.line <= component.endLine);
+            // Determine complexity rating
+            const complexity = getComplexityRating(component);
+            const maintainability = getMaintainabilityRating(componentSmells.length, component.lineCount);
+            docs.push({
+                name: component.name,
+                file: file.file,
+                relativePath,
+                lineCount: component.lineCount,
+                props: [], // Would need parser enhancement to get prop names
+                hooks: {
+                    useState: component.useStateCount,
+                    useEffect: component.useEffectCount,
+                    useMemo: component.useMemoCount,
+                    useCallback: component.useCallbackCount,
+                    useRef: 0, // Would need parser enhancement
+                    custom: [],
+                },
+                smells: componentSmells,
+                metrics: {
+                    complexity,
+                    maintainability,
+                },
+            });
+        }
+    }
+    return docs.sort((a, b) => a.name.localeCompare(b.name));
+}
+/**
+ * Generate Markdown documentation
+ */
+function generateMarkdownDocs(docs, result, options) {
+    let md = '# Component Documentation\n\n';
+    md += `*Generated by react-code-smell-detector*\n\n`;
+    md += `---\n\n`;
+    // Summary
+    md += '## Summary\n\n';
+    md += `| Metric | Value |\n`;
+    md += `|--------|-------|\n`;
+    md += `| Total Components | ${docs.length} |\n`;
+    md += `| Total Files | ${result.summary.totalFiles} |\n`;
+    md += `| Technical Debt Grade | ${result.debtScore.grade} |\n`;
+    md += `| Estimated Refactor Time | ${result.debtScore.estimatedRefactorTime} |\n\n`;
+    // Table of contents
+    md += '## Components\n\n';
+    if (options.groupByFolder) {
+        const grouped = groupByFolder(docs);
+        for (const [folder, folderDocs] of Object.entries(grouped)) {
+            md += `### 📁 ${folder || 'Root'}\n\n`;
+            for (const doc of folderDocs) {
+                md += formatComponentMarkdown(doc, options);
+            }
+        }
+    }
+    else {
+        for (const doc of docs) {
+            md += formatComponentMarkdown(doc, options);
+        }
+    }
+    // Index
+    md += '\n---\n\n';
+    md += '## Index\n\n';
+    md += '| Component | File | Lines | Hooks | Issues |\n';
+    md += '|-----------|------|-------|-------|--------|\n';
+    for (const doc of docs) {
+        const totalHooks = doc.hooks.useState + doc.hooks.useEffect + doc.hooks.useMemo + doc.hooks.useCallback;
+        md += `| [${doc.name}](#${doc.name.toLowerCase()}) | \`${doc.relativePath}\` | ${doc.lineCount} | ${totalHooks} | ${doc.smells.length} |\n`;
+    }
+    return md;
+}
+/**
+ * Format a single component as Markdown
+ */
+function formatComponentMarkdown(doc, options) {
+    let md = `#### ${doc.name}\n\n`;
+    md += `📄 \`${doc.relativePath}\`\n\n`;
+    // Metrics table
+    if (options.includeMetrics !== false) {
+        md += `| Metric | Value |\n`;
+        md += `|--------|-------|\n`;
+        md += `| Lines | ${doc.lineCount} |\n`;
+        md += `| Complexity | ${doc.metrics.complexity} |\n`;
+        md += `| Maintainability | ${doc.metrics.maintainability} |\n`;
+    }
+    // Hooks
+    const hooks = [];
+    if (doc.hooks.useState > 0)
+        hooks.push(`useState (${doc.hooks.useState})`);
+    if (doc.hooks.useEffect > 0)
+        hooks.push(`useEffect (${doc.hooks.useEffect})`);
+    if (doc.hooks.useMemo > 0)
+        hooks.push(`useMemo (${doc.hooks.useMemo})`);
+    if (doc.hooks.useCallback > 0)
+        hooks.push(`useCallback (${doc.hooks.useCallback})`);
+    if (hooks.length > 0) {
+        md += `\n**Hooks:** ${hooks.join(', ')}\n`;
+    }
+    // Issues
+    if (options.includeSmells !== false && doc.smells.length > 0) {
+        md += `\n**Issues (${doc.smells.length}):**\n`;
+        for (const smell of doc.smells.slice(0, 5)) {
+            const emoji = smell.severity === 'error' ? '🔴' : smell.severity === 'warning' ? '🟡' : '🔵';
+            md += `- ${emoji} ${smell.type}: ${smell.message}\n`;
+        }
+        if (doc.smells.length > 5) {
+            md += `- *... and ${doc.smells.length - 5} more*\n`;
+        }
+    }
+    md += '\n---\n\n';
+    return md;
+}
+/**
+ * Generate HTML documentation
+ */
+function generateHTMLDocs(docs, result, options) {
+    return `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>Component Documentation</title>
+  <style>
+    * { box-sizing: border-box; margin: 0; padding: 0; }
+    body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; line-height: 1.6; color: #333; background: #f5f5f5; }
+    .container { max-width: 1200px; margin: 0 auto; padding: 20px; }
+    header { background: linear-gradient(135deg, #667eea 0%, #764ba2 100%); color: white; padding: 40px 20px; margin-bottom: 30px; border-radius: 10px; }
+    h1 { font-size: 2.5rem; margin-bottom: 10px; }
+    .subtitle { opacity: 0.9; }
+    .summary { display: grid; grid-template-columns: repeat(auto-fit, minmax(200px, 1fr)); gap: 20px; margin-bottom: 30px; }
+    .summary-card { background: white; padding: 20px; border-radius: 8px; box-shadow: 0 2px 4px rgba(0,0,0,0.1); text-align: center; }
+    .summary-value { font-size: 2rem; font-weight: bold; color: #667eea; }
+    .summary-label { color: #666; font-size: 0.9rem; }
+    .components { display: grid; gap: 20px; }
+    .component-card { background: white; padding: 20px; border-radius: 8px; box-shadow: 0 2px 4px rgba(0,0,0,0.1); }
+    .component-name { font-size: 1.3rem; color: #333; margin-bottom: 5px; }
+    .component-path { color: #666; font-size: 0.85rem; font-family: monospace; background: #f0f0f0; padding: 2px 8px; border-radius: 4px; }
+    .metrics { display: flex; gap: 15px; margin: 15px 0; flex-wrap: wrap; }
+    .metric { background: #f0f0f0; padding: 5px 12px; border-radius: 20px; font-size: 0.85rem; }
+    .hooks { display: flex; gap: 10px; flex-wrap: wrap; margin: 10px 0; }
+    .hook { background: #e3f2fd; color: #1976d2; padding: 4px 10px; border-radius: 4px; font-size: 0.8rem; }
+    .issues { margin-top: 15px; }
+    .issue { padding: 8px; margin: 5px 0; border-radius: 4px; font-size: 0.9rem; }
+    .issue.error { background: #ffebee; color: #c62828; }
+    .issue.warning { background: #fff3e0; color: #ef6c00; }
+    .issue.info { background: #e3f2fd; color: #1565c0; }
+    .search { margin-bottom: 20px; }
+    .search input { width: 100%; padding: 12px; border: 1px solid #ddd; border-radius: 8px; font-size: 1rem; }
+    .grade { font-size: 3rem; }
+    footer { text-align: center; padding: 20px; color: #666; font-size: 0.85rem; }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <header>
+      <h1>📚 Component Documentation</h1>
+      <p class="subtitle">Generated by react-code-smell-detector</p>
+    </header>
+    
+    <div class="summary">
+      <div class="summary-card">
+        <div class="summary-value">${docs.length}</div>
+        <div class="summary-label">Components</div>
+      </div>
+      <div class="summary-card">
+        <div class="summary-value">${result.summary.totalFiles}</div>
+        <div class="summary-label">Files</div>
+      </div>
+      <div class="summary-card">
+        <div class="summary-value grade">${result.debtScore.grade}</div>
+        <div class="summary-label">Debt Grade</div>
+      </div>
+      <div class="summary-card">
+        <div class="summary-value">${result.debtScore.score}</div>
+        <div class="summary-label">Score</div>
+      </div>
+    </div>
+    
+    <div class="search">
+      <input type="text" placeholder="Search components..." id="search" onkeyup="filterComponents()">
+    </div>
+    
+    <div class="components" id="components">
+      ${docs.map(doc => `
+        <div class="component-card" data-name="${doc.name.toLowerCase()}">
+          <div class="component-name">${doc.name}</div>
+          <span class="component-path">${doc.relativePath}</span>
+          
+          <div class="metrics">
+            <span class="metric">📏 ${doc.lineCount} lines</span>
+            <span class="metric">⚡ ${doc.metrics.complexity}</span>
+            <span class="metric">🔧 ${doc.metrics.maintainability}</span>
+          </div>
+          
+          <div class="hooks">
+            ${doc.hooks.useState > 0 ? `<span class="hook">useState ×${doc.hooks.useState}</span>` : ''}
+            ${doc.hooks.useEffect > 0 ? `<span class="hook">useEffect ×${doc.hooks.useEffect}</span>` : ''}
+            ${doc.hooks.useMemo > 0 ? `<span class="hook">useMemo ×${doc.hooks.useMemo}</span>` : ''}
+            ${doc.hooks.useCallback > 0 ? `<span class="hook">useCallback ×${doc.hooks.useCallback}</span>` : ''}
+          </div>
+          
+          ${doc.smells.length > 0 ? `
+            <div class="issues">
+              ${doc.smells.slice(0, 3).map(s => `
+                <div class="issue ${s.severity}">${s.type}: ${s.message}</div>
+              `).join('')}
+              ${doc.smells.length > 3 ? `<div class="issue info">... and ${doc.smells.length - 3} more</div>` : ''}
+            </div>
+          ` : ''}
+        </div>
+      `).join('')}
+    </div>
+    
+    <footer>
+      Generated by <a href="https://github.com/vsthakur101/react-code-smell-detector">react-code-smell-detector</a>
+    </footer>
+  </div>
+  
+  <script>
+    function filterComponents() {
+      const query = document.getElementById('search').value.toLowerCase();
+      const cards = document.querySelectorAll('.component-card');
+      cards.forEach(card => {
+        const name = card.dataset.name;
+        card.style.display = name.includes(query) ? 'block' : 'none';
+      });
+    }
+  </script>
+</body>
+</html>`;
+}
+/**
+ * Group components by folder
+ */
+function groupByFolder(docs) {
+    const grouped = {};
+    for (const doc of docs) {
+        const parts = doc.relativePath.split('/');
+        const folder = parts.length > 1 ? parts.slice(0, -1).join('/') : '';
+        if (!grouped[folder]) {
+            grouped[folder] = [];
+        }
+        grouped[folder].push(doc);
+    }
+    return grouped;
+}
+/**
+ * Get complexity rating based on component metrics
+ */
+function getComplexityRating(component) {
+    const hookCount = component.useEffectCount + component.useStateCount +
+        component.useMemoCount + component.useCallbackCount;
+    if (component.lineCount > 300 || hookCount > 10)
+        return '🔴 High';
+    if (component.lineCount > 150 || hookCount > 5)
+        return '🟡 Medium';
+    return '🟢 Low';
+}
+/**
+ * Get maintainability rating based on smells and size
+ */
+function getMaintainabilityRating(smellCount, lineCount) {
+    const ratio = smellCount / Math.max(lineCount / 50, 1);
+    if (ratio > 2 || smellCount > 5)
+        return '🔴 Poor';
+    if (ratio > 1 || smellCount > 2)
+        return '🟡 Fair';
+    return '🟢 Good';
+}
+/**
+ * Write documentation to file
+ */
+export async function writeComponentDocs(result, rootDir, options) {
+    const content = await generateComponentDocs(result, rootDir, options);
+    const ext = options.format === 'html' ? 'html' : options.format === 'json' ? 'json' : 'md';
+    const filename = `COMPONENTS.${ext}`;
+    const outputPath = options.outputDir
+        ? path.join(options.outputDir, filename)
+        : path.join(rootDir, filename);
+    await fs.writeFile(outputPath, content, 'utf-8');
+    return outputPath;
+}

package/dist/guide.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Interactive guide for React Code Smell Detector
+ */
+export declare function runGuide(): Promise<void>;
+/**
+ * Create a demo project with examples of all detectable smells
+ */
+export declare function createDemoProject(targetDir: string): Promise<void>;
+//# sourceMappingURL=guide.d.ts.map

package/dist/guide.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guide.d.ts","sourceRoot":"","sources":["../src/guide.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,wBAAsB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAmF9C;AAmWD;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAiFxE"}