Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 1 | 'use strict'; |
| 2 | |
| 3 | const util = require('util'); |
| 4 | const braces = require('braces'); |
| 5 | const picomatch = require('picomatch'); |
| 6 | const utils = require('picomatch/lib/utils'); |
Alex Rudenko | bfb1124 | 2024-10-17 12:50:05 | [diff] [blame] | 7 | |
| 8 | const isEmptyString = v => v === '' || v === './'; |
| 9 | const hasBraces = v => { |
| 10 | const index = v.indexOf('{'); |
| 11 | return index > -1 && v.indexOf('}', index) > -1; |
| 12 | }; |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 13 | |
| 14 | /** |
| 15 | * Returns an array of strings that match one or more glob patterns. |
| 16 | * |
| 17 | * ```js |
| 18 | * const mm = require('micromatch'); |
| 19 | * // mm(list, patterns[, options]); |
| 20 | * |
| 21 | * console.log(mm(['a.js', 'a.txt'], ['*.js'])); |
| 22 | * //=> [ 'a.js' ] |
| 23 | * ``` |
Tim van der Lippe | 3820890 | 2021-05-11 15:37:59 | [diff] [blame] | 24 | * @param {String|Array<string>} `list` List of strings to match. |
| 25 | * @param {String|Array<string>} `patterns` One or more glob patterns to use for matching. |
| 26 | * @param {Object} `options` See available [options](#options) |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 27 | * @return {Array} Returns an array of matches |
| 28 | * @summary false |
| 29 | * @api public |
| 30 | */ |
| 31 | |
| 32 | const micromatch = (list, patterns, options) => { |
| 33 | patterns = [].concat(patterns); |
| 34 | list = [].concat(list); |
| 35 | |
| 36 | let omit = new Set(); |
| 37 | let keep = new Set(); |
| 38 | let items = new Set(); |
| 39 | let negatives = 0; |
| 40 | |
| 41 | let onResult = state => { |
| 42 | items.add(state.output); |
| 43 | if (options && options.onResult) { |
| 44 | options.onResult(state); |
| 45 | } |
| 46 | }; |
| 47 | |
| 48 | for (let i = 0; i < patterns.length; i++) { |
| 49 | let isMatch = picomatch(String(patterns[i]), { ...options, onResult }, true); |
| 50 | let negated = isMatch.state.negated || isMatch.state.negatedExtglob; |
| 51 | if (negated) negatives++; |
| 52 | |
| 53 | for (let item of list) { |
| 54 | let matched = isMatch(item, true); |
| 55 | |
| 56 | let match = negated ? !matched.isMatch : matched.isMatch; |
| 57 | if (!match) continue; |
| 58 | |
| 59 | if (negated) { |
| 60 | omit.add(matched.output); |
| 61 | } else { |
| 62 | omit.delete(matched.output); |
| 63 | keep.add(matched.output); |
| 64 | } |
| 65 | } |
| 66 | } |
| 67 | |
| 68 | let result = negatives === patterns.length ? [...items] : [...keep]; |
| 69 | let matches = result.filter(item => !omit.has(item)); |
| 70 | |
| 71 | if (options && matches.length === 0) { |
| 72 | if (options.failglob === true) { |
| 73 | throw new Error(`No matches found for "${patterns.join(', ')}"`); |
| 74 | } |
| 75 | |
| 76 | if (options.nonull === true || options.nullglob === true) { |
| 77 | return options.unescape ? patterns.map(p => p.replace(/\\/g, '')) : patterns; |
| 78 | } |
| 79 | } |
| 80 | |
| 81 | return matches; |
| 82 | }; |
| 83 | |
| 84 | /** |
| 85 | * Backwards compatibility |
| 86 | */ |
| 87 | |
| 88 | micromatch.match = micromatch; |
| 89 | |
| 90 | /** |
| 91 | * Returns a matcher function from the given glob `pattern` and `options`. |
| 92 | * The returned function takes a string to match as its only argument and returns |
| 93 | * true if the string is a match. |
| 94 | * |
| 95 | * ```js |
| 96 | * const mm = require('micromatch'); |
| 97 | * // mm.matcher(pattern[, options]); |
| 98 | * |
| 99 | * const isMatch = mm.matcher('*.!(*a)'); |
| 100 | * console.log(isMatch('a.a')); //=> false |
| 101 | * console.log(isMatch('a.b')); //=> true |
| 102 | * ``` |
| 103 | * @param {String} `pattern` Glob pattern |
| 104 | * @param {Object} `options` |
| 105 | * @return {Function} Returns a matcher function. |
| 106 | * @api public |
| 107 | */ |
| 108 | |
| 109 | micromatch.matcher = (pattern, options) => picomatch(pattern, options); |
| 110 | |
| 111 | /** |
| 112 | * Returns true if **any** of the given glob `patterns` match the specified `string`. |
| 113 | * |
| 114 | * ```js |
| 115 | * const mm = require('micromatch'); |
| 116 | * // mm.isMatch(string, patterns[, options]); |
| 117 | * |
| 118 | * console.log(mm.isMatch('a.a', ['b.*', '*.a'])); //=> true |
| 119 | * console.log(mm.isMatch('a.a', 'b.*')); //=> false |
| 120 | * ``` |
Tim van der Lippe | 3820890 | 2021-05-11 15:37:59 | [diff] [blame] | 121 | * @param {String} `str` The string to test. |
| 122 | * @param {String|Array} `patterns` One or more glob patterns to use for matching. |
| 123 | * @param {Object} `[options]` See available [options](#options). |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 124 | * @return {Boolean} Returns true if any patterns match `str` |
| 125 | * @api public |
| 126 | */ |
| 127 | |
| 128 | micromatch.isMatch = (str, patterns, options) => picomatch(patterns, options)(str); |
| 129 | |
| 130 | /** |
| 131 | * Backwards compatibility |
| 132 | */ |
| 133 | |
| 134 | micromatch.any = micromatch.isMatch; |
| 135 | |
| 136 | /** |
| 137 | * Returns a list of strings that _**do not match any**_ of the given `patterns`. |
| 138 | * |
| 139 | * ```js |
| 140 | * const mm = require('micromatch'); |
| 141 | * // mm.not(list, patterns[, options]); |
| 142 | * |
| 143 | * console.log(mm.not(['a.a', 'b.b', 'c.c'], '*.a')); |
| 144 | * //=> ['b.b', 'c.c'] |
| 145 | * ``` |
| 146 | * @param {Array} `list` Array of strings to match. |
| 147 | * @param {String|Array} `patterns` One or more glob pattern to use for matching. |
| 148 | * @param {Object} `options` See available [options](#options) for changing how matches are performed |
| 149 | * @return {Array} Returns an array of strings that **do not match** the given patterns. |
| 150 | * @api public |
| 151 | */ |
| 152 | |
| 153 | micromatch.not = (list, patterns, options = {}) => { |
| 154 | patterns = [].concat(patterns).map(String); |
| 155 | let result = new Set(); |
| 156 | let items = []; |
| 157 | |
| 158 | let onResult = state => { |
| 159 | if (options.onResult) options.onResult(state); |
| 160 | items.push(state.output); |
| 161 | }; |
| 162 | |
Alex Rudenko | bfb1124 | 2024-10-17 12:50:05 | [diff] [blame] | 163 | let matches = new Set(micromatch(list, patterns, { ...options, onResult })); |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 164 | |
| 165 | for (let item of items) { |
Alex Rudenko | bfb1124 | 2024-10-17 12:50:05 | [diff] [blame] | 166 | if (!matches.has(item)) { |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 167 | result.add(item); |
| 168 | } |
| 169 | } |
| 170 | return [...result]; |
| 171 | }; |
| 172 | |
| 173 | /** |
| 174 | * Returns true if the given `string` contains the given pattern. Similar |
| 175 | * to [.isMatch](#isMatch) but the pattern can match any part of the string. |
| 176 | * |
| 177 | * ```js |
| 178 | * var mm = require('micromatch'); |
| 179 | * // mm.contains(string, pattern[, options]); |
| 180 | * |
| 181 | * console.log(mm.contains('aa/bb/cc', '*b')); |
| 182 | * //=> true |
| 183 | * console.log(mm.contains('aa/bb/cc', '*d')); |
| 184 | * //=> false |
| 185 | * ``` |
| 186 | * @param {String} `str` The string to match. |
| 187 | * @param {String|Array} `patterns` Glob pattern to use for matching. |
| 188 | * @param {Object} `options` See available [options](#options) for changing how matches are performed |
Tim van der Lippe | 3820890 | 2021-05-11 15:37:59 | [diff] [blame] | 189 | * @return {Boolean} Returns true if any of the patterns matches any part of `str`. |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 190 | * @api public |
| 191 | */ |
| 192 | |
| 193 | micromatch.contains = (str, pattern, options) => { |
| 194 | if (typeof str !== 'string') { |
| 195 | throw new TypeError(`Expected a string: "${util.inspect(str)}"`); |
| 196 | } |
| 197 | |
| 198 | if (Array.isArray(pattern)) { |
| 199 | return pattern.some(p => micromatch.contains(str, p, options)); |
| 200 | } |
| 201 | |
| 202 | if (typeof pattern === 'string') { |
| 203 | if (isEmptyString(str) || isEmptyString(pattern)) { |
| 204 | return false; |
| 205 | } |
| 206 | |
| 207 | if (str.includes(pattern) || (str.startsWith('./') && str.slice(2).includes(pattern))) { |
| 208 | return true; |
| 209 | } |
| 210 | } |
| 211 | |
| 212 | return micromatch.isMatch(str, pattern, { ...options, contains: true }); |
| 213 | }; |
| 214 | |
| 215 | /** |
| 216 | * Filter the keys of the given object with the given `glob` pattern |
| 217 | * and `options`. Does not attempt to match nested keys. If you need this feature, |
| 218 | * use [glob-object][] instead. |
| 219 | * |
| 220 | * ```js |
| 221 | * const mm = require('micromatch'); |
| 222 | * // mm.matchKeys(object, patterns[, options]); |
| 223 | * |
| 224 | * const obj = { aa: 'a', ab: 'b', ac: 'c' }; |
| 225 | * console.log(mm.matchKeys(obj, '*b')); |
| 226 | * //=> { ab: 'b' } |
| 227 | * ``` |
| 228 | * @param {Object} `object` The object with keys to filter. |
| 229 | * @param {String|Array} `patterns` One or more glob patterns to use for matching. |
| 230 | * @param {Object} `options` See available [options](#options) for changing how matches are performed |
| 231 | * @return {Object} Returns an object with only keys that match the given patterns. |
| 232 | * @api public |
| 233 | */ |
| 234 | |
| 235 | micromatch.matchKeys = (obj, patterns, options) => { |
| 236 | if (!utils.isObject(obj)) { |
| 237 | throw new TypeError('Expected the first argument to be an object'); |
| 238 | } |
| 239 | let keys = micromatch(Object.keys(obj), patterns, options); |
| 240 | let res = {}; |
| 241 | for (let key of keys) res[key] = obj[key]; |
| 242 | return res; |
| 243 | }; |
| 244 | |
| 245 | /** |
| 246 | * Returns true if some of the strings in the given `list` match any of the given glob `patterns`. |
| 247 | * |
| 248 | * ```js |
| 249 | * const mm = require('micromatch'); |
| 250 | * // mm.some(list, patterns[, options]); |
| 251 | * |
| 252 | * console.log(mm.some(['foo.js', 'bar.js'], ['*.js', '!foo.js'])); |
| 253 | * // true |
| 254 | * console.log(mm.some(['foo.js'], ['*.js', '!foo.js'])); |
| 255 | * // false |
| 256 | * ``` |
| 257 | * @param {String|Array} `list` The string or array of strings to test. Returns as soon as the first match is found. |
| 258 | * @param {String|Array} `patterns` One or more glob patterns to use for matching. |
| 259 | * @param {Object} `options` See available [options](#options) for changing how matches are performed |
Tim van der Lippe | 3820890 | 2021-05-11 15:37:59 | [diff] [blame] | 260 | * @return {Boolean} Returns true if any `patterns` matches any of the strings in `list` |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 261 | * @api public |
| 262 | */ |
| 263 | |
| 264 | micromatch.some = (list, patterns, options) => { |
| 265 | let items = [].concat(list); |
| 266 | |
| 267 | for (let pattern of [].concat(patterns)) { |
| 268 | let isMatch = picomatch(String(pattern), options); |
| 269 | if (items.some(item => isMatch(item))) { |
| 270 | return true; |
| 271 | } |
| 272 | } |
| 273 | return false; |
| 274 | }; |
| 275 | |
| 276 | /** |
| 277 | * Returns true if every string in the given `list` matches |
| 278 | * any of the given glob `patterns`. |
| 279 | * |
| 280 | * ```js |
| 281 | * const mm = require('micromatch'); |
| 282 | * // mm.every(list, patterns[, options]); |
| 283 | * |
| 284 | * console.log(mm.every('foo.js', ['foo.js'])); |
| 285 | * // true |
| 286 | * console.log(mm.every(['foo.js', 'bar.js'], ['*.js'])); |
| 287 | * // true |
| 288 | * console.log(mm.every(['foo.js', 'bar.js'], ['*.js', '!foo.js'])); |
| 289 | * // false |
| 290 | * console.log(mm.every(['foo.js'], ['*.js', '!foo.js'])); |
| 291 | * // false |
| 292 | * ``` |
| 293 | * @param {String|Array} `list` The string or array of strings to test. |
| 294 | * @param {String|Array} `patterns` One or more glob patterns to use for matching. |
| 295 | * @param {Object} `options` See available [options](#options) for changing how matches are performed |
Tim van der Lippe | 3820890 | 2021-05-11 15:37:59 | [diff] [blame] | 296 | * @return {Boolean} Returns true if all `patterns` matches all of the strings in `list` |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 297 | * @api public |
| 298 | */ |
| 299 | |
| 300 | micromatch.every = (list, patterns, options) => { |
| 301 | let items = [].concat(list); |
| 302 | |
| 303 | for (let pattern of [].concat(patterns)) { |
| 304 | let isMatch = picomatch(String(pattern), options); |
| 305 | if (!items.every(item => isMatch(item))) { |
| 306 | return false; |
| 307 | } |
| 308 | } |
| 309 | return true; |
| 310 | }; |
| 311 | |
| 312 | /** |
| 313 | * Returns true if **all** of the given `patterns` match |
| 314 | * the specified string. |
| 315 | * |
| 316 | * ```js |
| 317 | * const mm = require('micromatch'); |
| 318 | * // mm.all(string, patterns[, options]); |
| 319 | * |
| 320 | * console.log(mm.all('foo.js', ['foo.js'])); |
| 321 | * // true |
| 322 | * |
| 323 | * console.log(mm.all('foo.js', ['*.js', '!foo.js'])); |
| 324 | * // false |
| 325 | * |
| 326 | * console.log(mm.all('foo.js', ['*.js', 'foo.js'])); |
| 327 | * // true |
| 328 | * |
| 329 | * console.log(mm.all('foo.js', ['*.js', 'f*', '*o*', '*o.js'])); |
| 330 | * // true |
| 331 | * ``` |
| 332 | * @param {String|Array} `str` The string to test. |
| 333 | * @param {String|Array} `patterns` One or more glob patterns to use for matching. |
| 334 | * @param {Object} `options` See available [options](#options) for changing how matches are performed |
| 335 | * @return {Boolean} Returns true if any patterns match `str` |
| 336 | * @api public |
| 337 | */ |
| 338 | |
| 339 | micromatch.all = (str, patterns, options) => { |
| 340 | if (typeof str !== 'string') { |
| 341 | throw new TypeError(`Expected a string: "${util.inspect(str)}"`); |
| 342 | } |
| 343 | |
| 344 | return [].concat(patterns).every(p => picomatch(p, options)(str)); |
| 345 | }; |
| 346 | |
| 347 | /** |
| 348 | * Returns an array of matches captured by `pattern` in `string, or `null` if the pattern did not match. |
| 349 | * |
| 350 | * ```js |
| 351 | * const mm = require('micromatch'); |
| 352 | * // mm.capture(pattern, string[, options]); |
| 353 | * |
| 354 | * console.log(mm.capture('test/*.js', 'test/foo.js')); |
| 355 | * //=> ['foo'] |
| 356 | * console.log(mm.capture('test/*.js', 'foo/bar.css')); |
| 357 | * //=> null |
| 358 | * ``` |
| 359 | * @param {String} `glob` Glob pattern to use for matching. |
| 360 | * @param {String} `input` String to match |
| 361 | * @param {Object} `options` See available [options](#options) for changing how matches are performed |
Tim van der Lippe | 3820890 | 2021-05-11 15:37:59 | [diff] [blame] | 362 | * @return {Array|null} Returns an array of captures if the input matches the glob pattern, otherwise `null`. |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 363 | * @api public |
| 364 | */ |
| 365 | |
| 366 | micromatch.capture = (glob, input, options) => { |
| 367 | let posix = utils.isWindows(options); |
| 368 | let regex = picomatch.makeRe(String(glob), { ...options, capture: true }); |
| 369 | let match = regex.exec(posix ? utils.toPosixSlashes(input) : input); |
| 370 | |
| 371 | if (match) { |
| 372 | return match.slice(1).map(v => v === void 0 ? '' : v); |
| 373 | } |
| 374 | }; |
| 375 | |
| 376 | /** |
| 377 | * Create a regular expression from the given glob `pattern`. |
| 378 | * |
| 379 | * ```js |
| 380 | * const mm = require('micromatch'); |
| 381 | * // mm.makeRe(pattern[, options]); |
| 382 | * |
| 383 | * console.log(mm.makeRe('*.js')); |
| 384 | * //=> /^(?:(\.[\\\/])?(?!\.)(?=.)[^\/]*?\.js)$/ |
| 385 | * ``` |
| 386 | * @param {String} `pattern` A glob pattern to convert to regex. |
| 387 | * @param {Object} `options` |
| 388 | * @return {RegExp} Returns a regex created from the given pattern. |
| 389 | * @api public |
| 390 | */ |
| 391 | |
| 392 | micromatch.makeRe = (...args) => picomatch.makeRe(...args); |
| 393 | |
| 394 | /** |
| 395 | * Scan a glob pattern to separate the pattern into segments. Used |
| 396 | * by the [split](#split) method. |
| 397 | * |
| 398 | * ```js |
| 399 | * const mm = require('micromatch'); |
| 400 | * const state = mm.scan(pattern[, options]); |
| 401 | * ``` |
| 402 | * @param {String} `pattern` |
| 403 | * @param {Object} `options` |
| 404 | * @return {Object} Returns an object with |
| 405 | * @api public |
| 406 | */ |
| 407 | |
| 408 | micromatch.scan = (...args) => picomatch.scan(...args); |
| 409 | |
| 410 | /** |
| 411 | * Parse a glob pattern to create the source string for a regular |
| 412 | * expression. |
| 413 | * |
| 414 | * ```js |
| 415 | * const mm = require('micromatch'); |
Alex Rudenko | bfb1124 | 2024-10-17 12:50:05 | [diff] [blame] | 416 | * const state = mm.parse(pattern[, options]); |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 417 | * ``` |
| 418 | * @param {String} `glob` |
| 419 | * @param {Object} `options` |
| 420 | * @return {Object} Returns an object with useful properties and output to be used as regex source string. |
| 421 | * @api public |
| 422 | */ |
| 423 | |
| 424 | micromatch.parse = (patterns, options) => { |
| 425 | let res = []; |
| 426 | for (let pattern of [].concat(patterns || [])) { |
| 427 | for (let str of braces(String(pattern), options)) { |
| 428 | res.push(picomatch.parse(str, options)); |
| 429 | } |
| 430 | } |
| 431 | return res; |
| 432 | }; |
| 433 | |
| 434 | /** |
| 435 | * Process the given brace `pattern`. |
| 436 | * |
| 437 | * ```js |
| 438 | * const { braces } = require('micromatch'); |
| 439 | * console.log(braces('foo/{a,b,c}/bar')); |
| 440 | * //=> [ 'foo/(a|b|c)/bar' ] |
| 441 | * |
| 442 | * console.log(braces('foo/{a,b,c}/bar', { expand: true })); |
| 443 | * //=> [ 'foo/a/bar', 'foo/b/bar', 'foo/c/bar' ] |
| 444 | * ``` |
| 445 | * @param {String} `pattern` String with brace pattern to process. |
| 446 | * @param {Object} `options` Any [options](#options) to change how expansion is performed. See the [braces][] library for all available options. |
| 447 | * @return {Array} |
| 448 | * @api public |
| 449 | */ |
| 450 | |
| 451 | micromatch.braces = (pattern, options) => { |
| 452 | if (typeof pattern !== 'string') throw new TypeError('Expected a string'); |
Alex Rudenko | bfb1124 | 2024-10-17 12:50:05 | [diff] [blame] | 453 | if ((options && options.nobrace === true) || !hasBraces(pattern)) { |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 454 | return [pattern]; |
| 455 | } |
| 456 | return braces(pattern, options); |
| 457 | }; |
| 458 | |
| 459 | /** |
| 460 | * Expand braces |
| 461 | */ |
| 462 | |
| 463 | micromatch.braceExpand = (pattern, options) => { |
| 464 | if (typeof pattern !== 'string') throw new TypeError('Expected a string'); |
| 465 | return micromatch.braces(pattern, { ...options, expand: true }); |
| 466 | }; |
| 467 | |
| 468 | /** |
| 469 | * Expose micromatch |
| 470 | */ |
| 471 | |
Alex Rudenko | bfb1124 | 2024-10-17 12:50:05 | [diff] [blame] | 472 | // exposed for tests |
| 473 | micromatch.hasBraces = hasBraces; |
Mathias Bynens | 79e2cf0 | 2020-05-29 14:46:17 | [diff] [blame] | 474 | module.exports = micromatch; |