feat: detect phantom dependencies

Author: goureeshreddy7

pr592_comments.json

@@ -58,7 +58,7 @@ import { renderOverrideFindings } from "./output/override-findings-terminal.js";
 import { installSkill } from "./skills/install.js";
 import { readConfig, validateCaCertFile } from "./cli/config.js";
 import { runConfigCommand } from "./cli/config-command.js";
-import { readDirectDependencyNames } from "./utils/package-json.js";
+import { readDirectDependencyNames, readOverridesAndResolutions } from "./utils/package-json.js";
 import {
   applyFixesIfRequested,
   FixExecutionResult,
@@ -645,6 +645,20 @@ if (parsedArgs) {
         if (options.checkOverrides) {
           console.log(renderOverrideFindings(overrideFindings));
         }
+        
+        if (options.usage) {
+          if (scanState.pd001 && scanState.pd001.length > 0) {
+            console.log(chalk.red("\n[PD001] Override-only Phantom Dependencies Detected (Build Breakers)"));
+            scanState.pd001.forEach(pkg => console.log(`  - ${pkg}`));
+          }
+          if (scanState.pd002 && scanState.pd002.length > 0) {
+            console.log(chalk.yellow("\n[PD002] Transitive-only Phantom Dependencies Detected"));
+            scanState.pd002.forEach(pkg => console.log(`  - ${pkg}`));
+          }
+          if ((scanState.pd001 && scanState.pd001.length > 0) || (scanState.pd002 && scanState.pd002.length > 0)) {
+            console.log(chalk.gray("\nAction: Declare these dependencies explicitly in your package.json.\n"));
+          }
+        }
       }
     }
 
