Socket
Socket
Sign inDemoInstall

findup-sync

Package Overview
Dependencies
19
Maintainers
5
Versions
16
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

findup-sync

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

    5.0.0latest
    GitHub
    npm

Version published
Maintainers
5
Weekly downloads
7,389,318
decreased by-13.28%

Weekly downloads

Package description

What is findup-sync?

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.

What are findup-sync's main functionalities?

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' });

Other packages similar to findup-sync

Changelog

Source

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)

Readme

Source

findup-sync

NPM version Downloads Build Status Coveralls Status

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

Keywords

FAQs

Last updated on 31 Oct 2021

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc