findup-sync

findup-sync

Find the first file matching a given pattern in the current directory or the nearest ancestor directory.

Matching is done with micromatch, please report any matching related issues on that repository.

Usage

var findup = require('findup-sync');
findup(patternOrPatterns [, micromatchOptions]);

// Start looking in the CWD.
var filepath1 = findup('{a,b}*.txt');

// Start looking somewhere else, and ignore case (probably a good idea).
var filepath2 = findup('{a,b}*.txt', {cwd: '/some/path', nocase: true});

API

findup(patterns, [options])

• patterns {String|Array}: Glob pattern(s) or file path(s) to match against.
• options {Object}: Options to pass to micromatch. Note that if you want to start in a different directory than the current working directory, specify a cwd property here.
• returns {String}: Returns the first matching file.

License

MIT

Changelog

5.0.0 (2021-10-24)

⚠ BREAKING CHANGES

• Normalize repository, dropping node <10.13 support (#52)

Miscellaneous Chores

• Normalize repository, dropping node <10.13 support (#52) (b62b918)

Similar packages

Other packages similar to findup-sync

glob

The 'glob' package allows for pattern matching based on the rules used by the shell (e.g., bash). It's similar to findup-sync in that it can search for files, but it does not have the built-in functionality to search up the directory tree.

globby

Globby is a wrapper around 'glob' that supports multiple patterns and provides a Promise API. It's similar to findup-sync in terms of searching for files using patterns, but like 'glob', it does not natively support searching up the directory tree.

locate-path

Locate-path is designed to find a file or directory by walking up parent directories. It's similar to findup-sync but offers a Promise-based API and is more minimalistic.