vfile-find-up

Find vfiles by searching the file system upwards.

Install

npm install vfile-find-up

Use

var findUp = require('vfile-find-up')

findUp.all('package.json', console.log)

Yields:

null [ VFile {
  data: {},
  messages: [],
  history: [ '/Users/tilde/projects/oss/vfile-find-up/package.json' ],
  cwd: '/Users/tilde/projects/oss/vfile-find-up' } ]

API

`findUp.all(tests[, path], callback)`

Search for tests upwards. Invokes callback with either an error or an array of files passing tests. Note: Virtual Files are not read (their contents is not populated).

Parameters

`tests`

Things to search for (string, Function, or Array.<tests>).

If a string is passed in, the basename or extname of files must match it for them to be included.

If an array is passed in, any test must match a given file for it to be included.

Otherwise, they must be function.

`path`

Place to searching from (string, default: process.cwd()).

`callback`

Function invoked with all matching files (function cb(err[, files])).

`findUp.one(tests[, path], callback)`

Like findUp.all, but invokes callback with the first found file, or null.

`function test(file)`

Check whether a virtual file should be included. Invoked with a vfile.

Returns

true or findUp.INCLUDE — Include the file in the results
findUp.BREAK — Stop searching for files
anything else is ignored: the file is not included

The different flags can be combined by using the pipe operator: findUp.INCLUDE | findUp.BREAK.

Contribute

See contributing.md in vfile/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

Current Tags

5.0.1 ... latest (6 years ago)

2 Versions

5.0.1 ... 6 years ago
1.0.0 ... 10 years ago