packages/core/src/helpers.ts (3)

74-79: Add documentation for the FindUpOptions interface.

Please add JSDoc comments to describe each property and their expected usage for better developer experience.

+/**
+ * Options for the findUp function
+ * @property {string} [entry] - The starting directory or file path for the search
+ * @property {string} [filename] - The filename to search for
+ * @property {FileType} [type] - The expected file type
+ * @property {string} [stop] - The directory path where the search should stop
+ */
 export interface FindUpOptions {
   entry?: string
   filename?: string
   type?: FileType
   stop?: string
 }

---

37-39: ⚠️ Potential issue

Check for undefined instead of falsy values.

Using !type may override an explicit false value. Consider checking specifically for undefined.

-  if (!type) {
-    type = 'file'
-  }
+  if (type === undefined) {
+    type = 'file'
+  }

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 38-38: packages/core/src/helpers.ts#L38
Added line #L38 was not covered by tests

---

122-122: ⚠️ Potential issue

Fix the while loop condition to prevent potential infinite loops.

The current condition has logical issues:

• If stop is undefined, the loop continues indefinitely due to !stop
• The condition continues when entry starts with the stop path, which seems backwards

-  } while (!stop || entry !== stop || entry.startsWith(stop + path.sep))
+  } while (!stop || (entry !== stop && entry.startsWith(stop + path.sep)))

.changeset/poor-walls-arrive.md (1)

5-5: Include package scope in the summary.

To improve clarity in your changelog and align with Conventional Commits, consider adding the package scope in the summary. For example:

refactor(core)!: change `findUp` signature, support search root

This makes it explicit which package is affected.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

packages/core/src/helpers.ts (3)

37-39: Fix type checking logic to handle explicit boolean values correctly.

This issue was previously identified but remains unresolved. The current logic if (!type) will incorrectly treat an explicit false value as falsy and default to 'file', which may not be the intended behavior.

Apply this fix to handle undefined values explicitly:

-  if (!type) {
-    type = 'file'
-  }
+  if (type === undefined) {
+    type = 'file'
+  }

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 38-38: packages/core/src/helpers.ts#L38
Added line #L38 was not covered by tests

---

74-81: Add comprehensive documentation for the FindUpOptions interface.

The interface lacks documentation describing the purpose and expected usage of each property, making it difficult for consumers to understand the API.

Add JSDoc comments to document each property:

+/**
+ * Options for configuring the findUp function behavior
+ */
 export interface FindUpOptions {
+  /** Starting directory or file path for the search */
   entry?: string
+  /** Target filename or pattern to search for */
   search?: string
+  /** Expected file type (file, directory, etc.) */
   type?: FileType
+  /** Directory path where the search should stop */
   stop?: string
+  /** Whether to throw an error if the stop path is not found */
   throwOnStopNotFound?: boolean
+  /** Whether to throw an error if the stop path is invalid */
   throwOnInvalidStop?: boolean
 }

---

32-157: Critical: Add comprehensive test coverage for the refactored functions.

The static analysis shows extensive gaps in test coverage for the new and refactored functions. Given this is a breaking change with complex validation logic, comprehensive tests are essential.

Let me verify the current test coverage:

#!/bin/bash
# Check for existing tests related to the helper functions
rg -n "tryFileStats|tryFile|findUp" --glob "*.test.*" --glob "*.spec.*" -A 3 -B 3

# Check for test files in the core package
fd -e test.ts -e test.js -e spec.ts -e spec.js . packages/core/

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 32-32: packages/core/src/helpers.ts#L32
Added line #L32 was not covered by tests

---

[warning] 36-36: packages/core/src/helpers.ts#L36
Added line #L36 was not covered by tests

---

[warning] 38-38: packages/core/src/helpers.ts#L38
Added line #L38 was not covered by tests

---

[warning] 43-43: packages/core/src/helpers.ts#L43
Added line #L43 was not covered by tests

---

[warning] 45-45: packages/core/src/helpers.ts#L45
Added line #L45 was not covered by tests

---

[warning] 47-47: packages/core/src/helpers.ts#L47
Added line #L47 was not covered by tests

---

[warning] 51-52: packages/core/src/helpers.ts#L51-L52
Added lines #L51 - L52 were not covered by tests

---

[warning] 56-56: packages/core/src/helpers.ts#L56
Added line #L56 was not covered by tests

---

[warning] 58-58: packages/core/src/helpers.ts#L58
Added line #L58 was not covered by tests

---

[warning] 63-63: packages/core/src/helpers.ts#L63
Added line #L63 was not covered by tests

---

[warning] 89-89: packages/core/src/helpers.ts#L89
Added line #L89 was not covered by tests

---

[warning] 105-105: packages/core/src/helpers.ts#L105
Added line #L105 was not covered by tests

---

[warning] 109-109: packages/core/src/helpers.ts#L109
Added line #L109 was not covered by tests

---

[warning] 111-111: packages/core/src/helpers.ts#L111
Added line #L111 was not covered by tests

---

[warning] 113-113: packages/core/src/helpers.ts#L113
Added line #L113 was not covered by tests

---

