History

Patrick Marsceill b7b0d0d7bf Initial commit		2017-03-09 13:16:08 -05:00
..
LICENSE	Initial commit	2017-03-09 13:16:08 -05:00
README.md	Initial commit	2017-03-09 13:16:08 -05:00
index.js	Initial commit	2017-03-09 13:16:08 -05:00
package.json	Initial commit	2017-03-09 13:16:08 -05:00

README.md

is-glob

Returns true if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a better user experience.

Also take a look at is-valid-glob and has-glob.

Install

Install with npm

$ npm i is-glob --save

Usage

var isGlob = require('is-glob');

True

Patterns that have glob characters or regex patterns will return true:

isGlob('!foo.js');
isGlob('*.js');
isGlob('**/abc.js');
isGlob('abc/*.js');
isGlob('abc/(aaa|bbb).js');
isGlob('abc/[a-z].js');
isGlob('abc/{a,b}.js');
isGlob('abc/?.js');
//=> true

Extglobs

isGlob('abc/@(a).js');
isGlob('abc/!(a).js');
isGlob('abc/+(a).js');
isGlob('abc/*(a).js');
isGlob('abc/?(a).js');
//=> true

False

Patterns that do not have glob patterns return false:

isGlob('abc.js');
isGlob('abc/def/ghi.js');
isGlob('foo.js');
isGlob('abc/@.js');
isGlob('abc/+.js');
isGlob();
isGlob(null);
//=> false

Arrays are also false (If you want to check if an array has a glob pattern, use has-glob):

isGlob(['**/*.js']);
isGlob(['foo.js']);
//=> false

has-glob: Returns true if an array has a glob pattern. | homepage
is-extglob: Returns true if a string has an extglob. | homepage
is-posix-bracket: Returns true if the given string is a POSIX bracket expression (POSIX character class). | homepage
is-valid-glob: Return true if a value is a valid glob pattern or patterns. | homepage
micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… more | homepage

Run tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

This file was generated by verb-cli on October 02, 2015.