react-code-smell-detector 1.0.0 → 1.1.1

package/src/detectors/magicValues.ts

@@ -0,0 +1,114 @@
+import * as t from '@babel/types';
+import { ParsedComponent, getCodeSnippet } from '../parser/index.js';
+import { CodeSmell, DetectorConfig, DEFAULT_CONFIG } from '../types/index.js';
+
+/**
+ * Detects magic numbers and strings that should be constants
+ */
+export function detectMagicValues(
+  component: ParsedComponent,
+  filePath: string,
+  sourceCode: string,
+  config: DetectorConfig = DEFAULT_CONFIG
+): CodeSmell[] {
+  if (!config.checkMagicValues) return [];
+
+  const smells: CodeSmell[] = [];
+  const threshold = config.magicNumberThreshold;
+
+  // Track locations to avoid duplicate reports
+  const reportedLines = new Set<number>();
+
+  component.path.traverse({
+    NumericLiteral(path) {
+      const value = path.node.value;
+      const loc = path.node.loc;
+      const line = loc?.start.line || 0;
+
+      // Skip common acceptable values
+      if (value === 0 || value === 1 || value === -1 || value === 2 || value === 100) return;
+      
+      // Skip array indices and small numbers
+      if (value < threshold && value > -threshold) return;
+
+      // Skip if inside an object key position (e.g., style objects)
+      if (t.isObjectProperty(path.parent) && path.parent.key === path.node) return;
+
+      // Skip if it's a port number or similar config
+      if (value === 3000 || value === 8080 || value === 80 || value === 443) return;
+
+      // Skip if already reported this line
+      if (reportedLines.has(line)) return;
+      reportedLines.add(line);
+
+      // Check context - skip if it's in a variable declaration that names the constant
+      if (t.isVariableDeclarator(path.parent)) {
+        const varName = t.isIdentifier(path.parent.id) ? path.parent.id.name : '';
+        // If variable name is UPPER_CASE, it's already a constant
+        if (varName === varName.toUpperCase() && varName.includes('_')) return;
+      }
+
+      smells.push({
+        type: 'magic-value',
+        severity: 'info',
+        message: `Magic number ${value} in "${component.name}"`,
+        file: filePath,
+        line,
+        column: loc?.start.column || 0,
+        suggestion: `Extract to a named constant: const DESCRIPTIVE_NAME = ${value}`,
+        codeSnippet: getCodeSnippet(sourceCode, line),
+      });
+    },
+
+    StringLiteral(path) {
+      const value = path.node.value;
+      const loc = path.node.loc;
+      const line = loc?.start.line || 0;
+
+      // Skip short strings, empty strings, common values
+      if (value.length < 10) return;
+      
+      // Skip if it looks like a URL, path, or import
+      if (value.startsWith('http') || value.startsWith('/') || value.startsWith('.')) return;
+      
+      // Skip if it's an import source
+      if (t.isImportDeclaration(path.parent)) return;
+      
+      // Skip JSX text content (usually intentional)
+      if (t.isJSXText(path.parent) || t.isJSXExpressionContainer(path.parent)) return;
+      
+      // Skip object property keys
+      if (t.isObjectProperty(path.parent) && path.parent.key === path.node) return;
+
+      // Skip if already reported this line
+      if (reportedLines.has(line)) return;
+
+      // Skip common patterns
+      if (
+        value.includes('className') ||
+        value.includes('px') ||
+        value.includes('rem') ||
+        value.includes('%')
+      ) return;
+
+      // Check if it looks like a user-facing message or error
+      const looksLikeMessage = /^[A-Z][a-z]+.*[.!?]?$/.test(value) || value.includes(' ');
+      
+      if (looksLikeMessage && value.length > 30) {
+        reportedLines.add(line);
+        smells.push({
+          type: 'magic-value',
+          severity: 'info',
+          message: `Hardcoded string in "${component.name}" should be in constants or i18n`,
+          file: filePath,
+          line,
+          column: loc?.start.column || 0,
+          suggestion: `Extract to a constants file or use i18n: "${value.substring(0, 30)}..."`,
+          codeSnippet: getCodeSnippet(sourceCode, line),
+        });
+      }
+    },
+  });
+
+  return smells;
+}

package/src/detectors/missingKey.ts