[warning] 115-115: packages/core/src/helpers.ts#L115
Added line #L115 was not covered by tests

---

[warning] 117-117: packages/core/src/helpers.ts#L117
Added line #L117 was not covered by tests

---

[warning] 120-121: packages/core/src/helpers.ts#L120-L121
Added lines #L120 - L121 were not covered by tests

---

[warning] 124-124: packages/core/src/helpers.ts#L124
Added line #L124 was not covered by tests

---

[warning] 126-126: packages/core/src/helpers.ts#L126
Added line #L126 was not covered by tests

---

[warning] 128-128: packages/core/src/helpers.ts#L128
Added line #L128 was not covered by tests

---

[warning] 130-130: packages/core/src/helpers.ts#L130
Added line #L130 was not covered by tests

---

[warning] 134-134: packages/core/src/helpers.ts#L134
Added line #L134 was not covered by tests

---

[warning] 137-137: packages/core/src/helpers.ts#L137
Added line #L137 was not covered by tests

---

[warning] 141-142: packages/core/src/helpers.ts#L141-L142
Added lines #L141 - L142 were not covered by tests

---

[warning] 145-145: packages/core/src/helpers.ts#L145
Added line #L145 was not covered by tests

---

[warning] 149-150: packages/core/src/helpers.ts#L149-L150
Added lines #L149 - L150 were not covered by tests

packages/core/src/helpers.ts (2)

45-52: Complex type checking logic needs simplification and documentation.

The nested ternary and type checking logic is hard to read and understand. Consider extracting this into a helper function for better maintainability.

Extract the type checking logic into a helper function:

+const isFileTypeMatch = (stats: Stats, type: FileTypes): boolean => {
+  if (isAnyFileType(type)) {
+    return true
+  }
+  const types = Array.isArray(type) ? type : [type]
+  return types.some(t => 
+    stats[`is${t[0].toUpperCase()}${t.slice(1)}` as `is${Capitalize<FileTypeBase>}`]()
+  )
+}

-    return stats &&
-      (isAnyFileType(type) ||
-        (Array.isArray(type) ? type : [type]).some(type =>
-          stats[
-            `is${type[0].toUpperCase()}${type.slice(1)}` as `is${Capitalize<FileTypeBase>}`
-          ](),
-        ))
-      ? { filepath, stats }
-      : undefined
+    return stats && isFileTypeMatch(stats, type)
+      ? { filepath, stats }
+      : undefined

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 45-45: packages/core/src/helpers.ts#L45
Added line #L45 was not covered by tests

---

[warning] 47-47: packages/core/src/helpers.ts#L47
Added line #L47 was not covered by tests

---

[warning] 51-52: packages/core/src/helpers.ts#L51-L52
Added lines #L51 - L52 were not covered by tests

---

108-132: Stop path validation logic is robust but could benefit from extracted functions.

The stop path validation logic is comprehensive and handles edge cases well, but the complexity makes it hard to follow. Consider extracting validation functions.

Extract validation logic into helper functions:

+const validateStopPath = (stop: string, throwOnNotFound?: boolean) => {
+  const stopStats = tryFileStats(stop, ['file', 'directory'])
+  if (!stopStats) {
+    const message = `Cannot find stop path: ${stop}`
+    if (throwOnNotFound) {
+      throw new Error(message)
+    } else if (throwOnNotFound !== false) {
+      console.warn(message)
+    }
+    return null
+  }
+  return stopStats.stats.isDirectory()
+    ? stopStats.filepath
+    : path.dirname(stopStats.filepath)
+}
+
+const validateStopIsParent = (entry: string, stop: string, throwOnInvalid?: boolean) => {
+  if (entry !== stop && !entry.startsWith(stop + path.sep)) {
+    const message = `Invalid stop path: ${stop} is not a parent of ${entry}`
+    if (throwOnInvalid) {
+      throw new Error(message)
+    } else if (throwOnInvalid !== false) {
+      console.warn(message)
+    }
+    return false
+  }
+  return true
+}

🧰 Tools

🪛 GitHub Check: codecov/patch

[warning] 109-109: packages/core/src/helpers.ts#L109
Added line #L109 was not covered by tests

---

[warning] 111-111: packages/core/src/helpers.ts#L111
Added line #L111 was not covered by tests

---

[warning] 113-113: packages/core/src/helpers.ts#L113
Added line #L113 was not covered by tests

---

[warning] 115-115: packages/core/src/helpers.ts#L115
Added line #L115 was not covered by tests

---

[warning] 117-117: packages/core/src/helpers.ts#L117
Added line #L117 was not covered by tests

---

[warning] 120-121: packages/core/src/helpers.ts#L120-L121
Added lines #L120 - L121 were not covered by tests

---

[warning] 124-124: packages/core/src/helpers.ts#L124
Added line #L124 was not covered by tests

---

[warning] 126-126: packages/core/src/helpers.ts#L126
Added line #L126 was not covered by tests

---

[warning] 128-128: packages/core/src/helpers.ts#L128
Added line #L128 was not covered by tests

---

[warning] 130-130: packages/core/src/helpers.ts#L130
Added line #L130 was not covered by tests

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro