www.aleph1.co.uk Git - yaffs-website/blob - node_modules/findup-sync/README.md

   1 # findup-sync  [![Build Status](https://travis-ci.org/js-cli/node-findup-sync.svg)](https://travis-ci.org/js-cli/node-findup-sync)  [![NPM version](https://badge.fury.io/js/findup-sync.svg)](http://badge.fury.io/js/findup-sync)
   2
   3 > Find the first file matching a given pattern in the current directory or the nearest ancestor directory.
   4
   5 Matching is done with [micromatch][], please report any matching related issues on that repository.
   6
   7 ## Install with [npm](npmjs.org)
   8
   9 ```bash
  10 npm i findup-sync --save
  11 ```
  12
  13 ## Usage
  14
  15 ```js
  16 var findup = require('findup-sync');
  17 findup(patternOrPatterns [, micromatchOptions]);
  18
  19 // Start looking in the CWD.
  20 var filepath1 = findup('{a,b}*.txt');
  21
  22 // Start looking somewhere else, and ignore case (probably a good idea).
  23 var filepath2 = findup('{a,b}*.txt', {cwd: '/some/path', nocase: true});
  24 ```
  25
  26 * `patterns` **{String|Array}**: Glob pattern(s) or file path(s) to match against.
  27 * `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.
  28 * `returns` **{String}**: Returns the first matching file.
  29
  30 ## Running tests
  31
  32 Install dev dependencies:
  33
  34 ```bash
  35 npm i -d && npm test
  36 ```
  37
  38 ## Contributing
  39
  40 In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/)
  41
  42 For bugs and feature requests, [please create an issue](https://github.com/cowboy/node-findup-sync/issues).
  43
  44 ## Release History
  45
  46 2015-01-30 - v0.4.0 - Refactored, not also uses [micromatch][] instead of minimatch.
  47 2015-09-14 - v0.3.0 - updated glob to ~5.0.
  48 2014-12-17 - v0.2.1 - Updated to glob 4.3.
  49 2014-12-16 - v0.2.0 - Removed lodash, updated to glob 4.x.
  50 2014-03-14 - v0.1.3 - Updated dependencies.
  51 2013-03-08 - v0.1.2 - Updated dependencies. Fixed a Node 0.9.x bug. Updated unit tests to work cross-platform.
  52 2012-11-15 - v0.1.1 - Now works without an options object.
  53 2012-11-01 - v0.1.0 - Initial release.
  54
  55 ## Authors
  56
  57 **"Cowboy" Ben Alman**
  58
  59 + [github/cowboy](https://github.com/cowboy)
  60 + [twitter/cowboy](http://twitter.com/cowboy)
  61
  62 ## License
  63
  64 Copyright (c) 2012-2016 "Cowboy" Ben Alman
  65 Released under the MIT license
  66
  67 [micromatch]: http://github.com/jonschlinkert/micromatch