minimatch
Advanced tools
Package description
The minimatch npm package is a minimal matching utility that implements the string pattern matching functionality, commonly known as 'globbing'. It is used to match text strings with wildcard characters, such as '*' for multiple characters or '?' for a single character. It is often used in file path matching and filtering operations.
Basic string matching
This feature allows for basic pattern matching where a string is tested against a pattern. Wildcards like '*' and '?' can be used to match multiple or single characters respectively.
"use strict";
const minimatch = require("minimatch");
// Match a literal string
console.log(minimatch("foo.js", "foo.js")); // true
// Match with a single wildcard
console.log(minimatch("foo.js", "*.js")); // true
// Match with a single character wildcard
console.log(minimatch("foo.js", "f?o.js")); // trueNegation
This feature allows patterns to be negated so that they match strings that do not match the given pattern.
"use strict";
const minimatch = require("minimatch");
// Negate the match
console.log(minimatch("foo.js", "!foo.js")); // false
console.log(minimatch("bar.js", "!foo.js")); // trueMatch options
Minimatch allows for additional options to be set, such as case-insensitivity, to customize the matching behavior.
"use strict";
const minimatch = require("minimatch");
// Match with options
const options = {nocase: true};
console.log(minimatch("FOO.JS", "*.js", options)); // trueMicromatch is a faster and more efficient globbing library with a broader feature set compared to minimatch. It offers advanced pattern matching with support for multiple patterns and extended globbing features.
Glob is a package that provides pattern matching and file system operations. It is more focused on file system globbing rather than string pattern matching, but it uses minimatch under the hood for its matching capabilities.
Multimatch extends minimatch to allow for multiple patterns to be specified at once. It is useful when you need to match against an array of patterns rather than a single pattern.
Anymatch is a package that allows for matching strings against not just patterns, but also against regular expressions and functions. It provides a more flexible matching mechanism compared to minimatch.
Readme
A minimal matching utility.
This is the matching library used internally by npm.
Eventually, it will replace the C binding in node-glob.
It works by converting glob expressions into JavaScript RegExp
objects.
var minimatch = require("minimatch")
minimatch("bar.foo", "*.foo") // true!
minimatch("bar.foo", "*.bar") // false!
Supports all glob features.
See:
man shman fnmatchman 5 gitignoreIf the pattern starts with a ! character, then it is negated.
If a pattern starts with #, then it is treated as a comment, and
will not match anything. (Use \# to match a literal # at the
start of a line.)
The double-star ** is always supported, instead of requiring a special
flag.
If an escaped pattern has no matches, and the null flag is not set,
then minimatch.match returns the pattern as-provided, rather than
interpreting the character escapes. For example,
minimatch.match([], "\\*a\\?") will return "\\*a\\?" rather than
"*a?".
Main export. Tests a path against the pattern using the options.
Returns a function that tests its
supplied argument, suitable for use with Array.filter.
Match against the list of
files, in the style of fnmatch or glob. If nothing is matched, then
return the pattern (unless { null: true } in the options.)
Make a regular expression object from the pattern.
All options are false by default.
Dump a ton of stuff to stderr.
Return an empty list from minimatch.match, instead of a list containing the pattern itself.
Perform a case-insensitive match.
An LRU cache with .get(k) and .set(k,v) methods. By
default, an instance of node-lru-cache is used, with 1000 max
entries.
If set, then a/* will match a/ as well as a/b.
If set, then patterns without slashes will be matched
against the basename of the path if it contains slashes. For example,
a?b would match xyz/123/acb.
Internal. Used by minimatch.makeRe.
Allow patterns to match paths starting with a period, even if the pattern does not explicitly start with a period.
FAQs
a glob matcher in javascript
The npm package minimatch receives a total of 149,121,920 weekly downloads. As such, minimatch popularity was classified as popular.
We found that minimatch demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.