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.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb, v0.9.0, on July 18, 2016.