@hyperfrontend/project-scope 0.2.1 → 0.2.2

package/project/traversal/index.esm.js

@@ -1,375 +1,14 @@
+import { isArray } from '../../_dependencies/@hyperfrontend/immutable-api-utils/built-in-copy/array/index.esm.js';
+import { error, warn, log, info, debug } from '../../_dependencies/@hyperfrontend/immutable-api-utils/built-in-copy/console/index.esm.js';
+import { stringify } from '../../_dependencies/@hyperfrontend/immutable-api-utils/built-in-copy/json/index.esm.js';
+import { freeze, entries, keys, defineProperties } from '../../_dependencies/@hyperfrontend/immutable-api-utils/built-in-copy/object/index.esm.js';
+import { createSet } from '../../_dependencies/@hyperfrontend/immutable-api-utils/built-in-copy/set/index.esm.js';
+import { createLogger } from '../../_dependencies/@hyperfrontend/logging/index.esm.js';
 import { join } from 'node:path';
 import { existsSync, readFileSync, statSync, lstatSync, readdirSync } from 'node:fs';
-
-/**
- * Safe copies of Error built-ins via factory functions.
- *
- * Since constructors cannot be safely captured via Object.assign, this module
- * provides factory functions that use Reflect.construct internally.
- *
- * These references are captured at module initialization time to protect against
- * prototype pollution attacks. Import only what you need for tree-shaking.
- *
- * @module @hyperfrontend/immutable-api-utils/built-in-copy/error
- */
-const _Error = globalThis.Error;
-const _Reflect$1 = globalThis.Reflect;
-/**
- * (Safe copy) Creates a new Error using the captured Error constructor.
- * Use this instead of `new Error()`.
- *
- * @param message - Optional error message.
- * @param options - Optional error options.
- * @returns A new Error instance.
- */
-const createError = (message, options) => _Reflect$1.construct(_Error, [message, options]);
-
-/**
- * Safe copies of JSON built-in methods.
- *
- * These references are captured at module initialization time to protect against
- * prototype pollution attacks. Import only what you need for tree-shaking.
- *
- * @module @hyperfrontend/immutable-api-utils/built-in-copy/json
- */
-const _JSON = globalThis.JSON;
-/**
- * (Safe copy) Converts a JavaScript value to a JavaScript Object Notation (JSON) string.
- */
-const stringify = _JSON.stringify;
-
-/**
- * Safe copies of Object built-in methods.
- *
- * These references are captured at module initialization time to protect against
- * prototype pollution attacks. Import only what you need for tree-shaking.
- *
- * @module @hyperfrontend/immutable-api-utils/built-in-copy/object
- */
-const _Object = globalThis.Object;
-/**
- * (Safe copy) Prevents modification of existing property attributes and values,
- * and prevents the addition of new properties.
- */
-const freeze = _Object.freeze;
-/**
- * (Safe copy) Returns the names of the enumerable string properties and methods of an object.
- */
-const keys = _Object.keys;
-/**
- * (Safe copy) Returns an array of key/values of the enumerable own properties of an object.
- */
-const entries = _Object.entries;
-/**
- * (Safe copy) Adds one or more properties to an object, and/or modifies attributes of existing properties.
- */
-const defineProperties = _Object.defineProperties;
-
-/**
- * Safe copies of Array built-in static methods.
- *
- * These references are captured at module initialization time to protect against
- * prototype pollution attacks. Import only what you need for tree-shaking.
- *
- * @module @hyperfrontend/immutable-api-utils/built-in-copy/array
- */
-const _Array = globalThis.Array;
-/**
- * (Safe copy) Determines whether the passed value is an Array.
- */
-const isArray = _Array.isArray;
-
-/**
- * Safe copies of Console built-in methods.
- *
- * These references are captured at module initialization time to protect against
- * prototype pollution attacks. Import only what you need for tree-shaking.
- *
- * @module @hyperfrontend/immutable-api-utils/built-in-copy/console
- */
-const _console = globalThis.console;
-/**
- * (Safe copy) Outputs a message to the console.
- */
-const log = _console.log.bind(_console);
-/**
- * (Safe copy) Outputs a warning message to the console.
- */
-const warn = _console.warn.bind(_console);
-/**
- * (Safe copy) Outputs an error message to the console.
- */
-const error = _console.error.bind(_console);
-/**
- * (Safe copy) Outputs an informational message to the console.
- */
-const info = _console.info.bind(_console);
-/**
- * (Safe copy) Outputs a debug message to the console.
- */
-const debug = _console.debug.bind(_console);
-/**
- * (Safe copy) Outputs a stack trace to the console.
- */
-_console.trace.bind(_console);
-/**
- * (Safe copy) Displays an interactive listing of the properties of a specified object.
- */
-_console.dir.bind(_console);
-/**
- * (Safe copy) Displays tabular data as a table.
- */
-_console.table.bind(_console);
-/**
- * (Safe copy) Writes an error message to the console if the assertion is false.
- */
-_console.assert.bind(_console);
-/**
- * (Safe copy) Clears the console.
- */
-_console.clear.bind(_console);
-/**
- * (Safe copy) Logs the number of times that this particular call to count() has been called.
- */
-_console.count.bind(_console);
-/**
- * (Safe copy) Resets the counter used with console.count().
- */
-_console.countReset.bind(_console);
-/**
- * (Safe copy) Creates a new inline group in the console.
- */
-_console.group.bind(_console);
-/**
- * (Safe copy) Creates a new inline group in the console that is initially collapsed.
- */
-_console.groupCollapsed.bind(_console);
-/**
- * (Safe copy) Exits the current inline group.
- */
-_console.groupEnd.bind(_console);
-/**
- * (Safe copy) Starts a timer with a name specified as an input parameter.
- */
-_console.time.bind(_console);
-/**
- * (Safe copy) Stops a timer that was previously started.
- */
-_console.timeEnd.bind(_console);
-/**
- * (Safe copy) Logs the current value of a timer that was previously started.
- */
-_console.timeLog.bind(_console);
-
-/**
- * Safe copies of Set built-in via factory function.
- *
- * Since constructors cannot be safely captured via Object.assign, this module
- * provides a factory function that uses Reflect.construct internally.
- *
- * These references are captured at module initialization time to protect against
- * prototype pollution attacks. Import only what you need for tree-shaking.
- *
- * @module @hyperfrontend/immutable-api-utils/built-in-copy/set
- */
-const _Set = globalThis.Set;
-const _Reflect = globalThis.Reflect;
-/**
- * (Safe copy) Creates a new Set using the captured Set constructor.
- * Use this instead of `new Set()`.
- *
- * @param iterable - Optional iterable of values.
- * @returns A new Set instance.
- */
-const createSet = (iterable) => _Reflect.construct(_Set, iterable ? [iterable] : []);
-
-const registeredClasses = [];
-
-/**
- * Returns the data type of the target.
- * Uses native `typeof` operator, however, makes distinction between `null`, `array`, and `object`.
- * Also, when classes are registered via `registerClass`, it checks if objects are instance of any known registered class.
- *
- * @param target - The target to get the data type of.
- * @returns The data type of the target.
- */
-const getType = (target) => {
-    if (target === null)
-        return 'null';
-    const nativeDataType = typeof target;
-    if (nativeDataType === 'object') {
-        if (isArray(target))
-            return 'array';
-        for (const registeredClass of registeredClasses) {
-            if (target instanceof registeredClass)
-                return registeredClass.name;
-        }
-    }
-    return nativeDataType;
-};
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/**
- * Creates a wrapper function that only executes the wrapped function if the condition function returns true.
- *
- * @param func - The function to be conditionally executed.
- * @param conditionFunc - A function that returns a boolean, determining if `func` should be executed.
- * @returns A wrapped version of `func` that executes conditionally.
- */
-function createConditionalExecutionFunction(func, conditionFunc) {
-    return function (...args) {
-        if (conditionFunc()) {
-            return func(...args);
-        }
-    };
-}
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/**
- * Creates a wrapper function that silently ignores any errors thrown by the wrapped void function.
- * This function is specifically for wrapping functions that do not return a value (void functions).
- * Exceptions are swallowed without any logging or handling.
- *
- * @param func - The void function to be wrapped.
- * @returns A wrapped version of the input function that ignores errors.
- */
-function createErrorIgnoringFunction(func) {
-    return function (...args) {
-        try {
-            func(...args);
-        }
-        catch {
-            // Deliberately swallowing/ignoring the exception
-        }
-    };
-}
-
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/**
- * A no-operation function (noop) that does nothing regardless of the arguments passed.
- * It is designed to be as permissive as possible in its typing without using the `Function` keyword.
- *
- * @param args - Any arguments passed to the function (ignored)
- */
-const noop = (...args) => {
-    // Intentionally does nothing
-};
-
-const logLevels = ['none', 'error', 'warn', 'log', 'info', 'debug'];
-const priority = {
-    error: 4,
-    warn: 3,
-    log: 2,
-    info: 1,
-    debug: 0,
-};
-/**
- * Validates whether a given string is a valid log level.
- *
- * @param level - The log level to validate
- * @returns True if the level is valid, false otherwise
- */
-function isValidLogLevel(level) {
-    return logLevels.includes(level);
-}
-/**
- * Creates a log level configuration manager for controlling logging behavior.
- * Provides methods to get, set, and evaluate log levels based on priority.
- *
- * @param level - The initial log level (defaults to 'error')
- * @returns A configuration object with log level management methods
- * @throws {Error} When the provided level is not a valid log level
- */
-function createLogLevelConfig(level = 'error') {
-    if (!isValidLogLevel(level)) {
-        throw createError('Cannot create log level configuration with a valid default log level');
-    }
-    const state = { level };
-    const getLogLevel = () => state.level;
-    const setLogLevel = (level) => {
-        if (!isValidLogLevel(level)) {
-            throw createError(`Cannot set value '${level}' level. Expected levels are ${logLevels}.`);
-        }
-        state.level = level;
-    };
-    const shouldLog = (level) => {
-        if (state.level === 'none' || level === 'none' || !isValidLogLevel(level)) {
-            return false;
-        }
-        return priority[level] >= priority[state.level];
-    };
-    return freeze({
-        getLogLevel,
-        setLogLevel,
-        shouldLog,
-    });
-}
-
-/**
- * Creates a logger instance with configurable log level filtering.
- * Each log function is wrapped to respect the current log level setting.
- *
- * @param error - Function to handle error-level logs (required)
- * @param warn - Function to handle warning-level logs (optional, defaults to noop)
- * @param log - Function to handle standard logs (optional, defaults to noop)
- * @param info - Function to handle info-level logs (optional, defaults to noop)
- * @param debug - Function to handle debug-level logs (optional, defaults to noop)
- * @returns A frozen logger object with log methods and level control
- * @throws {ErrorLevelFn} When any provided log function is invalid
- */
-function createLogger(error, warn = noop, log = noop, info = noop, debug = noop) {
-    if (notValidLogFn(error)) {
-        throw createError(notFnMsg('error'));
-    }
-    if (notValidLogFn(warn)) {
-        throw createError(notFnMsg('warn'));
-    }
-    if (notValidLogFn(log)) {
-        throw createError(notFnMsg('log'));
-    }
-    if (notValidLogFn(info)) {
-        throw createError(notFnMsg('info'));
-    }
-    if (notValidLogFn(debug)) {
-        throw createError(notFnMsg('debug'));
-    }
-    const { setLogLevel, getLogLevel, shouldLog } = createLogLevelConfig();
-    const wrapLogFn = (fn, level) => {
-        if (fn === noop)
-            return fn;
-        const condition = () => shouldLog(level);
-        return createConditionalExecutionFunction(createErrorIgnoringFunction(fn), condition);
-    };
-    return freeze({
-        error: wrapLogFn(error, 'error'),
-        warn: wrapLogFn(warn, 'warn'),
-        log: wrapLogFn(log, 'log'),
-        info: wrapLogFn(info, 'info'),
-        debug: wrapLogFn(debug, 'debug'),
-        setLogLevel,
-        getLogLevel,
-    });
-}
-/**
- * Validates whether a given value is a valid log function.
- *
- * @param fn - The value to validate
- * @returns True if the value is not a function (invalid), false if it is valid
- */
-function notValidLogFn(fn) {
-    return getType(fn) !== 'function' && fn !== noop;
-}
-/**
- * Generates an error message for invalid log function parameters.
- *
- * @param label - The name of the log function that failed validation
- * @returns A formatted error message string
- */
-function notFnMsg(label) {
-    return `Cannot create a logger when ${label} is not a function`;
-}
-
-createLogger(error, warn, log, info, debug);
+import { createError } from '../../_dependencies/@hyperfrontend/immutable-api-utils/built-in-copy/error/index.esm.js';
+import { isDirectory } from '../../_shared/core/fs/stat/index.esm.js';
+import { matchGlobPattern } from '../../_shared/core/patterns/glob/index.esm.js';
 
 /**
  * Global log level registry.
@@ -409,6 +48,13 @@ function isSensitiveKey(key) {
  *
  * @param obj - Object to sanitize
  * @returns New object with sensitive values redacted
+ *
+ * @example Sanitizing sensitive data
+ * ```typescript
+ * const config = { apiKey: 'secret123', endpoint: 'https://api.example.com' }
+ * const safe = sanitize(config)
+ * // => { apiKey: '[REDACTED]', endpoint: 'https://api.example.com' }
+ * ```
  */
 function sanitize(obj) {
     if (obj === null || obj === undefined) {
@@ -459,7 +105,7 @@ function formatMessage(namespace, message, meta) {
  * @param options - Logger configuration options
  * @returns A configured scoped logger instance
  *
- * @example
+ * @example Creating a scoped logger
  * ```typescript
  * const logger = createScopedLogger('project-scope')
  * logger.setLogLevel('debug')
@@ -496,7 +142,7 @@ function createScopedLogger(namespace, options = {}) {
  * Default logger instance for the project-scope library.
  * Use this for general logging within the library.
  *
- * @example
+ * @example Using the default logger
  * ```typescript
  * import { logger } from '@hyperfrontend/project-scope/core'
  *
@@ -514,6 +160,15 @@ createScopedLogger('project-scope:fs');
  * @param code - The category code for this type of filesystem failure
  * @param context - Additional context including path, operation, and cause
  * @returns A configured Error object with code and context properties
+ *
+ * @example Creating a file system error
+ * ```typescript
+ * throw createFileSystemError(
+ *   'Cannot read file',
+ *   'FS_READ_ERROR',
+ *   { path: './missing.txt', operation: 'read' }
+ * )
+ * ```
  */
 function createFileSystemError(message, code, context) {
     const error = createError(message);
@@ -529,6 +184,14 @@ function createFileSystemError(message, code, context) {
  * @param filePath - Path to file
  * @param encoding - File encoding (default: utf-8)
  * @returns File contents or null if file doesn't exist
+ *
+ * @example Reading file if it exists
+ * ```typescript
+ * const content = readFileIfExists('./optional-config.json')
+ * if (content) {
+ *   // File existed, use content
+ * }
+ * ```
  */
 function readFileIfExists(filePath, encoding = 'utf-8') {
     if (!existsSync(filePath)) {
@@ -542,47 +205,6 @@ function readFileIfExists(filePath, encoding = 'utf-8') {
     }
 }
 
-createScopedLogger('project-scope:fs:write');
-
-/**
- * Get file stats with error handling.
- *
- * @param filePath - Path to file
- * @param followSymlinks - Whether to follow symlinks (default: true)
- * @returns File stats or null if path doesn't exist
- */
-function getFileStat(filePath, followSymlinks = true) {
-    if (!existsSync(filePath)) {
-        return null;
-    }
-    try {
-        const stat = followSymlinks ? statSync(filePath) : lstatSync(filePath);
-        return {
-            isFile: stat.isFile(),
-            isDirectory: stat.isDirectory(),
-            isSymlink: stat.isSymbolicLink(),
-            size: stat.size,
-            created: stat.birthtime,
-            modified: stat.mtime,
-            accessed: stat.atime,
-            mode: stat.mode,
-        };
-    }
-    catch {
-        return null;
-    }
-}
-/**
- * Check if path is a directory.
- *
- * @param dirPath - Path to check
- * @returns True if path is a directory
- */
-function isDirectory(dirPath) {
-    const stats = getFileStat(dirPath);
-    return stats?.isDirectory ?? false;
-}
-
 const fsDirLogger = createScopedLogger('project-scope:fs:dir');
 /**
  * List immediate contents of a directory.
@@ -591,7 +213,7 @@ const fsDirLogger = createScopedLogger('project-scope:fs:dir');
  * @returns Array of entries with metadata for each file/directory
  * @throws {Error} If directory doesn't exist or isn't a directory
  *
- * @example
+ * @example Listing directory contents
  * ```typescript
  * import { readDirectory } from '@hyperfrontend/project-scope'
  *
@@ -634,197 +256,7 @@ function readDirectory(dirPath) {
 
 createScopedLogger('project-scope:fs:traversal');
 
-/**
- * Match path against glob pattern using safe character iteration.
- * Avoids regex to prevent ReDoS attacks.
- *
- * Supported patterns:
- * - * matches any characters except /
- * - ** matches any characters including /
- * - ? matches exactly one character except /
- * - {a,b,c} matches any of the alternatives
- *
- * @param path - The filesystem path to test against the pattern
- * @param pattern - The glob pattern to match against
- * @returns True if path matches pattern
- *
- * @example
- * ```typescript
- * import { matchGlobPattern } from '@hyperfrontend/project-scope'
- *
- * matchGlobPattern('src/utils/helper.ts', '\*\*\/*.ts')     // true
- * matchGlobPattern('test.spec.ts', '\*.spec.ts')          // true
- * matchGlobPattern('config.json', '\*.{json,yaml}')       // true
- * matchGlobPattern('src/index.ts', 'src/\*.ts')           // true
- * ```
- */
-function matchGlobPattern(path, pattern) {
-    return matchSegments(path.split('/'), pattern.split('/'), 0, 0);
-}
-/**
- * Internal recursive function to match path segments against pattern segments.
- *
- * @param pathParts - Array of path segments split by '/'
- * @param patternParts - Array of pattern segments split by '/'
- * @param pathIdx - Current index in pathParts being examined
- * @param patternIdx - Current index in patternParts being examined
- * @returns True if remaining segments match
- */
-function matchSegments(pathParts, patternParts, pathIdx, patternIdx) {
-    if (pathIdx === pathParts.length && patternIdx === patternParts.length) {
-        return true;
-    }
-    if (patternIdx >= patternParts.length) {
-        return false;
-    }
-    const patternPart = patternParts[patternIdx];
-    if (patternPart === '**') {
-        for (let i = pathIdx; i <= pathParts.length; i++) {
-            if (matchSegments(pathParts, patternParts, i, patternIdx + 1)) {
-                return true;
-            }
-        }
-        return false;
-    }
-    if (pathIdx >= pathParts.length) {
-        return false;
-    }
-    const pathPart = pathParts[pathIdx];
-    if (matchSegment(pathPart, patternPart)) {
-        return matchSegments(pathParts, patternParts, pathIdx + 1, patternIdx + 1);
-    }
-    return false;
-}
-/**
- * Match a single path segment against a pattern segment.
- * Handles *, ?, and {a,b,c} patterns.
- *
- * @param text - The path segment text to match
- * @param pattern - The pattern segment to match against
- * @returns True if the text matches the pattern
- */
-function matchSegment(text, pattern) {
-    let textIdx = 0;
-    let patternIdx = 0;
-    while (patternIdx < pattern.length) {
-        const char = pattern[patternIdx];
-        if (char === '*') {
-            patternIdx++;
-            if (patternIdx === pattern.length) {
-                return true;
-            }
-            for (let i = textIdx; i <= text.length; i++) {
-                if (matchSegmentFrom(text, i, pattern, patternIdx)) {
-                    return true;
-                }
-            }
-            return false;
-        }
-        else if (char === '?') {
-            if (textIdx >= text.length) {
-                return false;
-            }
-            textIdx++;
-            patternIdx++;
-        }
-        else if (char === '{') {
-            const closeIdx = findClosingBrace(pattern, patternIdx);
-            if (closeIdx === -1) {
-                if (textIdx >= text.length || text[textIdx] !== char) {
-                    return false;
-                }
-                textIdx++;
-                patternIdx++;
-            }
-            else {
-                const alternatives = extractAlternatives(pattern.slice(patternIdx + 1, closeIdx));
-                for (const alt of alternatives) {
-                    if (matchSegmentFrom(text, textIdx, text.slice(0, textIdx) + alt + pattern.slice(closeIdx + 1), textIdx)) {
-                        return true;
-                    }
-                }
-                return false;
-            }
-        }
-        else {
-            if (textIdx >= text.length || text[textIdx] !== char) {
-                return false;
-            }
-            textIdx++;
-            patternIdx++;
-        }
-    }
-    return textIdx === text.length;
-}
-/**
- * Helper to match from a specific position.
- *
- * @param text - The full text being matched
- * @param textIdx - The starting index in text to match from
- * @param pattern - The full pattern being matched
- * @param patternIdx - The starting index in pattern to match from
- * @returns True if the text matches the pattern from the given positions
- */
-function matchSegmentFrom(text, textIdx, pattern, patternIdx) {
-    const remainingText = text.slice(textIdx);
-    const remainingPattern = pattern.slice(patternIdx);
-    return matchSegment(remainingText, remainingPattern);
-}
-/**
- * Find closing brace for {a,b,c} pattern.
- *
- * @param pattern - The pattern string to search within
- * @param startIdx - The index of the opening brace
- * @returns The index of the matching closing brace, or -1 if not found
- */
-function findClosingBrace(pattern, startIdx) {
-    let depth = 0;
-    for (let i = startIdx; i < pattern.length; i++) {
-        if (pattern[i] === '{') {
-            depth++;
-        }
-        else if (pattern[i] === '}') {
-            depth--;
-            if (depth === 0) {
-                return i;
-            }
-        }
-    }
-    return -1;
-}
-/**
- * Extract alternatives from {a,b,c} pattern content.
- *
- * @param content - The content between braces (without the braces themselves)
- * @returns Array of alternative strings split by commas at depth 0
- */
-function extractAlternatives(content) {
-    const alternatives = [];
-    let current = '';
-    let depth = 0;
-    for (let i = 0; i < content.length; i++) {
-        const char = content[i];
-        if (char === '{') {
-            depth++;
-            current += char;
-        }
-        else if (char === '}') {
-            depth--;
-            current += char;
-        }
-        else if (char === ',' && depth === 0) {
-            alternatives.push(current);
-            current = '';
-        }
-        else {
-            current += char;
-        }
-    }
-    if (current) {
-        alternatives.push(current);
-    }
-    return alternatives;
-}
+createScopedLogger('project-scope:fs:write');
 
 const walkLogger = createScopedLogger('project-scope:project:walk');
 /**
@@ -891,6 +323,18 @@ function matchPattern(path, pattern) {
  * @param startPath - Root directory to begin traversal
  * @param visitor - Callback function invoked for each file system entry
  * @param options - Configuration for traversal behavior
+ *
+ * @example Walking a directory tree
+ * ```typescript
+ * import { walkDirectory } from '@hyperfrontend/project-scope'
+ *
+ * const tsFiles: string[] = []
+ * walkDirectory('./src', (entry) => {
+ *   if (entry.isFile && entry.name.endsWith('.ts')) {
+ *     tsFiles.push(entry.relativePath)
+ *   }
+ * }, { maxDepth: 5, respectGitignore: true })
+ * ```
  */
 function walkDirectory(startPath, visitor, options) {
     walkLogger.debug('Starting directory walk', {
@@ -973,6 +417,19 @@ function walkDirectory(startPath, visitor, options) {
  * @param startPath - Root path within the tree to begin traversal
  * @param visitor - Callback function invoked for each tree entry
  * @param options - Configuration for traversal behavior
+ *
+ * @example Walking a virtual tree
+ * ```typescript
+ * import { createTree, walkTree } from '@hyperfrontend/project-scope'
+ *
+ * const tree = createTree('/workspace')
+ * walkTree(tree, 'src', (entry) => {
+ *   if (entry.isDirectory) {
+ *     console.log('Dir:', entry.relativePath)
+ *     return 'skip' // Don't recurse into this directory
+ *   }
+ * })
+ * ```
  */
 function walkTree(tree, startPath, visitor, options) {
     const maxDepth = options?.maxDepth ?? -1;
@@ -1053,7 +510,7 @@ function matchesPatterns(path, patterns) {
  * @param options - Configuration for search behavior
  * @returns List of relative file paths that match the patterns
  *
- * @example
+ * @example Finding files by pattern
  * ```typescript
  * import { findFiles } from '@hyperfrontend/project-scope'
  *
@@ -1098,6 +555,15 @@ function findFiles(startPath, patterns, options) {
  * @param patterns - Glob patterns (e.g., '*.ts', '**\/*.json') to filter files
  * @param options - Configuration for search behavior
  * @returns List of virtual file paths that match the patterns
+ *
+ * @example Finding files in a virtual tree
+ * ```typescript
+ * import { createTree, findFilesInTree } from '@hyperfrontend/project-scope'
+ *
+ * const tree = createTree('/workspace')
+ * const tsFiles = findFilesInTree(tree, '**\/*.ts', { maxDepth: 3 })
+ * // => ['src/index.ts', 'src/utils/helpers.ts']
+ * ```
  */
 function findFilesInTree(tree, patterns, options) {
     const normalizedPatterns = isArray(patterns) ? patterns : [patterns];
@@ -1125,6 +591,14 @@ function findFilesInTree(tree, patterns, options) {
  * @param patterns - Glob patterns to filter directories (supports wildcards)
  * @param options - Configuration for search behavior
  * @returns List of relative directory paths that match the patterns
+ *
+ * @example Finding directories by pattern
+ * ```typescript
+ * import { findDirectories } from '@hyperfrontend/project-scope'
+ *
+ * const componentDirs = findDirectories('./src', 'components')
+ * // => ['features/auth/components', 'features/dashboard/components']
+ * ```
  */
 function findDirectories(startPath, patterns, options) {
     const normalizedPatterns = isArray(patterns) ? patterns : [patterns];
@@ -1146,4 +620,3 @@ function findDirectories(startPath, patterns, options) {
 }
 
 export { findDirectories, findFiles, findFilesInTree, walkDirectory, walkTree };
-//# sourceMappingURL=index.esm.js.map