https://github.com/stdlib-js/fs-resolve-parent-paths
Resolve paths from a set of paths by walking parent directories.
https://github.com/stdlib-js/fs-resolve-parent-paths
async dir directory file find find-up findup fs javascript node node-js nodejs parent path resolve search stdlib sync up upsearch
Last synced: 2 months ago
JSON representation
Resolve paths from a set of paths by walking parent directories.
- Host: GitHub
- URL: https://github.com/stdlib-js/fs-resolve-parent-paths
- Owner: stdlib-js
- License: apache-2.0
- Created: 2024-07-21T01:47:49.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-15T23:48:01.000Z (6 months ago)
- Last Synced: 2025-03-20T10:47:31.950Z (3 months ago)
- Topics: async, dir, directory, file, find, find-up, findup, fs, javascript, node, node-js, nodejs, parent, path, resolve, search, stdlib, sync, up, upsearch
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.25 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# resolveParentPaths
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Resolve paths from a set of paths by walking parent directories.
## Installation
```bash
npm install @stdlib/fs-resolve-parent-paths
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
- To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var resolveParentPaths = require( '@stdlib/fs-resolve-parent-paths' );
```
#### resolveParentPaths( paths\[, options], clbk )
Asynchronously resolves paths from a set of paths by walking parent directories.
```javascript
resolveParentPaths( [ 'package.json', 'package-lock.json' ], onPaths );
function onPaths( error, paths ) {
if ( error ) {
throw error;
}
console.log( paths );
// => [...]
}
```
The function accepts the following `options`:
- **dir**: base directory from which to begin walking. May be either an absolute path or a path relative to the current working directory.
- **mode**: mode of operation. The following modes are supported:
- `first`: return the first resolved path.
- `some`: return one or more paths resolved within the first directory level containing a match.
- `all`: return all resolved paths within the first directory level containing matches for all provided paths.
- `each`: independently return the first resolved path for each path at any directory level.
Default: `'all'`.
By default, the function begins walking from the current working directory. To specify an alternative directory, set the `dir` option.
```javascript
var opts = {
'dir': __dirname
};
resolveParentPaths( [ 'package.json' ], opts, onPaths );
function onPaths( error, paths ) {
if ( error ) {
throw error;
}
console.log( paths );
// => [...]
}
```
By default, the function requires that a directory contains matches for all provided paths before returning results. To specify an alternative operation mode, set the `mode` option.
```javascript
var opts = {
'dir': __dirname,
'mode': 'first'
};
resolveParentPaths( [ 'package.json', 'package-lock.json' ], opts, onPaths );
function onPaths( error, paths ) {
if ( error ) {
throw error;
}
console.log( paths );
// => [...]
}
```
#### resolveParentPaths.sync( paths\[, options] )
Synchronously resolves paths from a set of paths by walking parent directories.
```javascript
var paths = resolveParentPaths.sync( [ 'package.json', 'README.md' ] );
// returns [...]
```
The function accepts the same `options` as [`resolveParentPaths()`](#resolve-parent-paths).
## Notes
- In `some` mode, the return order of asynchronously resolved paths is not guaranteed.
- This implementation is **not** similar in functionality to core [`path.resolve`][node-core-path-resolve]. The latter performs string manipulation to generate a full path. This implementation walks parent directories to perform a **search**, thereby touching the file system. Accordingly, this implementation resolves _real_ absolute file paths and is intended for use when a target's location in a parent directory is unknown relative to a child directory; e.g., when wanting to find a package root from deep within a package directory.
## Examples
```javascript
var resolveParentPaths = require( '@stdlib/fs-resolve-parent-paths' );
var opts = {
'dir': __dirname
};
/* Sync */
var out = resolveParentPaths.sync( [ 'package.json', 'README.md' ], opts );
// returns [...]
out = resolveParentPaths.sync( [ 'non_existent_basename' ], opts );
// returns []
opts.mode = 'first';
out = resolveParentPaths.sync( [ 'non_existent_basename', 'package.json' ], opts );
// returns [...]
/* Async */
resolveParentPaths( [ 'package.json', 'README.md' ], opts, onPaths );
resolveParentPaths( [ './../non_existent_path' ], onPaths );
function onPaths( error, paths ) {
if ( error ) {
throw error;
}
console.log( paths );
}
```
* * *
## CLI
## Installation
To use as a general utility, install the CLI package globally
```bash
npm install -g @stdlib/fs-resolve-parent-paths-cli
```
### Usage
```text
Usage: resolve-parent-paths [options] [...]
Options:
-h, --help Print this message.
-V, --version Print the package version.
--dir dir Base search directory.
--mode mode Mode of operation.
```
### Examples
```bash
$ resolve-parent-paths package.json package-lock.json
```
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/fs-resolve-parent-paths.svg
[npm-url]: https://npmjs.org/package/@stdlib/fs-resolve-parent-paths
[test-image]: https://github.com/stdlib-js/fs-resolve-parent-paths/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/fs-resolve-parent-paths/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/fs-resolve-parent-paths?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[cli-section]: https://github.com/stdlib-js/fs-resolve-parent-paths#cli
[cli-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/cli
[@stdlib/fs-resolve-parent-paths]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/deno
[deno-readme]: https://github.com/stdlib-js/fs-resolve-parent-paths/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/umd
[umd-readme]: https://github.com/stdlib-js/fs-resolve-parent-paths/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/esm
[esm-readme]: https://github.com/stdlib-js/fs-resolve-parent-paths/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/fs-resolve-parent-paths/main/LICENSE
[node-core-path-resolve]: https://nodejs.org/api/path.html#path_path_resolve_paths