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.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

1$ npm install --save is-glob

You might also be interested in is-valid-glob and has-glob.

Usage

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

Default behavior

True

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

1isGlob('!foo.js');
2isGlob('*.js');
3isGlob('**/abc.js');
4isGlob('abc/*.js');
5isGlob('abc/(aaa|bbb).js');
6isGlob('abc/[a-z].js');
7isGlob('abc/{a,b}.js');
8//=> true

Extglobs

1isGlob('abc/@(a).js');
2isGlob('abc/!(a).js');
3isGlob('abc/+(a).js');
4isGlob('abc/*(a).js');
5isGlob('abc/?(a).js');
6//=> true

False

Escaped globs or extglobs return false:

1isGlob('abc/\\@(a).js');
2isGlob('abc/\\!(a).js');
3isGlob('abc/\\+(a).js');
4isGlob('abc/\\*(a).js');
5isGlob('abc/\\?(a).js');
6isGlob('\\!foo.js');
7isGlob('\\*.js');
8isGlob('\\*\\*/abc.js');
9isGlob('abc/\\*.js');
10isGlob('abc/\\(aaa|bbb).js');
11isGlob('abc/\\[a-z].js');
12isGlob('abc/\\{a,b}.js');
13//=> false

Patterns that do not have glob patterns return false:

1isGlob('abc.js');
2isGlob('abc/def/ghi.js');
3isGlob('foo.js');
4isGlob('abc/@.js');
5isGlob('abc/+.js');
6isGlob('abc/?.js');
7isGlob();
8isGlob(null);
9//=> false

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

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

Option strict

When options.strict === false the behavior is less strict in determining if a pattern is a glob. Meaning that some patterns that would return false may return true. This is done so that matching libraries like micromatch have a chance at determining if the pattern is a glob or not.

True

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

1isGlob('!foo.js', {strict: false});
2isGlob('*.js', {strict: false});
3isGlob('**/abc.js', {strict: false});
4isGlob('abc/*.js', {strict: false});
5isGlob('abc/(aaa|bbb).js', {strict: false});
6isGlob('abc/[a-z].js', {strict: false});
7isGlob('abc/{a,b}.js', {strict: false});
8//=> true

Extglobs

1isGlob('abc/@(a).js', {strict: false});
2isGlob('abc/!(a).js', {strict: false});
3isGlob('abc/+(a).js', {strict: false});
4isGlob('abc/*(a).js', {strict: false});
5isGlob('abc/?(a).js', {strict: false});
6//=> true

False

Escaped globs or extglobs return false:

1isGlob('\\!foo.js', {strict: false});
2isGlob('\\*.js', {strict: false});
3isGlob('\\*\\*/abc.js', {strict: false});
4isGlob('abc/\\*.js', {strict: false});
5isGlob('abc/\\(aaa|bbb).js', {strict: false});
6isGlob('abc/\\[a-z].js', {strict: false});
7isGlob('abc/\\{a,b}.js', {strict: false});
8//=> false

About

1$ npm install && npm test

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

• assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
• base: Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks | homepage
• update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributors

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

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

This file was generated by verb-generate-readme, v0.8.0, on March 27, 2019.