Spaces:
Sleeping
Sleeping
File size: 3,053 Bytes
df9fdc8 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | [](http://travis-ci.org/choojs/findup)
@choojs/findup
=======
> This is a fork of [Filirom1/findup](https://github.com/Filirom1/findup), pending [#16](https://github.com/Filirom1/findup/pull/16).
### Install
```sh
npm install -g @choojs/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`
```js
var findup = require('@choojs/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
```js
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)
```js
var findup = require('@choojs/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`
```js
var findup = require('@choojs/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.
```js
fup.on('found', function(dir){
// dir === '/f/e/d/c'
fup.stop();
});
```
`error` event is emitted when error happens
```js
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.
```js
fup.on('end', function(){
// happy end
});
```
#### Sync
findup(dir, fileName)
findup(dir, iteratorSync) with `iteratorSync` return `true` or `false`
```js
var findup = require('@choojs/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
```js
npm install -g @choojs/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 :)
|