https://github.com/doowb/find-path
Given a search string and a list of file paths, find the closest path.
https://github.com/doowb/find-path
ends-with find path path-ends-with search shortest-path
Last synced: 10 months ago
JSON representation
Given a search string and a list of file paths, find the closest path.
- Host: GitHub
- URL: https://github.com/doowb/find-path
- Owner: doowb
- License: mit
- Created: 2014-03-22T16:09:47.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2018-04-30T18:27:09.000Z (over 7 years ago)
- Last Synced: 2024-10-10T13:30:57.868Z (about 1 year ago)
- Topics: ends-with, find, path, path-ends-with, search, shortest-path
- Language: JavaScript
- Size: 12.7 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# find-path [](https://www.npmjs.com/package/find-path) [](https://npmjs.org/package/find-path) [](https://npmjs.org/package/find-path) [](https://travis-ci.org/doowb/find-path)
> Gets the first matching path from an array of file paths.
Please consider following this project's author, [Brian Woodward](https://github.com/doowb), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save find-path
```
## Usage
```js
const findPath = require('find-path');
findPath(filename, paths, options);
```
**Params**
* `filename` The filename or path to match. Passed to [path-ends-with](https://github.com/jonschlinkert/path-ends-with).
* `paths` - an array of filepaths to match against.
* [options](#options)
**Example**
```js
const paths = findPath('foo.md', ['a/b/c/foo.md', 'a/b/c/bar.md']);
console.log(paths);
//=> ['a/b/c/foo.md'];
```
## Options
### options.all
**Type**: `boolean`
**Default**: `undefined`
Returns all of matched paths instead of only the first match.
```js
const paths = [
'foo/bar/baz/about.md',
'foo/bar/baz/index.md',
'foo/bar/index.md',
'foo/bar/about.md',
'foo/bar/quux.md',
'foo/index.md',
];
console.log(findPath('index.md', paths));
//=> ['foo/bar/baz/index.md']
console.log(findPath('index.md', paths, { all: true }));
//=> ['foo/index.md', 'foo/bar/index.md', 'foo/bar/baz/index.md']
```
### options.shortest
**Type**: `boolean`
**Default**: `undefined`
Sorts paths so that the first matching path with the fewest directory segments is returned. (note that `options.all` is disabled when `options.shortest` is true).
**Example**
```js
const paths = [
'foo/bar/baz/about.md',
'foo/bar/baz/index.md',
'foo/bar/index.md',
'foo/bar/about.md',
'foo/bar/quux.md',
'foo/index.md',
];
console.log(findPath('index.md', paths));
//=> ['foo/bar/baz/index.md']
console.log(findPath('index.md', paths, { shortest: true }));
//=> ['foo/index.md']
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Author
**Brian Woodward**
* [LinkedIn Profile](https://linkedin.com/in/woodwardbrian)
* [GitHub Profile](https://github.com/doowb)
* [Twitter Profile](https://twitter.com/doowb)
### License
Copyright © 2018, [Brian Woodward](http://github.com/doowb).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 28, 2018._