.verb.md

April 17, 2017 ยท View on GitHub

HEADS UP!

As of v1.0.0, this library no longer uses regex for matching. Please do not hesitate to report any issues or regressiosn.

Usage

var containsPath = require('{%= name %}');

containsPath('foo/bar', 'foo'); //=> true
containsPath('foo/bar', 'bar'); //=> true
containsPath('foo/bar', 'qux'); //=> false

// returns false for partial matches
containsPath('foobar', 'foo');  //=> false
containsPath('foo.bar', 'foo'); //=> false
containsPath('foo.bar', 'bar'); //=> false

// prefix with "./" to match from beginning of filepath
containsPath('bar/foo', 'foo');   //=> true
containsPath('bar/foo', './foo'); //=> false

Negation

Prefix with ! to invert matching behavior:

containsPath('foo/bar', '!foo'); //=> false
containsPath('foo/bar', '!qux'); //=> true

Options

options.nocase

Type: boolean

Default: false

Disable case sensitivity.

containsPath('foo/bar', 'FOO');                 //=> false
containsPath('foo/bar', 'FOO', {nocase: true}); //=> true

options.partialMatch

Type: boolean

Default: false

Allow "partial" matches:

containsPath('foobar', 'foo');                        //=> false                 
containsPath('foobar', 'foo', {partialMatch: true});  //=> true 

containsPath('foo.bar', 'foo');                       //=> false                 
containsPath('foo.bar', 'foo', {partialMatch: true}); //=> true