Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jonschlinkert/match-file

Returns true when the given `name` matches any of the path properties on a vinyl file
https://github.com/jonschlinkert/match-file

file match micromatch vinyl

Last synced: 2 months ago
JSON representation

Returns true when the given `name` matches any of the path properties on a vinyl file

Awesome Lists containing this project

README 

        
# match-file [![NPM version](https://img.shields.io/npm/v/match-file.svg?style=flat)](https://www.npmjs.com/package/match-file) [![NPM monthly downloads](https://img.shields.io/npm/dm/match-file.svg?style=flat)](https://npmjs.org/package/match-file) [![NPM total downloads](https://img.shields.io/npm/dt/match-file.svg?style=flat)](https://npmjs.org/package/match-file) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/match-file.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/match-file)



> Returns true when the given `name` matches any of the path properties on a vinyl file.



Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.



## Install



Install with [npm](https://www.npmjs.com/):



```sh

$ npm install --save match-file

```



## Usage



```js

var matchFile = require('match-file');

```



## API



### matchFile



Returns true if the given string matches one of the path properties on the `file` object (does not match agains `file.extname` only)



```js

var File = require('vinyl');

var matchFile = require('match-file');



var file = new File({path: 'a/b/c.txt', base: 'a'});

var isMatch = matchFile('c.txt', file);

//=> true (since `c.txt` matches file.basename)

```



**Examples**



Continuing with the above setup code, all of the following would return `true`:



```js

// file.path

matchFile('a/b/c.txt', file);

// file.relative

matchFile('b/c.txt', file);

// file.basename

matchFile('c.txt', file);

// file.stem

matchFile('c', file);

```



### .isMatch



Similar to `matchFile`, but **also supports glob patterns** for matching. [micromatch](https://github.com/micromatch/micromatch) is used for matching, visit that project to see all available features and options.



```js

var file = new File({path: 'a/b/c.txt'});

console.log(matcher.isMatch('*.js', file));

//=> false



var file = new File({path: 'a/b/c.js'});

console.log(matcher.isMatch('*.js', file));

//=> true

```



#### Examples



```js

var File = require('vinyl');

var matchFile = require('match-file');



var file = new File({path: 'a/b/c/d/e.txt', base: 'a/b/c'});

file.key = 'zzz/a.txt'; // arbitrary key (for caching)

```



```js

// file.path

console.log(matchFile.isMatch('a/b/c/d/e.txt', file));

// file.relative

console.log(matchFile.isMatch('d/e.txt', file));

// file.basename

console.log(matchFile.isMatch('e.txt', file));

// file.stem

console.log(matchFile.isMatch('e', file));

// file.key

console.log(matchFile.isMatch('zzz/a.txt', file));

// glob pattern for `file.path`

console.log(matchFile.isMatch('**/*.txt', file));

// glob pattern for `file.relative`

console.log(matchFile.isMatch('d/*.txt', file));

// glob pattern for `file.stem`

console.log(matchFile.isMatch('*', file));

// glob pattern for `file.basename`

console.log(matchFile.isMatch('*.txt', file));

```



### .matcher



Returns a matcher function bound to the given glob `patterns` and `options`. [micromatch](https://github.com/micromatch/micromatch) is used for matching, visit that project to see all available features and options.



```js

var isMatch = matchFile.matcher('*.js');

console.log(isMatch);

//=> [function]



var file = new File({path: 'a/b/c.txt'});

console.log(isMatch(file));

//=> false



var file = new File({path: 'a/b/c.js'});

console.log(isMatch(file));

//=> true

```



#### Examples



Given this setup code:



```js

var File = require('vinyl');

var matchFile = require('match-file');



var file = new File({path: 'a/b/c/d/e.txt', base: 'a/b/c'});

file.key = 'zzz/a.txt'; // arbitrary key (for caching)

```



All of the following examples would return `true`:



```js

// file.path

var isMatch = matchFile.matcher('a/b/c/d/e.txt');

console.log(isMatch(file));

// file.relative

var isMatch = matchFile.matcher('d/e.txt');

console.log(isMatch(file));

// file.basename

var isMatch = matchFile.matcher('e.txt');

console.log(isMatch(file));

// file.stem

var isMatch = matchFile.matcher('e');

console.log(isMatch(file));

// file.key

var isMatch = matchFile.matcher('zzz/a.txt');

console.log(isMatch(file));

// glob pattern for `file.path`

var isMatch = matchFile.matcher('**/*.txt');

console.log(isMatch(file));

// glob pattern for `file.relative`

var isMatch = matchFile.matcher('d/*.txt');

console.log(isMatch(file));

// glob pattern for `file.stem`

var isMatch = matchFile.matcher('*');

console.log(isMatch(file));

// glob pattern for `file.basename`

var isMatch = matchFile.matcher('*.txt');

console.log(isMatch(file));

```



## Gulp usage



Use in your [gulp](http://gulpjs.com) plugin:



```js

var though = require('though2');

var gulp = require('gulp');



gulp.task('example', function() {

  return gulp.src('src/**/*')

    .pipe(filter('*.js'));

});



function filter(pattern, options) {

  // define a matcher function outside of the plugin function

  var isMatch = matchFile.matcher(pattern, options);



  return through.obj(function(file, enc, next) {

    // use the matcher function

    if (isMatch(file)) {

      next(null, file);

      return;

    }

    next();

  });

}

```



## 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

```



### Related projects



You might also be interested in these projects:



* [assemble](https://www.npmjs.com/package/assemble): Get the rocks out of your socks! Assemble makes you fast at creating web projects… [more](https://github.com/assemble/assemble) | [homepage](https://github.com/assemble/assemble "Get the rocks out of your socks! Assemble makes you fast at creating web projects. Assemble is used by thousands of projects for rapid prototyping, creating themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websit")

* [generate](https://www.npmjs.com/package/generate): Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… [more](https://github.com/generate/generate) | [homepage](https://github.com/generate/generate "Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the robustness and configurability of Yeoman, the expressiveness and simplicity of Slush, and more powerful flow control and composability than either.")

* [get-view](https://www.npmjs.com/package/get-view): Utility for getting an assemble view from a collection object. | [homepage](https://github.com/jonschlinkert/get-view "Utility for getting an assemble view from a collection object.")

* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")

* [verb](https://www.npmjs.com/package/verb): Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… [more](https://github.com/verbose/verb) | [homepage](https://github.com/verbose/verb "Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.")



### Author



**Jon Schlinkert**



* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)

* [github/jonschlinkert](https://github.com/jonschlinkert)

* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)



### License



Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).

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 February 14, 2018._