glob-to-regexp

What is glob-to-regexp?

The glob-to-regexp npm package is used to convert glob expressions into JavaScript RegExp objects. This allows for pattern matching based on the glob pattern, which is commonly used for file matching in file systems.

What are glob-to-regexp's main functionalities?

Convert glob to RegExp

This feature allows the conversion of a simple glob pattern ('*.js') into a RegExp object. The resulting RegExp can then be used to test if strings (like filenames) match the pattern.

const globToRegExp = require('glob-to-regexp');
const pattern = globToRegExp('*.js');
console.log(pattern.test('example.js')); // true
console.log(pattern.test('example.txt')); // false

Case insensitive matching

This feature demonstrates how to convert a glob pattern into a RegExp object with case insensitive matching enabled. This is useful for environments where file names are case-insensitive, such as Windows.

const globToRegExp = require('glob-to-regexp');
const pattern = globToRegExp('*.JS', { extended: true, globstar: true, flags: 'i' });
console.log(pattern.test('EXAMPLE.js')); // true

Extended glob matching

This feature shows how to handle extended glob patterns, such as optional patterns using '?'. It converts the glob into a RegExp that matches both 'pattern.js' and '.js'.

const globToRegExp = require('glob-to-regexp');
const pattern = globToRegExp('?(pattern).js', { extended: true });
console.log(pattern.test('pattern.js')); // true
console.log(pattern.test('.js')); // true

Other packages similar to glob-to-regexp

minimatch

Minimatch is a minimal matching utility that also converts glob patterns into RegExp. It is similar to glob-to-regexp but includes more comprehensive options for pattern matching and is widely used in the Node.js ecosystem.

micromatch

Micromatch is a highly optimized glob matching library that offers better performance and more features compared to glob-to-regexp. It supports a broader range of pattern matching syntax and is suitable for complex matching requirements.

node-glob

Node-glob is more than just a pattern matching library; it implements the actual file searching capability on the file system. While it uses glob patterns like glob-to-regexp, it directly interacts with the filesystem to filter files based on the patterns.

README

Glob To Regular Expression

Turn a *-wildcard style glob ("*.min.js") into a regular expression (/^.*\.min\.js$/)!

To match bash-like globs, eg. ? for any single-character match, [a-z] for character ranges, and {*.html, *.js} for multiple alternatives, call with { extended: true }.

To obey globstars ** rules set option {globstar: true}. NOTE: This changes the behavior of * when globstar is true as shown below: When {globstar: true}: /foo/** will match any string that starts with /foo/ like /foo/index.htm, /foo/bar/baz.txt, etc. Also, /foo/**/*.txt will match any string that starts with /foo/ and ends with .txt like /foo/bar.txt, /foo/bar/baz.txt, etc. Whereas /foo/* (single *, not a globstar) will match strings that start with /foo/ like /foo/index.htm, /foo/baz.txt but will not match strings that contain a / to the right like /foo/bar/baz.txt, /foo/bar/baz/qux.dat, etc.

Set flags on the resulting RegExp object by adding the flags property to the option object, eg { flags: "i" } for ignoring case.

Install

npm install glob-to-regexp

Usage

var globToRegExp = require('glob-to-regexp');
var re = globToRegExp("p*uck");
re.test("pot luck"); // true
re.test("pluck"); // true
re.test("puck"); // true

re = globToRegExp("*.min.js");
re.test("http://example.com/jquery.min.js"); // true
re.test("http://example.com/jquery.min.js.map"); // false

re = globToRegExp("*/www/*.js");
re.test("http://example.com/www/app.js"); // true
re.test("http://example.com/www/lib/factory-proxy-model-observer.js"); // true

// Extended globs
re = globToRegExp("*/www/{*.js,*.html}", { extended: true });
re.test("http://example.com/www/app.js"); // true
re.test("http://example.com/www/index.html"); // true

License

Copyright (c) 2013, Nick Fitzgerald

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.