Have ideas to improve npm?Join in the discussion! »

    is-glob
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/is-glob package

    4.0.1 • Public • Published

    is-glob NPM version NPM monthly downloads NPM total downloads Linux Build Status Windows Build Status

    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 ❤️ and support.

    Install

    Install with npm:

    $ npm install --save is-glob

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

    Usage

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

    Default behavior

    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');
    //=> true

    Extglobs

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

    False

    Escaped globs or extglobs return false:

    isGlob('abc/\\@(a).js');
    isGlob('abc/\\!(a).js');
    isGlob('abc/\\+(a).js');
    isGlob('abc/\\*(a).js');
    isGlob('abc/\\?(a).js');
    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');
    //=> 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('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

    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:

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

    Extglobs

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

    False

    Escaped globs or extglobs return false:

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

    About

    Contributing

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

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

    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

    Commits Contributor
    47 jonschlinkert
    5 doowb
    1 phated
    1 danhper
    1 paulmillr

    Author

    Jon Schlinkert

    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.

    Install

    npm i is-glob

    DownloadsWeekly Downloads

    40,961,431

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    11.3 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar