find-path

find-path

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 :heart: and support.

Install

Install with npm:

$ npm install --save find-path

Usage

const findPath = require('find-path');
findPath(filename, paths, options);

Params

• filename The 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'];

Options

options.all

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']

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

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.

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 test

Building 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 && verb

Author

Brian Woodward

• LinkedIn Profile
• GitHub Profile
• Twitter Profile

License

Copyright © 2018, Brian Woodward. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on March 28, 2018.