{"id":26976873,"url":"https://github.com/stdlib-js/fs-resolve-parent-paths","last_synced_at":"2025-04-03T12:17:16.897Z","repository":{"id":250640092,"uuid":"831579881","full_name":"stdlib-js/fs-resolve-parent-paths","owner":"stdlib-js","description":"Resolve paths from a set of paths by walking parent directories.","archived":false,"fork":false,"pushed_at":"2024-12-15T23:48:01.000Z","size":1314,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-20T10:47:31.950Z","etag":null,"topics":["async","dir","directory","file","find","find-up","findup","fs","javascript","node","node-js","nodejs","parent","path","resolve","search","stdlib","sync","up","upsearch"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2024-07-21T01:47:49.000Z","updated_at":"2024-12-15T23:25:43.000Z","dependencies_parsed_at":"2024-09-17T03:22:42.989Z","dependency_job_id":"ede0029f-1419-4446-a8db-280c77062f25","html_url":"https://github.com/stdlib-js/fs-resolve-parent-paths","commit_stats":null,"previous_names":["stdlib-js/fs-resolve-parent-paths"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Ffs-resolve-parent-paths","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Ffs-resolve-parent-paths/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Ffs-resolve-parent-paths/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Ffs-resolve-parent-paths/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/fs-resolve-parent-paths/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246998229,"owners_count":20866696,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","dir","directory","file","find","find-up","findup","fs","javascript","node","node-js","nodejs","parent","path","resolve","search","stdlib","sync","up","upsearch"],"created_at":"2025-04-03T12:17:16.025Z","updated_at":"2025-04-03T12:17:16.890Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2024 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# resolveParentPaths\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Resolve paths from a set of paths by walking parent directories.\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/fs-resolve-parent-paths\n```\n\nAlternatively,\n\n-   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]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   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]).\n-   To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo 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.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar resolveParentPaths = require( '@stdlib/fs-resolve-parent-paths' );\n```\n\n\u003ca name=\"resolve-parent-paths\"\u003e\u003c/a\u003e\n\n#### resolveParentPaths( paths\\[, options], clbk )\n\nAsynchronously resolves paths from a set of paths by walking parent directories.\n\n```javascript\nresolveParentPaths( [ 'package.json', 'package-lock.json' ], onPaths );\n\nfunction onPaths( error, paths ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( paths );\n    // =\u003e [...]\n}\n```\n\nThe function accepts the following `options`:\n\n-   **dir**: base directory from which to begin walking. May be either an absolute path or a path relative to the current working directory.\n\n-   **mode**: mode of operation. The following modes are supported:\n\n    -   `first`: return the first resolved path.\n    -   `some`: return one or more paths resolved within the first directory level containing a match.\n    -   `all`: return all resolved paths within the first directory level containing matches for all provided paths.\n    -   `each`: independently return the first resolved path for each path at any directory level.\n\n    Default: `'all'`.\n\nBy default, the function begins walking from the current working directory. To specify an alternative directory, set the `dir` option.\n\n```javascript\nvar opts = {\n    'dir': __dirname\n};\nresolveParentPaths( [ 'package.json' ], opts, onPaths );\n\nfunction onPaths( error, paths ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( paths );\n    // =\u003e [...]\n}\n```\n\nBy 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.\n\n```javascript\nvar opts = {\n    'dir': __dirname,\n    'mode': 'first'\n};\nresolveParentPaths( [ 'package.json', 'package-lock.json' ], opts, onPaths );\n\nfunction onPaths( error, paths ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( paths );\n    // =\u003e [...]\n}\n```\n\n#### resolveParentPaths.sync( paths\\[, options] )\n\nSynchronously resolves paths from a set of paths by walking parent directories.\n\n```javascript\nvar paths = resolveParentPaths.sync( [ 'package.json', 'README.md' ] );\n// returns [...]\n```\n\nThe function accepts the same `options` as [`resolveParentPaths()`](#resolve-parent-paths).\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   In `some` mode, the return order of asynchronously resolved paths is not guaranteed.\n-   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. \n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar resolveParentPaths = require( '@stdlib/fs-resolve-parent-paths' );\n\nvar opts = {\n    'dir': __dirname\n};\n\n/* Sync */\n\nvar out = resolveParentPaths.sync( [ 'package.json', 'README.md' ], opts );\n// returns [...]\n\nout = resolveParentPaths.sync( [ 'non_existent_basename' ], opts );\n// returns []\n\nopts.mode = 'first';\nout = resolveParentPaths.sync( [ 'non_existent_basename', 'package.json' ], opts );\n// returns [...]\n\n/* Async */\n\nresolveParentPaths( [ 'package.json', 'README.md' ], opts, onPaths );\nresolveParentPaths( [ './../non_existent_path' ], onPaths );\n\nfunction onPaths( error, paths ) {\n    if ( error ) {\n        throw error;\n    }\n    console.log( paths );\n}\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n* * *\n\n\u003csection class=\"cli\"\u003e\n\n## CLI\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\nTo use as a general utility, install the CLI package globally\n\n```bash\nnpm install -g @stdlib/fs-resolve-parent-paths-cli\n```\n\n\u003c/section\u003e\n\n\u003c!-- CLI usage documentation. --\u003e\n\n\u003csection class=\"usage\"\u003e\n\n### Usage\n\n```text\nUsage: resolve-parent-paths [options] \u003cpath\u003e [\u003cpath\u003e...]\n\nOptions:\n\n  -h,    --help                Print this message.\n  -V,    --version             Print the package version.\n         --dir dir             Base search directory.\n         --mode mode           Mode of operation.\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n### Examples\n\n```bash\n$ resolve-parent-paths package.json package-lock.json\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.cli --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2024. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/fs-resolve-parent-paths.svg\n[npm-url]: https://npmjs.org/package/@stdlib/fs-resolve-parent-paths\n\n[test-image]: https://github.com/stdlib-js/fs-resolve-parent-paths/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/fs-resolve-parent-paths/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/fs-resolve-parent-paths?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/fs-resolve-parent-paths.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/fs-resolve-parent-paths/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[cli-section]: https://github.com/stdlib-js/fs-resolve-parent-paths#cli\n[cli-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/cli\n[@stdlib/fs-resolve-parent-paths]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/main\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/deno\n[deno-readme]: https://github.com/stdlib-js/fs-resolve-parent-paths/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/umd\n[umd-readme]: https://github.com/stdlib-js/fs-resolve-parent-paths/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/tree/esm\n[esm-readme]: https://github.com/stdlib-js/fs-resolve-parent-paths/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/fs-resolve-parent-paths/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/fs-resolve-parent-paths/main/LICENSE\n\n[node-core-path-resolve]: https://nodejs.org/api/path.html#path_path_resolve_paths\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Ffs-resolve-parent-paths","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Ffs-resolve-parent-paths","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Ffs-resolve-parent-paths/lists"}