Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including contains-path with all npm packages installed. Try it out:

var containsPath = require("contains-path")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

contains-path v1.0.0

Return true if a file path contains the given path.

contains-path NPM version NPM monthly downloads Linux Build Status Windows Build Status

Return true if a file path contains the given path.

Install

Install with npm:

$ npm install --save contains-path

Install with yarn:

$ yarn add contains-path

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('contains-path');

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 

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

CommitsContributor
2jonschlinkert
1germtb

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

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

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.5.0, on April 17, 2017.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free