refactor: optimize the file finder code (#50)

Author: nickfrosty

.changeset/clean-drinks-move.md

@@ -0,0 +1,5 @@
+---
+"mucho": patch
+---
+
+optimize the file finder code

src/lib/cli.ts

@@ -7,7 +7,7 @@ import { OutputConfiguration } from "@commander-js/extra-typings";
 import {
   directoryExists,
   doesFileExist,
-  findFileInRepo,
+  findClosestFile,
   isInCurrentDir,
   loadTomlFile,
   loadYamlFile,
@@ -77,13 +77,15 @@ export function loadConfigToml(
 
   // attempt to locate the closest config file
   if (configPath === DEFAULT_CONFIG_FILE) {
-    // accept both `Solana.toml` and `solana.toml` (case insensitive)
-    const newPath = findFileInRepo(DEFAULT_CONFIG_FILE);
+    // accepts both `Solana.toml` and `solana.toml` (case insensitive)
+    const newPath = findClosestFile({
+      fileName: DEFAULT_CONFIG_FILE,
+    });
     if (newPath) {
       configPath = newPath;
       if (!isInCurrentDir(newPath)) {
         // todo: should we prompt the user if they want to use this one?
-        warnMessage(`Using closest Solana.toml located at: ${newPath}`);
+        warnMessage(`Using Solana.toml located at: ${newPath}`);
       }
     }
   }
@@ -95,7 +97,8 @@ export function loadConfigToml(
   } else {
     if (isConfigRequired) {
       warningOutro(`No Solana.toml config file found. Operation canceled.`);
-    } else warnMessage(`No Solana.toml config file found. Skipping.`);
+      process.exit();
+    }
   }
 
   const defaultSettings: SolanaToml["settings"] = {

src/lib/programs.ts

@@ -40,7 +40,7 @@ export function listLocalPrograms({
   }
 
   if (!directoryExists(buildDir)) {
-    warnMessage(`Unable to locate build output directory: ${buildDir}`);
+    // warnMessage(`Unable to locate build output directory: ${buildDir}`);
     return { locatedPrograms, buildDirListing, allFound };
   }
 

src/lib/utils.ts

@@ -241,68 +241,96 @@ export function updateGitignore(
   }
 }
 
-export function findFileInRepo(
-  targetFilename: string,
-  startDir: string = process.cwd(),
-  maxDepth: number = 5 /* depth=5 should be good enough to handle most repos? */,
-  skipDirs: string[] = ["node_modules", ".cache"],
-): string | null {
-  let currentDir = startDir;
-  let depth = 0;
-
-  while (depth < maxDepth) {
-    const filePath = findFileInDirectory(
-      currentDir,
-      targetFilename.toLowerCase(),
-      skipDirs,
+export function findClosestFile({
+  fileName,
+  maxDepth = 5,
+  maxLevelsUp = 5,
+  stopMarkers = [".git", "package.json", "cargo.toml"],
+  startDir = process.cwd(),
+  skipDirs = ["node_modules"],
+}: {
+  fileName: string;
+  maxDepth?: number;
+  maxLevelsUp?: number;
+  stopMarkers?: string[];
+  skipDirs?: string[];
+  startDir?: string;
+}): string | null {
+  const visited = new Set<string>();
+
+  // check if we're already in what looks like a repo
+  const isLikelyRepo = stopMarkers.some((marker) =>
+    fs.existsSync(path.join(startDir, marker)),
+  );
+
+  // if we are not in what looks like a repo, limit the search more aggressively
+  if (!isLikelyRepo) {
+    maxDepth = 2;
+    maxLevelsUp = 2;
+  }
+
+  function crawlUp(currentDir: string, levelsUp: number): string | null {
+    if (levelsUp > maxLevelsUp) return null;
+
+    let targetPath = path.join(currentDir, fileName);
+    if (fs.existsSync(targetPath)) return targetPath;
+    targetPath = path.join(currentDir, fileName.toLowerCase());
+    if (fs.existsSync(targetPath)) return targetPath;
+
+    const hasMarker = stopMarkers.some((marker) =>
+      fs.existsSync(path.join(currentDir, marker)),
     );
-    if (filePath) return filePath;
 
-    // stop searching once we hit the repository root
-    const gitDir = path.join(currentDir, ".git");
-    if (fs.existsSync(gitDir) && fs.statSync(gitDir).isDirectory()) {
-      return null;
-    }
+    if (hasMarker && levelsUp > 0) return null;
 
-    // Move up one directory
     const parentDir = path.dirname(currentDir);
-    if (parentDir === currentDir) {
-      return null;
-    }
+    if (parentDir === currentDir) return null;
 
-    currentDir = parentDir;
-    depth++;
+    return crawlUp(parentDir, levelsUp + 1);
   }
 
-  return null;
-}
+  function crawlDown(dir: string, depth: number): string | null {
+    if (depth > maxDepth) return null;
+    if (visited.has(dir)) return null;
+    visited.add(dir);
 
-export function findFileInDirectory(
-  dir: string,
-  targetFilename: string,
-  skipDirs: string[],
-): string | null {
-  const files = fs.readdirSync(dir);
-
-  for (const file of files) {
-    const absolutePath = path.join(dir, file);
     try {
-      if (fs.statSync(absolutePath).isDirectory()) {
-        if (skipDirs.includes(file)) {
+      let targetPath = path.join(dir, fileName);
+      if (fs.existsSync(targetPath)) return targetPath;
+      targetPath = path.join(dir, fileName.toLowerCase());
+      if (fs.existsSync(targetPath)) return targetPath;
+
+      const entries = fs.readdirSync(dir, { withFileTypes: true });
+
+      for (const entry of entries) {
+        // skip hidden directories and node_modules
+        if (entry.name.startsWith(".") || skipDirs.includes(entry.name))
           continue;
+
+        if (entry.isDirectory()) {
+          const fullPath = path.join(dir, entry.name);
+
+          const hasMarker = stopMarkers.some((marker) =>
+            fs.existsSync(path.join(fullPath, marker)),
+          );
+          if (hasMarker) continue;
+
+          const result = crawlDown(fullPath, depth + 1);
+          if (result) return result;
         }
-        const result = findFileInDirectory(
-          absolutePath,
-          targetFilename,
-          skipDirs,
-        );
-        if (result) return result; // Found in a subdirectory
-      } else if (file.toLowerCase() === targetFilename) {
-        return absolutePath;
       }
-    } catch (err) {}
+    } catch (error) {
+      // honey badger don't care about errors
+      return null;
+    }
+
+    return null;
   }
 
+  const upResult = crawlUp(startDir, 0);
+  if (upResult) return upResult;
+  if (isLikelyRepo) return crawlDown(startDir, 0);
+
   return null;
 }