@@ -0,0 +1,105 @@
+import * as t from '@babel/types';
+import { ParsedComponent, getCodeSnippet } from '../parser/index.js';
+import { CodeSmell, DetectorConfig, DEFAULT_CONFIG } from '../types/index.js';
+
+/**
+ * Detects .map() calls that render JSX without a key prop
+ */
+export function detectMissingKeys(
+  component: ParsedComponent,
+  filePath: string,
+  sourceCode: string,
+  config: DetectorConfig = DEFAULT_CONFIG
+): CodeSmell[] {
+  if (!config.checkMissingKeys) return [];
+
+  const smells: CodeSmell[] = [];
+
+  component.path.traverse({
+    CallExpression(path) {
+      // Check if it's a .map() call
+      if (!t.isMemberExpression(path.node.callee)) return;
+      
+      const prop = path.node.callee.property;
+      if (!t.isIdentifier(prop) || prop.name !== 'map') return;
+
+      // Check if the callback returns JSX
+      const callback = path.node.arguments[0];
+      if (!callback) return;
+
+      let callbackBody: t.Node | null = null;
+      
+      if (t.isArrowFunctionExpression(callback)) {
+        callbackBody = callback.body;
+      } else if (t.isFunctionExpression(callback)) {
+        callbackBody = callback.body;
+      }
+
+      if (!callbackBody) return;
+
+      // Find JSX elements in the callback
+      let hasJSX = false;
+      let hasKey = false;
+      let jsxLine = path.node.loc?.start.line || 0;
+
+      const checkForKey = (node: t.Node) => {
+        if (t.isJSXElement(node)) {
+          hasJSX = true;
+          jsxLine = node.loc?.start.line || jsxLine;
+          
+          // Check if the opening element has a key prop
+          const openingElement = node.openingElement;
+          const keyAttr = openingElement.attributes.find(attr => {
+            if (t.isJSXAttribute(attr)) {
+              return t.isJSXIdentifier(attr.name) && attr.name.name === 'key';
+            }
+            return false;
+          });
+          
+          if (keyAttr) {
+            hasKey = true;
+          }
+        } else if (t.isJSXFragment(node)) {
+          hasJSX = true;
+          // Fragments can't have keys directly, so check children
+        }
+      };
+
+      // Traverse the callback body to find JSX
+      if (t.isJSXElement(callbackBody) || t.isJSXFragment(callbackBody)) {
+        checkForKey(callbackBody);
+      } else if (t.isBlockStatement(callbackBody)) {
+        path.traverse({
+          ReturnStatement(returnPath) {
+            if (returnPath.node.argument) {
+              checkForKey(returnPath.node.argument);
+            }
+          },
+          JSXElement(jsxPath) {
+            // Only check top-level JSX in the map callback
+            if (jsxPath.parent === callbackBody || 
+                (t.isReturnStatement(jsxPath.parent) && jsxPath.parent.argument === jsxPath.node)) {
+              checkForKey(jsxPath.node);
+            }
+          },
+        });
+      }
+
+      if (hasJSX && !hasKey) {
+        const loc = path.node.loc;
+        smells.push({
+          type: 'missing-key',
+          severity: 'error',
+          message: `Missing "key" prop in .map() that renders JSX in "${component.name}"`,
+          file: filePath,
+          line: jsxLine || loc?.start.line || 0,
+          column: loc?.start.column || 0,
+          suggestion: 'Add a unique "key" prop to the root element: <Element key={item.id}>',
+          codeSnippet: getCodeSnippet(sourceCode, loc?.start.line || 0),
+        });
+      }
+    },
+  });
+
+  return smells;
+}

package/src/detectors/nestedTernary.ts

