findup-sync
Advanced tools
Package description
The findup-sync npm package is used to search for files or directories by name in the file system, starting from a given directory and moving up the directory tree until a match is found or the root is reached. It is particularly useful for finding configuration files or other resources that may be located at various levels of a directory structure.
Find a file or directory by name
This feature allows you to find a file or directory by its name. The function will start searching from the current directory and move up the directory tree until it finds a match or reaches the root.
const findupSync = require('findup-sync');
const path = findupSync('filename.ext');Use a glob pattern to find files or directories
This feature enables the use of glob patterns to find files or directories. It will return the first match found when searching up the directory tree.
const findupSync = require('findup-sync');
const path = findupSync('*.ext');Specify a custom starting directory
With this feature, you can specify a custom starting directory from which the search will begin, rather than using the current working directory.
const findupSync = require('findup-sync');
const path = findupSync('filename.ext', { cwd: '/starting/directory' });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 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 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.
Readme
Find the first file matching a given pattern in the current directory or the nearest ancestor directory.
Install the module with: npm install findup-sync
var findup = require('findup-sync');
// 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});
findup(patternOrPatterns [, minimatchOptions])
Type: String or Array
Default: none
One or more wildcard glob patterns. Or just filenames.
Type: Object
Default: {}
Options to be passed to minimatch.
Note that if you want to start in a different directory than the current working directory, specify a cwd property here.
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
2014-03-14 - v0.1.3 - Updated dependencies.
2013-03-08 - v0.1.2 - Updated dependencies. Fixed a Node 0.9.x bug. Updated unit tests to work cross-platform.
2012-11-15 - v0.1.1 - Now works without an options object.
2012-11-01 - v0.1.0 - Initial release.
FAQs
Find the first file matching a given pattern in the current directory or the nearest ancestor directory.
We found that findup-sync demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.