filirom1 / findup

Walk up ancester's dirs up to root

Find-up

Install

npm install -g findup

Usage

Find up a file in ancestor's dir

.
├── config.json
└── f
    └── e
        └── d
            └── c
                ├── b
                │   └── a
                └── config.json

Options

• maxdepth: (Number, default -1) How far to traverse before giving up. If maxdepth is -1, then there is no limit.

Async

findup(dir, fileName, options, callback) findup(dir, iterator, options, callback) with iterator(dir, cb) where cb only accept true or false

var findup = require('findup');


findup(__dirname + '/f/e/d/c/b/a', 'config.json', function(err, dir){
  // if(e) e === new Error('not found')
  // dir === '/f/e/d/c'
});

or

findup(__dirname + '/f/e/d/c/b/a', function(dir, cb){
  require('path').exists(dir + '/config.json', cb);
}, function(err, dir){
  // if(e) e === new Error('not found')
  // dir === '/f/e/d/c'
});

EventEmitter

findup(dir, fileName, options)

var findup = require('findup');
var fup = findup(__dirname + '/f/e/d/c/b/a', 'config.json');

findup(dir, iterator, options) with iterator(dir, cb) where cb only accept true or false

var findup = require('findup');
var fup = findup(__dirname + '/f/e/d/c/b/a', function(dir, cb){
  require('path').exists(dir + '/config.json', cb);
});

findup return an EventEmitter. 3 events are emitted: found, error, end

found event is emitted each time a file is found.

You can stop the traversing by calling stop manually.

fup.on('found', function(dir){
  // dir === '/f/e/d/c'
  fup.stop();
});

error event is emitted when error happens

fup.on('error', function(e){
  // if(e) e === new Error('not found')
});

end event is emitted at the end of the traversing or after stop() is called.

fup.on('end', function(){
  // happy end
});

Sync

findup(dir, fileName) findup(dir, iteratorSync) with iteratorSync return true or false

var findup = require('findup');

try{
  var dir = findup.sync(__dirname + '/f/e/d/c/b/a', 'config.json'); // dir === '/f/e/d/c'
}catch(e){
  // if(e) e === new Error('not found')
}

CLI

npm install -g findup

$ cd test/fixture/f/e/d/c/b/a/
$ findup package.json
/root/findup/package.json

Usage

$ findup -h

Usage: findup [FILE]

    --name, -n       The name of the file to found
    --dir, -d        The directoy where we will start walking up    $PWD
    --help, -h       show usage                                     false
    --verbose, -v    print log                                      false

LICENSE MIT

Read the tests :)

findup's Issues

Endless loop on Windows

function check() {
  console.log(dir);
  return false;
}

findup(process.cwd(), check, cb);

cb is never called. Instead the output is:

C:\
C:\
C:\
C:\
C:\
C:\
...

This also happens if I define the file via string, e.g. 'config.json'.

I didn't test it on Mac but my guess is that this is a Windows thing.

Bump and publish

Could you please bump the package version, and then publish it?

Split CLI from library

Currently findup has a hard dependency on commander just for the CLI tool, which most projects that depend on findup probably don't need. It would be awesome if the CLI tool (or the library code) could be extracted into it's own project so that the commander dependency is only used when installing the CLI tool.

Is findup still being maintained?

Hi I would like to use this library as a dependency but it seems like it has not be maintained in a while - are you planning to continue the development of findup?

.config/file.ext

As more and more tools have become best-practice when authoring npm modules, from package.json to .*rc to *file.js, the root directory of projects has become a very loud place. This dot-noise pushes README content farther and farther down the main page of git repos.

What if the above could optionally be simplified to the following?

This is a simple example and that's already about a 30% vertical space savings. I started the conversation over in the npm repo, but I'm also submitting issues to the findup-sync, karma, travis-ci and zuul repos.

maximum search depth

Is adding an option that lets you choose how far to look up the tree before giving up a good idea? I'd be willing to create a PR for it.

update dependencies?

Could you please update dependencies and make a release? Its fetching quite an old-version of [email protected]

Comparison of file paths shouldn't use raw strings

The path modules normalises strings to the operating system (e.g. / is replaced by \\ on windows).

Therefore comparing paths by using string comparison is dangerous, I think this may be the cause of issue #17.

Possibly using https://nodejs.org/api/path.html#path_path_relative_from_to may be a more robust to compare file paths.

Endless loop on windows and FindUp.sync

Related to: #4 and #5
Got that bug while working with gulp-rtlcss and tracked it down:
https://github.com/Filirom1/findup/blob/master/index.js#L96
Demo repo: https://github.com/mgreter/bug-gulp-rtl-with-cwd

update nopt dependency

why just don't using "nopt" : "semver"

Release new version with fix for #4

Still maintained?

Hi,

Is findup still being maintained?

There's a lot of small changes that would be really great to have merged.