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

Install with yarn:

$ yarn add bash-match

Usage

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

API

bash

Returns true if str matches the given pattern.

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}

Example

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

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

.isMatch

.isMatch

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

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}

Example

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

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

.match

.match

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

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}

Example

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

About

Related projects

• bash-glob: Bash-powered globbing for node.js | homepage
• braces: Fast, comprehensive, bash-like brace expansion implemented in JavaScript. Complete support for the Bash 4.3 braces… more | homepage
• micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | homepage
• nanomatch: Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash… more | homepage

Contributing

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

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

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

• github/jonschlinkert
• twitter/jonschlinkert

License

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

This file was generated by verb-generate-readme, v0.6.0, on April 27, 2017.