vfile-find-up
vfile utility to find files by searching the file system upwards.
Contents
What is this?
This utility lets you find one or many files upwards.
When should I use this?
You can use this utility if you want to find, say, a config file. If you instead want to find files downwards, such as all markdown files in a folder, you can use vfile-find-down
.
Install
This package is ESM only. In Node.js (version 14.14+ and 16.0+), install with npm:
npm install vfile-find-up
Use
import {findUp} from 'vfile-find-up'
console.log(await findUp('package.json'))
Yields:
[ VFile {
data: {},
messages: [],
history: [ '/Users/tilde/projects/oss/vfile-find-up/package.json' ],
cwd: '/Users/tilde/projects/oss/vfile-find-up' } ]
API
This package exports the identifiers BREAK
, INCLUDE
, findUp
, and findUpOne
. There is no default export.
findUp(tests[, path][, callback])
Find files or folders upwards.
👉 Note: files are not read (their
value
is not populated).
Signatures
(test[, path], callback) => void
(test[, path]) => Promise<Array<VFile>>
Parameters
test
(Test
) — things to search forpaths
(string
, default:process.cwd()
) — place to search fromcallback
(Callback
, optional) — callback called when done
Returns
Nothing when callback
is given (void
), otherwise a promise that resolves to files (Array<VFile>
).
findUpOne(test[, path][, callback])
Find the first file or folder upwards.
👉 Note: files are not read (their
value
is not populated).
Signatures
(test[, path], callback) => void
(test[, path]) => Promise<VFile>
Parameters
test
(Test
) — things to search forpath
(string
, default:process.cwd()
) — place to search fromcallback
(CallbackOne
, optional) — callback called when done
Returns
Nothing when callback
is given (void
), otherwise a promise that resolves to a file (VFile | null
).
BREAK
Stop searching (number
).
INCLUDE
Include this file (number
).
Assert
Handle a file (TypeScript type).
Parameters
file
(VFile
) — file to handle
Returns
How to handle this file (boolean | number
, optional).
true
is treated as INCLUDE
.
Callback
Callback called when done (TypeScript type).
Parameters
error
(Error | null
) — error; errors are currently never passedfiles
(Array<VFile>
) — files
Returns
Nothing (void
).
CallbackOne
Callback called when done finding one file (TypeScript type).
Parameters
error
(Error | null
) — error; errors are currently never passedfile
(VFile | null
) — file
Returns
Nothing (void
).
Test
Things to search for (TypeScript type).
For strings, the basename
or extname
of files must match them. For arrays, any test in them must match.
Type
type Test = Array<Assert | string> | Assert | string
Types
This package is fully typed with TypeScript. It exports the additional types Assert
, Callback
, CallbackOne
, and Test
.
Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
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.