@@ -0,0 +1,75 @@
+import * as t from '@babel/types';
+import { NodePath } from '@babel/traverse';
+import { ParsedComponent, getCodeSnippet } from '../parser/index.js';
+import { CodeSmell, DetectorConfig, DEFAULT_CONFIG } from '../types/index.js';
+
+/**
+ * Detects deeply nested ternary expressions (complex conditional rendering)
+ */
+export function detectNestedTernaries(
+  component: ParsedComponent,
+  filePath: string,
+  sourceCode: string,
+  config: DetectorConfig = DEFAULT_CONFIG
+): CodeSmell[] {
+  const smells: CodeSmell[] = [];
+  const maxDepth = config.maxTernaryDepth;
+
+  component.path.traverse({
+    ConditionalExpression(path) {
+      // Only check the outermost ternary
+      if (isNestedInTernary(path)) return;
+
+      const depth = getTernaryDepth(path.node);
+      
+      if (depth > maxDepth) {
+        const loc = path.node.loc;
+        smells.push({
+          type: 'nested-ternary',
+          severity: depth > maxDepth + 1 ? 'warning' : 'info',
+          message: `Nested ternary expression (depth: ${depth}) in "${component.name}"`,
+          file: filePath,
+          line: loc?.start.line || 0,
+          column: loc?.start.column || 0,
+          suggestion: `Refactor to use if/else, switch, or extract into separate components. Max recommended depth: ${maxDepth}`,
+          codeSnippet: getCodeSnippet(sourceCode, loc?.start.line || 0),
+        });
+      }
+    },
+  });
+
+  return smells;
+}
+
+/**
+ * Check if a ternary is nested inside another ternary
+ */
+function isNestedInTernary(path: NodePath): boolean {
+  let current: NodePath | null = path.parentPath;
+  
+  while (current) {
+    if (t.isConditionalExpression(current.node)) {
+      return true;
+    }
+    current = current.parentPath;
+  }
+  
+  return false;
+}
+
+/**
+ * Calculate the depth of nested ternary expressions
+ */
+function getTernaryDepth(node: t.ConditionalExpression): number {
+  let maxChildDepth = 0;
+
+  if (t.isConditionalExpression(node.consequent)) {
+    maxChildDepth = Math.max(maxChildDepth, getTernaryDepth(node.consequent));
+  }
+
+  if (t.isConditionalExpression(node.alternate)) {
+    maxChildDepth = Math.max(maxChildDepth, getTernaryDepth(node.alternate));
+  }
+
+  return 1 + maxChildDepth;
+}

package/src/detectors/nextjs.ts

@@ -0,0 +1,124 @@
+import * as t from '@babel/types';
+import { ParsedComponent, getCodeSnippet } from '../parser/index.js';
+import { CodeSmell, DetectorConfig, DEFAULT_CONFIG } from '../types/index.js';
+
+/**
+ * Detects Next.js-specific code smells:
+ * - Missing 'use client' / 'use server' directives
+ * - Unoptimized images (using <img> instead of next/image)
+ * - Router misuse patterns
+ * - Missing metadata exports
+ */
+export function detectNextjsIssues(
+  component: ParsedComponent,
+  filePath: string,
+  sourceCode: string,
+  config: DetectorConfig = DEFAULT_CONFIG,
+  imports: string[] = []
+): CodeSmell[] {
+  if (!config.checkNextjs) return [];
+  
+  // Only run on Next.js projects (check for next imports)
+  const isNextProject = imports.some(imp => 
+    imp.includes('next/') || imp.includes('next')
+  );
+  
+  // Also check file path patterns
+  const isAppRouter = filePath.includes('/app/') && 
+    (filePath.endsWith('page.tsx') || filePath.endsWith('page.jsx') ||
+     filePath.endsWith('layout.tsx') || filePath.endsWith('layout.jsx'));
+
+  const smells: CodeSmell[] = [];
+
+  // Check for unoptimized images (using <img> instead of next/image)
+  component.path.traverse({
+    JSXOpeningElement(path) {
+      if (t.isJSXIdentifier(path.node.name) && path.node.name.name === 'img') {
+        const loc = path.node.loc;
+        smells.push({
+          type: 'nextjs-image-unoptimized',
+          severity: 'warning',
+          message: `Using native <img> instead of next/image in "${component.name}"`,
+          file: filePath,
+          line: loc?.start.line || 0,
+          column: loc?.start.column || 0,
+          suggestion: 'Use next/image for automatic image optimization: import Image from "next/image"',
+          codeSnippet: getCodeSnippet(sourceCode, loc?.start.line || 0),
+        });
+      }
+    },
+  });
+
+  // Check for client-side hooks in server components (App Router)
+  if (isAppRouter && !sourceCode.includes("'use client'") && !sourceCode.includes('"use client"')) {
+    const clientHooks = ['useState', 'useEffect', 'useContext', 'useReducer', 'useRef'];
+    const usedClientHooks: string[] = [];
+
+    component.path.traverse({
+      CallExpression(path) {
+        if (t.isIdentifier(path.node.callee) && clientHooks.includes(path.node.callee.name)) {
+          usedClientHooks.push(path.node.callee.name);
+        }
+      },
+    });
+
+    if (usedClientHooks.length > 0) {
+      const loc = component.node.loc;
+      smells.push({
+        type: 'nextjs-client-server-boundary',
+        severity: 'error',
+        message: `Client hooks (${usedClientHooks.join(', ')}) used without 'use client' directive in "${component.name}"`,
+        file: filePath,
+        line: loc?.start.line || 1,
+        column: 0,
+        suggestion: "Add 'use client' at the top of the file, or move client logic to a separate component",
+        codeSnippet: getCodeSnippet(sourceCode, 1),
+      });
+    }
+  }
+
+  // Check for missing metadata in page/layout files
+  if (isAppRouter && filePath.includes('page.')) {
+    // This would require checking exports, which needs file-level analysis
+    const hasMetadata = sourceCode.includes('export const metadata') || 
+                        sourceCode.includes('export function generateMetadata');
+    
+    if (!hasMetadata && component.name === 'default') {
+      smells.push({
+        type: 'nextjs-missing-metadata',
+        severity: 'info',
+        message: 'Page component missing metadata export',
+        file: filePath,
+        line: 1,
+        column: 0,
+        suggestion: 'Add metadata for SEO: export const metadata = { title: "...", description: "..." }',
+      });
+    }
+  }
+
+  // Check for router misuse (using window.location instead of next/router)
+  component.path.traverse({
+    MemberExpression(path) {
+      if (
+        t.isIdentifier(path.node.object) &&
+        path.node.object.name === 'window' &&
+        t.isIdentifier(path.node.property) &&
+        path.node.property.name === 'location'
+      ) {
+        const loc = path.node.loc;
+        smells.push({
+          type: 'nextjs-router-misuse',
+          severity: 'warning',
+          message: `Using window.location instead of Next.js router in "${component.name}"`,
+          file: filePath,
+          line: loc?.start.line || 0,
+          column: loc?.start.column || 0,
+          suggestion: 'Use next/navigation: import { useRouter } from "next/navigation"',
+          codeSnippet: getCodeSnippet(sourceCode, loc?.start.line || 0),
+        });
+      }
+    },
+  });
+
+  return smells;
+}