@@ -697,7 +711,9 @@ if (parsedArgs) {
     const reachesFailOn = (f: { severity: SeverityLabel }) =>
       severityOrder[f.severity] >= severityOrder[failLevel];
     const shouldFail =
-      scanState.sorted.some(reachesFailOn) || overrideFindings.some(reachesFailOn);
+      scanState.sorted.some(reachesFailOn) || 
+      overrideFindings.some(reachesFailOn) ||
+      (options.usage && ((scanState.pd001 && scanState.pd001.length > 0) || (scanState.pd002 && scanState.pd002.length > 0)));
     const exitCode = shouldFail ? 1 : 0;
 
     // Emit scan.finished event and close audit-log
@@ -773,11 +789,32 @@ async function scanProject(params: {
     scanFilePath: params.scanInput.filePath,
   }, params.debugLog);
 
+  let pd001: string[] = [];
+  let pd002: string[] = [];
+
   if (params.options.usage) {
-    logInfo(`Scanning project source for usage hints...`, params.options);
+    logInfo(`Scanning project source for usage hints and phantom dependencies...`, params.options);
     const usageStartedAt = Date.now();
-    const pkgNames = new Set(findings.map(f => f.pkg.name));
-    const usageData = scanProjectForPackageUsage(params.projectPath, pkgNames);
+    
+    // Pass undefined to get ALL imported packages for phantom dependency detection
+    const usageData = scanProjectForPackageUsage(params.projectPath);
+    
+    const allLockfilePackages = new Set(params.scanInput.packages.map(p => p.name));
+    const overridesAndResolutions = readOverridesAndResolutions(params.projectPath);
+    const directDeps = directDependencyNames || new Set<string>();
+
+    for (const importedPkg of Object.keys(usageData)) {
+      if (usageData[importedPkg].length === 0) continue;
+      
+      if (!directDeps.has(importedPkg)) {
+        if (overridesAndResolutions.has(importedPkg)) {
+          pd001.push(importedPkg);
+        } else if (allLockfilePackages.has(importedPkg)) {
+          pd002.push(importedPkg);
+        }
+      }
+    }
+
     let matchedPackages = 0;
     for (const finding of findings) {
       const files = usageData[finding.pkg.name];
@@ -794,8 +831,10 @@ async function scanProject(params: {
     if (params.options.debug) {
       params.debugLog("Usage scan", {
         durationMs: Date.now() - usageStartedAt,
-        packagesChecked: pkgNames.size,
+        packagesChecked: Object.keys(usageData).length,
         matchedPackages,
+        pd001: pd001.length,
+        pd002: pd002.length,
       });
     }
   }
@@ -828,6 +867,8 @@ async function scanProject(params: {
     tableFindings,
     suggestedFixCommands,
     allPackages: params.scanInput.packages,
+    pd001,
+    pd002,
   };
 }
 

src/index.ts

@@ -27,15 +27,17 @@ function getBareModuleName(importPath: string): string {
 
 export function scanProjectForPackageUsage(
   projectPath: string,
-  packagesToLookFor: Set<string>,
+  packagesToLookFor?: Set<string>,
 ): Record<string, string[]> {
   const results: Record<string, string[]> = {};
-  for (const pkg of packagesToLookFor) {
-    results[pkg] = [];
-  }
+  if (packagesToLookFor) {
+    for (const pkg of packagesToLookFor) {
+      results[pkg] = [];
+    }
 
-  if (packagesToLookFor.size === 0) {
-    return results;
+    if (packagesToLookFor.size === 0) {
+      return results;
+    }
   }
 
   // Cap at 5000 files to prevent performance issues on massive projects
@@ -80,14 +82,16 @@ export function scanProjectForPackageUsage(
     }
 
     // Fast path: skip regex if the file doesn't contain any target package names
-    let hasPotentialMatch = false;
-    for (const pkg of packagesToLookFor) {
-      if (content.includes(pkg)) {
-        hasPotentialMatch = true;
-        break;
+    if (packagesToLookFor) {
+      let hasPotentialMatch = false;
+      for (const pkg of packagesToLookFor) {
+        if (content.includes(pkg)) {
+          hasPotentialMatch = true;
+          break;
+        }
       }
+      if (!hasPotentialMatch) return;
     }
-    if (!hasPotentialMatch) return;
 
     const matches = content.matchAll(IMPORT_REQUIRE_REGEX);
     const foundPackages = new Set<string>();
@@ -96,15 +100,20 @@ export function scanProjectForPackageUsage(
       const importPath = match[1] || match[2] || match[3] || match[4];
       if (importPath) {
         const bare = getBareModuleName(importPath);
-        if (bare && packagesToLookFor.has(bare)) {
-          foundPackages.add(bare);
+        if (bare) {
+          if (!packagesToLookFor || packagesToLookFor.has(bare)) {
+            foundPackages.add(bare);
+          }
         }
       }
     }
 
     for (const pkg of foundPackages) {
       // Store relative path for cleaner output
       const relPath = path.relative(projectPath, filePath);
+      if (!results[pkg]) {
+        results[pkg] = [];
+      }
       results[pkg].push(relPath);
     }
   }

src/usage/scanner.ts

@@ -141,3 +141,31 @@ function expandWorkspacePattern(projectPath: string, segments: string[], current
 export function isRecord(value: unknown): value is Record<string, unknown> {
   return !!value && typeof value === "object" && !Array.isArray(value);
 }
+
+export function readOverridesAndResolutions(projectPath: string): Set<string> {
+  const packageJsonPath = path.join(projectPath, "package.json");
+  const result = new Set<string>();
+
+  if (!fs.existsSync(packageJsonPath)) {
+    return result;
+  }
+
+  const manifest = readPackageJsonObject(packageJsonPath);
+  if (!manifest) {
+    return result;
+  }
+
+  const sections: Array<Record<string, unknown> | undefined> = [
+    isRecord(manifest.overrides) ? manifest.overrides : undefined,
+    isRecord(manifest.resolutions) ? manifest.resolutions : undefined,
+  ];
+
+  for (const section of sections) {
+    if (!section) continue;
+    for (const name of Object.keys(section)) {
+      result.add(name);
+    }
+  }
+
+  return result;
+}