find-file-up

find-file-up

Find a file, starting with the given cwd and recursively searching up one directory until it's found (or we run out of directories). Async and sync.

Install

Install with npm:

$ npm install --save find-file-up

Usage

var findFile = require('find-file-up');

async

// find `foo.txt` starting at the given directory
findFile('foo.txt', '.', function(err, fp) {
  //=> /Users/jonschlinkert/dev/find-file-up/fixtures/foo.txt
});

// search user home
findFile('foo.txt', '~/', function(err, fp) {
  //=> /Users/jonschlinkert/foo.txt
});

sync

var file = findFile.sync('foo.txt', 'a/b/c/');

About

Related projects

• find-pkg: Find the first directory with a package.json, recursing up, starting with the given directory. Similar… more | homepage
• findup-sync: Find the first file matching a given pattern in the current directory or the nearest… more | homepage
• global-modules: The directory used by npm for globally installed npm modules. | homepage
• global-prefix: Get the npm global path prefix. | homepage
• load-module-pkg: Load the package.json for any project currently installed in node_modules. | homepage
• load-pkg: Loads the package.json from the root of the user's current project. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
19	jonschlinkert
1	pointnet

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on May 19, 2017.