package/src/detectors/nodejs.ts

@@ -0,0 +1,199 @@
+import * as t from '@babel/types';
+import { NodePath } from '@babel/traverse';
+import { ParsedComponent, getCodeSnippet } from '../parser/index.js';
+import { CodeSmell, DetectorConfig, DEFAULT_CONFIG } from '../types/index.js';
+
+/**
+ * Detects Node.js-specific code smells:
+ * - Callback hell (deeply nested callbacks)
+ * - Unhandled promise rejections
+ * - Synchronous I/O operations
+ * - Missing error handling
+ */
+export function detectNodejsIssues(
+  component: ParsedComponent,
+  filePath: string,
+  sourceCode: string,
+  config: DetectorConfig = DEFAULT_CONFIG,
+  imports: string[] = []
+): CodeSmell[] {
+  if (!config.checkNodejs) return [];
+  
+  // Check if this looks like a Node.js file
+  const isNodeFile = imports.some(imp => 
+    imp.includes('fs') || imp.includes('path') || imp.includes('http') ||
+    imp.includes('express') || imp.includes('child_process') ||
+    imp.includes('crypto') || imp.includes('os') || imp.includes('stream')
+  ) || filePath.includes('.server.') || filePath.includes('/api/');
+
+  if (!isNodeFile) return [];
+
+  const smells: CodeSmell[] = [];
+
+  // Detect callback hell (nested callbacks > maxCallbackDepth)
+  component.path.traverse({
+    CallExpression(path) {
+      const depth = getCallbackDepth(path);
+      
+      if (depth > config.maxCallbackDepth) {
+        const loc = path.node.loc;
+        smells.push({
+          type: 'nodejs-callback-hell',
+          severity: 'warning',
+          message: `Callback hell detected (depth: ${depth}) in "${component.name}"`,
+          file: filePath,
+          line: loc?.start.line || 0,
+          column: loc?.start.column || 0,
+          suggestion: 'Refactor to async/await or use Promise.all() for parallel operations',
+          codeSnippet: getCodeSnippet(sourceCode, loc?.start.line || 0),
+        });
+      }
+    },
+  });
+
+  // Detect unhandled promise rejections (Promise without .catch or try/catch)
+  component.path.traverse({
+    CallExpression(path) {
+      // Check for .then() without .catch()
+      if (t.isMemberExpression(path.node.callee) && 
+          t.isIdentifier(path.node.callee.property) &&
+          path.node.callee.property.name === 'then') {
+        
+        // Check if followed by .catch() in chain
+        const parent = path.parent;
+        let hasCatch = false;
+        
+        if (t.isMemberExpression(parent)) {
+          const prop = (parent as t.MemberExpression).property;
+          if (t.isIdentifier(prop) && prop.name === 'catch') {
+            hasCatch = true;
+          }
+        }
+        
+        // Check if inside try block
+        let current: NodePath | null = path;
+        while (current) {
+          if (t.isTryStatement(current.node)) {
+            hasCatch = true;
+            break;
+          }
+          current = current.parentPath;
+        }
+        
+        if (!hasCatch) {
+          const loc = path.node.loc;
+          smells.push({
+            type: 'nodejs-unhandled-promise',
+            severity: 'warning',
+            message: `.then() without .catch() in "${component.name}"`,
+            file: filePath,
+            line: loc?.start.line || 0,
+            column: loc?.start.column || 0,
+            suggestion: 'Add .catch() to handle rejections, or use try/catch with async/await',
+            codeSnippet: getCodeSnippet(sourceCode, loc?.start.line || 0),
+          });
+        }
+      }
+    },
+  });
+
+  // Detect synchronous file operations
+  const syncMethods = ['readFileSync', 'writeFileSync', 'appendFileSync', 'readdirSync', 
+                       'statSync', 'mkdirSync', 'rmdirSync', 'unlinkSync', 'existsSync'];
+  
+  component.path.traverse({
+    CallExpression(path) {
+      const callee = path.node.callee;
+      
+      if (t.isMemberExpression(callee) && t.isIdentifier(callee.property)) {
+        if (syncMethods.includes(callee.property.name)) {
+          const loc = path.node.loc;
+          smells.push({
+            type: 'nodejs-sync-io',
+            severity: 'warning',
+            message: `Synchronous file operation "${callee.property.name}" blocks event loop`,
+            file: filePath,
+            line: loc?.start.line || 0,
+            column: loc?.start.column || 0,
+            suggestion: `Use async version: ${callee.property.name.replace('Sync', '')} with await or promises`,
+            codeSnippet: getCodeSnippet(sourceCode, loc?.start.line || 0),
+          });
+        }
+      }
+      
+      // Direct function call
+      if (t.isIdentifier(callee) && syncMethods.includes(callee.name)) {
+        const loc = path.node.loc;
+        smells.push({
+          type: 'nodejs-sync-io',
+          severity: 'warning',
+          message: `Synchronous file operation "${callee.name}" blocks event loop`,
+          file: filePath,
+          line: loc?.start.line || 0,
+          column: loc?.start.column || 0,
+          suggestion: `Use async version: ${callee.name.replace('Sync', '')} with await or promises`,
+          codeSnippet: getCodeSnippet(sourceCode, loc?.start.line || 0),
+        });
+      }
+    },
+  });
+
+  // Detect missing error handling in async functions
+  component.path.traverse({
+    AwaitExpression(path) {
+      // Check if inside try block
+      let insideTry = false;
+      let current: NodePath | null = path;
+      
+      while (current) {
+        if (t.isTryStatement(current.node)) {
+          insideTry = true;
+          break;
+        }
+        // Stop at function boundary
+        if (t.isFunction(current.node)) break;
+        current = current.parentPath;
+      }
+      
+      if (!insideTry) {
+        // Check if the parent function has error handling at call site
+        // This is a simplified check - in practice you'd want more context
+        const loc = path.node.loc;
+        smells.push({
+          type: 'nodejs-missing-error-handling',
+          severity: 'info',
+          message: `await without try/catch may cause unhandled rejections`,
+          file: filePath,
+          line: loc?.start.line || 0,
+          column: loc?.start.column || 0,
+          suggestion: 'Wrap await in try/catch or handle errors at the call site',
+          codeSnippet: getCodeSnippet(sourceCode, loc?.start.line || 0),
+        });
+      }
+    },
+  });
+
+  return smells;
+}
+
+/**
+ * Calculate the depth of nested callbacks
+ */
+function getCallbackDepth(path: NodePath): number {
+  let depth = 0;
+  let current: NodePath | null = path;
+  
+  while (current) {
+    const node = current.node;
+    
+    // Count function expressions that are arguments to calls
+    if ((t.isFunctionExpression(node) || t.isArrowFunctionExpression(node)) &&
+        t.isCallExpression(current.parent)) {
+      depth++;
+    }
+    
+    current = current.parentPath;
+  }
+  
+  return depth;
+}