Gets the first matching path from an array of file paths.
Please consider following this project's author, Brian Woodward, and consider starring the project to show your ❤️ and support.
Install with npm:
$ npm install --save find-pathconst findPath = require('find-path');
findPath(filename, paths, options);Params
filenameThe filename or path to match. Passed to path-ends-with.paths- an array of filepaths to match against.- options
Example
const paths = findPath('foo.md', ['a/b/c/foo.md', 'a/b/c/bar.md']);
console.log(paths);
//=> ['a/b/c/foo.md'];Type: boolean
Default: undefined
Returns all of matched paths instead of only the first match.
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']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
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']Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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:
$ npm install && npm testBuilding docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbBrian Woodward
Copyright © 2018, Brian Woodward. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on March 28, 2018.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent