You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

57 lines
2.1 KiB

4 years ago
  1. <p align="center">
  2. <a href="http://gulpjs.com">
  3. <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
  4. </a>
  5. </p>
  6. # findup-sync
  7. [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Travis Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
  8. Find the first file matching a given pattern in the current directory or the nearest ancestor directory.
  9. Matching is done with [micromatch][micromatch], please report any matching related issues on that repository.
  10. ## Usage
  11. ```js
  12. var findup = require('findup-sync');
  13. findup(patternOrPatterns [, micromatchOptions]);
  14. // Start looking in the CWD.
  15. var filepath1 = findup('{a,b}*.txt');
  16. // Start looking somewhere else, and ignore case (probably a good idea).
  17. var filepath2 = findup('{a,b}*.txt', {cwd: '/some/path', nocase: true});
  18. ```
  19. ## API
  20. ### `findup(patterns, [options])`
  21. * `patterns` **{String|Array}**: Glob pattern(s) or file path(s) to match against.
  22. * `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.
  23. * `returns` **{String}**: Returns the first matching file.
  24. ## License
  25. MIT
  26. [micromatch]: http://github.com/jonschlinkert/micromatch
  27. [downloads-image]: http://img.shields.io/npm/dm/findup-sync.svg
  28. [npm-url]: https://www.npmjs.com/package/findup-sync
  29. [npm-image]: http://img.shields.io/npm/v/findup-sync.svg
  30. [travis-url]: https://travis-ci.org/gulpjs/findup-sync
  31. [travis-image]: http://img.shields.io/travis/gulpjs/findup-sync.svg?label=travis-ci
  32. [appveyor-url]: https://ci.appveyor.com/project/gulpjs/findup-sync
  33. [appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/findup-sync.svg?label=appveyor
  34. [coveralls-url]: https://coveralls.io/r/gulpjs/findup-sync
  35. [coveralls-image]: http://img.shields.io/coveralls/gulpjs/findup-sync/master.svg
  36. [gitter-url]: https://gitter.im/gulpjs/gulp
  37. [gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg