bash-match

bash-match

Match strings using bash. Does not work on windows, and does not read from the file system. This library requires that Bash 4.3 or higher is installed and is mostly used for checking parity in unit tests.

Install

Install with npm:

$ npm install --save bash-match

Usage

var bash-match = require('bash-match');

API

bash

Returns true if str matches the given pattern.

Example

var bash = require('bash-match');
console.log(bash('foo', 'f*'));
//=> true

console.log(bash('foo', 'b*'));
//=> false

Params

• str {String}
• pattern {String}
• options {Options}: Set strictErrors to true to throw when bash throws an error. Otherwise it just returns false.
• returns {Boolean}

.isMatch

Returns true if str matches the given pattern. Alias for the main export.

Example

var bash = require('bash-match');
console.log(bash.isMatch('foo', 'f*'));
//=> true

console.log(bash.isMatch('foo', 'b*'));
//=> false

Params

• str {String}
• pattern {String}
• options {Options}: Set strictErrors to true to throw when bash throws an error. Otherwise it just returns false.
• returns {Boolean}

.match

Takes a list of strings and a glob pattern, and returns an array of strings that match the pattern.

Example

var bash = require('bash-match');
console.log(bash.match(['foo', 'bar'], 'b*'));
//=> ['bar']

Params

• array {Array}: List of strings to match
• pattern {String}: Glob pattern
• options {Options}: Set strictErrors to true to throw when bash throws an error. Otherwise it just returns false.
• returns {Boolean}

About

Contributing

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

Please read the contributing guide for avice on opening issues, pull requests, and coding standards.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb-generate-readme, v0.1.31, on October 17, 2016.