Projekt

Obecné

Profil

Stáhnout (23 KB) Statistiky
| Větev: | Revize:
1 3a515b92 cagy
# braces [![NPM version](https://img.shields.io/npm/v/braces.svg?style=flat)](https://www.npmjs.com/package/braces) [![NPM monthly downloads](https://img.shields.io/npm/dm/braces.svg?style=flat)](https://npmjs.org/package/braces) [![NPM total downloads](https://img.shields.io/npm/dt/braces.svg?style=flat)](https://npmjs.org/package/braces) [![Linux Build Status](https://img.shields.io/travis/micromatch/braces.svg?style=flat&label=Travis)](https://travis-ci.org/micromatch/braces) [![Windows Build Status](https://img.shields.io/appveyor/ci/micromatch/braces.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/micromatch/braces)
2
3
> Bash-like brace expansion, implemented in JavaScript. Safer than other brace expansion libs, with complete support for the Bash 4.3 braces specification, without sacrificing speed.
4
5
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
6
7
## Install
8
9
Install with [npm](https://www.npmjs.com/):
10
11
```sh
12
$ npm install --save braces
13
```
14
15
## Why use braces?
16
17
Brace patterns are great for matching ranges. Users (and implementors) shouldn't have to think about whether or not they will break their application (or yours) from accidentally defining an aggressive brace pattern. _Braces is the only library that offers a [solution to this problem](#performance)_.
18
19
* **Safe(r)**: Braces isn't vulnerable to DoS attacks like [brace-expansion](https://github.com/juliangruber/brace-expansion), [minimatch](https://github.com/isaacs/minimatch) and [multimatch](https://github.com/sindresorhus/multimatch) (a different bug than the [other regex DoS bug](https://medium.com/node-security/minimatch-redos-vulnerability-590da24e6d3c#.jew0b6mpc)).
20
* **Accurate**: complete support for the [Bash 4.3 Brace Expansion](www.gnu.org/software/bash/) specification (passes all of the Bash braces tests)
21
* **[fast and performant](#benchmarks)**: Starts fast, runs fast and [scales well](#performance) as patterns increase in complexity.
22
* **Organized code base**: with parser and compiler that are eas(y|ier) to maintain and update when edge cases crop up.
23
* **Well-tested**: thousands of test assertions. Passes 100% of the [minimatch](https://github.com/isaacs/minimatch) and [brace-expansion](https://github.com/juliangruber/brace-expansion) unit tests as well (as of the writing of this).
24
25
## Usage
26
27
The main export is a function that takes one or more brace `patterns` and `options`.
28
29
```js
30
var braces = require('braces');
31
braces(pattern[, options]);
32
```
33
34
By default, braces returns an optimized regex-source string. To get an array of brace patterns, use `brace.expand()`.
35
36
The following section explains the difference in more detail. _(If you're curious about "why" braces does this by default, see [brace matching pitfalls](#brace-matching-pitfalls)_.
37
38
### Optimized vs. expanded braces
39
40
**Optimized**
41
42
By default, patterns are optimized for regex and matching:
43
44
```js
45
console.log(braces('a/{x,y,z}/b'));
46
//=> ['a/(x|y|z)/b']
47
```
48
49
**Expanded**
50
51
To expand patterns the same way as Bash or [minimatch](https://github.com/isaacs/minimatch), use the [.expand](#expand) method:
52
53
```js
54
console.log(braces.expand('a/{x,y,z}/b'));
55
//=> ['a/x/b', 'a/y/b', 'a/z/b']
56
```
57
58
Or use [options.expand](#optionsexpand):
59
60
```js
61
console.log(braces('a/{x,y,z}/b', {expand: true}));
62
//=> ['a/x/b', 'a/y/b', 'a/z/b']
63
```
64
65
## Features
66
67
* [lists](#lists): Supports "lists": `a/{b,c}/d` => `['a/b/d', 'a/c/d']`
68
* [sequences](#sequences): Supports alphabetical or numerical "sequences" (ranges): `{1..3}` => `['1', '2', '3']`
69
* [steps](#steps): Supports "steps" or increments: `{2..10..2}` => `['2', '4', '6', '8', '10']`
70
* [escaping](#escaping)
71
* [options](#options)
72
73
### Lists
74
75
Uses [fill-range](https://github.com/jonschlinkert/fill-range) for expanding alphabetical or numeric lists:
76
77
```js
78
console.log(braces('a/{foo,bar,baz}/*.js'));
79
//=> ['a/(foo|bar|baz)/*.js']
80
81
console.log(braces.expand('a/{foo,bar,baz}/*.js'));
82
//=> ['a/foo/*.js', 'a/bar/*.js', 'a/baz/*.js']
83
```
84
85
### Sequences
86
87
Uses [fill-range](https://github.com/jonschlinkert/fill-range) for expanding alphabetical or numeric ranges (bash "sequences"):
88
89
```js
90
console.log(braces.expand('{1..3}'));     // ['1', '2', '3']
91
console.log(braces.expand('a{01..03}b')); // ['a01b', 'a02b', 'a03b']
92
console.log(braces.expand('a{1..3}b'));   // ['a1b', 'a2b', 'a3b']
93
console.log(braces.expand('{a..c}'));     // ['a', 'b', 'c']
94
console.log(braces.expand('foo/{a..c}')); // ['foo/a', 'foo/b', 'foo/c']
95
96
// supports padded ranges
97
console.log(braces('a{01..03}b'));   //=> [ 'a(0[1-3])b' ]
98
console.log(braces('a{001..300}b')); //=> [ 'a(0{2}[1-9]|0[1-9][0-9]|[12][0-9]{2}|300)b' ]
99
```
100
101
### Steps
102
103
Steps, or increments, may be used with ranges:
104
105
```js
106
console.log(braces.expand('{2..10..2}'));
107
//=> ['2', '4', '6', '8', '10']
108
109
console.log(braces('{2..10..2}'));
110
//=> ['(2|4|6|8|10)']
111
```
112
113
When the [.optimize](#optimize) method is used, or [options.optimize](#optionsoptimize) is set to true, sequences are passed to [to-regex-range](https://github.com/jonschlinkert/to-regex-range) for expansion.
114
115
### Nesting
116
117
Brace patterns may be nested. The results of each expanded string are not sorted, and left to right order is preserved.
118
119
**"Expanded" braces**
120
121
```js
122
console.log(braces.expand('a{b,c,/{x,y}}/e'));
123
//=> ['ab/e', 'ac/e', 'a/x/e', 'a/y/e']
124
125
console.log(braces.expand('a/{x,{1..5},y}/c'));
126
//=> ['a/x/c', 'a/1/c', 'a/2/c', 'a/3/c', 'a/4/c', 'a/5/c', 'a/y/c']
127
```
128
129
**"Optimized" braces**
130
131
```js
132
console.log(braces('a{b,c,/{x,y}}/e'));
133
//=> ['a(b|c|/(x|y))/e']
134
135
console.log(braces('a/{x,{1..5},y}/c'));
136
//=> ['a/(x|([1-5])|y)/c']
137
```
138
139
### Escaping
140
141
**Escaping braces**
142
143
A brace pattern will not be expanded or evaluted if _either the opening or closing brace is escaped_:
144
145
```js
146
console.log(braces.expand('a\\{d,c,b}e'));
147
//=> ['a{d,c,b}e']
148
149
console.log(braces.expand('a{d,c,b\\}e'));
150
//=> ['a{d,c,b}e']
151
```
152
153
**Escaping commas**
154
155
Commas inside braces may also be escaped:
156
157
```js
158
console.log(braces.expand('a{b\\,c}d'));
159
//=> ['a{b,c}d']
160
161
console.log(braces.expand('a{d\\,c,b}e'));
162
//=> ['ad,ce', 'abe']
163
```
164
165
**Single items**
166
167
Following bash conventions, a brace pattern is also not expanded when it contains a single character:
168
169
```js
170
console.log(braces.expand('a{b}c'));
171
//=> ['a{b}c']
172
```
173
174
## Options
175
176
### options.maxLength
177
178
**Type**: `Number`
179
180
**Default**: `65,536`
181
182
**Description**: Limit the length of the input string. Useful when the input string is generated or your application allows users to pass a string, et cetera.
183
184
```js
185
console.log(braces('a/{b,c}/d', { maxLength: 3 }));  //=> throws an error
186
```
187
188
### options.expand
189
190
**Type**: `Boolean`
191
192
**Default**: `undefined`
193
194
**Description**: Generate an "expanded" brace pattern (this option is unncessary with the `.expand` method, which does the same thing).
195
196
```js
197
console.log(braces('a/{b,c}/d', {expand: true}));
198
//=> [ 'a/b/d', 'a/c/d' ]
199
```
200
201
### options.optimize
202
203
**Type**: `Boolean`
204
205
**Default**: `true`
206
207
**Description**: Enabled by default.
208
209
```js
210
console.log(braces('a/{b,c}/d'));
211
//=> [ 'a/(b|c)/d' ]
212
```
213
214
### options.nodupes
215
216
**Type**: `Boolean`
217
218
**Default**: `true`
219
220
**Description**: Duplicates are removed by default. To keep duplicates, pass `{nodupes: false}` on the options
221
222
### options.rangeLimit
223
224
**Type**: `Number`
225
226
**Default**: `250`
227
228
**Description**: When `braces.expand()` is used, or `options.expand` is true, brace patterns will automatically be [optimized](#optionsoptimize) when the difference between the range minimum and range maximum exceeds the `rangeLimit`. This is to prevent huge ranges from freezing your application.
229
230
You can set this to any number, or change `options.rangeLimit` to `Inifinity` to disable this altogether.
231
232
**Examples**
233
234
```js
235
// pattern exceeds the "rangeLimit", so it's optimized automatically
236
console.log(braces.expand('{1..1000}'));
237
//=> ['([1-9]|[1-9][0-9]{1,2}|1000)']
238
239
// pattern does not exceed "rangeLimit", so it's NOT optimized
240
console.log(braces.expand('{1..100}'));
241
//=> ['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '50', '51', '52', '53', '54', '55', '56', '57', '58', '59', '60', '61', '62', '63', '64', '65', '66', '67', '68', '69', '70', '71', '72', '73', '74', '75', '76', '77', '78', '79', '80', '81', '82', '83', '84', '85', '86', '87', '88', '89', '90', '91', '92', '93', '94', '95', '96', '97', '98', '99', '100']
242
```
243
244
### options.transform
245
246
**Type**: `Function`
247
248
**Default**: `undefined`
249
250
**Description**: Customize range expansion.
251
252
```js
253
var range = braces.expand('x{a..e}y', {
254
  transform: function(str) {
255
    return 'foo' + str;
256
  }
257
});
258
259
console.log(range);
260
//=> [ 'xfooay', 'xfooby', 'xfoocy', 'xfoody', 'xfooey' ]
261
```
262
263
### options.quantifiers
264
265
**Type**: `Boolean`
266
267
**Default**: `undefined`
268
269
**Description**: In regular expressions, quanitifiers can be used to specify how many times a token can be repeated. For example, `a{1,3}` will match the letter `a` one to three times.
270
271
Unfortunately, regex quantifiers happen to share the same syntax as [Bash lists](#lists)
272
273
The `quantifiers` option tells braces to detect when [regex quantifiers](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#quantifiers) are defined in the given pattern, and not to try to expand them as lists.
274
275
**Examples**
276
277
```js
278
var braces = require('braces');
279
console.log(braces('a/b{1,3}/{x,y,z}'));
280
//=> [ 'a/b(1|3)/(x|y|z)' ]
281
console.log(braces('a/b{1,3}/{x,y,z}', {quantifiers: true}));
282
//=> [ 'a/b{1,3}/(x|y|z)' ]
283
console.log(braces('a/b{1,3}/{x,y,z}', {quantifiers: true, expand: true}));
284
//=> [ 'a/b{1,3}/x', 'a/b{1,3}/y', 'a/b{1,3}/z' ]
285
```
286
287
### options.unescape
288
289
**Type**: `Boolean`
290
291
**Default**: `undefined`
292
293
**Description**: Strip backslashes that were used for escaping from the result.
294
295
## What is "brace expansion"?
296
297
Brace expansion is a type of parameter expansion that was made popular by unix shells for generating lists of strings, as well as regex-like matching when used alongside wildcards (globs).
298
299
In addition to "expansion", braces are also used for matching. In other words:
300
301
* [brace expansion](#brace-expansion) is for generating new lists
302
* [brace matching](#brace-matching) is for filtering existing lists
303
304
<details>
305
<summary><strong>More about brace expansion</strong> (click to expand)</summary>
306
307
There are two main types of brace expansion:
308
309
1. **lists**: which are defined using comma-separated values inside curly braces: `{a,b,c}`
310
2. **sequences**: which are defined using a starting value and an ending value, separated by two dots: `a{1..3}b`. Optionally, a third argument may be passed to define a "step" or increment to use: `a{1..100..10}b`. These are also sometimes referred to as "ranges".
311
312
Here are some example brace patterns to illustrate how they work:
313
314
**Sets**
315
316
```
317
{a,b,c}       => a b c
318
{a,b,c}{1,2}  => a1 a2 b1 b2 c1 c2
319
```
320
321
**Sequences**
322
323
```
324
{1..9}        => 1 2 3 4 5 6 7 8 9
325
{4..-4}       => 4 3 2 1 0 -1 -2 -3 -4
326
{1..20..3}    => 1 4 7 10 13 16 19
327
{a..j}        => a b c d e f g h i j
328
{j..a}        => j i h g f e d c b a
329
{a..z..3}     => a d g j m p s v y
330
```
331
332
**Combination**
333
334
Sets and sequences can be mixed together or used along with any other strings.
335
336
```
337
{a,b,c}{1..3}   => a1 a2 a3 b1 b2 b3 c1 c2 c3
338
foo/{a,b,c}/bar => foo/a/bar foo/b/bar foo/c/bar
339
```
340
341
The fact that braces can be "expanded" from relatively simple patterns makes them ideal for quickly generating test fixtures, file paths, and similar use cases.
342
343
## Brace matching
344
345
In addition to _expansion_, brace patterns are also useful for performing regular-expression-like matching.
346
347
For example, the pattern `foo/{1..3}/bar` would match any of following strings:
348
349
```
350
foo/1/bar
351
foo/2/bar
352
foo/3/bar
353
```
354
355
But not:
356
357
```
358
baz/1/qux
359
baz/2/qux
360
baz/3/qux
361
```
362
363
Braces can also be combined with [glob patterns](https://github.com/jonschlinkert/micromatch) to perform more advanced wildcard matching. For example, the pattern `*/{1..3}/*` would match any of following strings:
364
365
```
366
foo/1/bar
367
foo/2/bar
368
foo/3/bar
369
baz/1/qux
370
baz/2/qux
371
baz/3/qux
372
```
373
374
## Brace matching pitfalls
375
376
Although brace patterns offer a user-friendly way of matching ranges or sets of strings, there are also some major disadvantages and potential risks you should be aware of.
377
378
### tldr
379
380
**"brace bombs"**
381
382
* brace expansion can eat up a huge amount of processing resources
383
* as brace patterns increase _linearly in size_, the system resources required to expand the pattern increase exponentially
384
* users can accidentally (or intentially) exhaust your system's resources resulting in the equivalent of a DoS attack (bonus: no programming knowledge is required!)
385
386
For a more detailed explanation with examples, see the [geometric complexity](#geometric-complexity) section.
387
388
### The solution
389
390
Jump to the [performance section](#performance) to see how Braces solves this problem in comparison to other libraries.
391
392
### Geometric complexity
393
394
At minimum, brace patterns with sets limited to two elements have quadradic or `O(n^2)` complexity. But the complexity of the algorithm increases exponentially as the number of sets, _and elements per set_, increases, which is `O(n^c)`.
395
396
For example, the following sets demonstrate quadratic (`O(n^2)`) complexity:
397
398
```
399
{1,2}{3,4}      => (2X2)    => 13 14 23 24
400
{1,2}{3,4}{5,6} => (2X2X2)  => 135 136 145 146 235 236 245 246
401
```
402
403
But add an element to a set, and we get a n-fold Cartesian product with `O(n^c)` complexity:
404
405
```
406
{1,2,3}{4,5,6}{7,8,9} => (3X3X3) => 147 148 149 157 158 159 167 168 169 247 248 
407
                                    249 257 258 259 267 268 269 347 348 349 357 
408
                                    358 359 367 368 369
409
```
410
411
Now, imagine how this complexity grows given that each element is a n-tuple:
412
413
```
414
{1..100}{1..100}         => (100X100)     => 10,000 elements (38.4 kB)
415
{1..100}{1..100}{1..100} => (100X100X100) => 1,000,000 elements (5.76 MB)
416
```
417
418
Although these examples are clearly contrived, they demonstrate how brace patterns can quickly grow out of control.
419
420
**More information**
421
422
Interested in learning more about brace expansion?
423
424
* [linuxjournal/bash-brace-expansion](http://www.linuxjournal.com/content/bash-brace-expansion)
425
* [rosettacode/Brace_expansion](https://rosettacode.org/wiki/Brace_expansion)
426
* [cartesian product](https://en.wikipedia.org/wiki/Cartesian_product)
427
428
</details>
429
430
## Performance
431
432
Braces is not only screaming fast, it's also more accurate the other brace expansion libraries.
433
434
### Better algorithms
435
436
Fortunately there is a solution to the ["brace bomb" problem](#brace-matching-pitfalls): _don't expand brace patterns into an array when they're used for matching_.
437
438
Instead, convert the pattern into an optimized regular expression. This is easier said than done, and braces is the only library that does this currently.
439
440
**The proof is in the numbers**
441
442
Minimatch gets exponentially slower as patterns increase in complexity, braces does not. The following results were generated using `braces()` and `minimatch.braceExpand()`, respectively.
443
444
| **Pattern** | **braces** | **[minimatch](https://github.com/isaacs/minimatch)** | 
445
| --- | --- | --- |
446
| `{1..9007199254740991}`<sup class="footnote-ref"><a href="#fn1" id="fnref1">[1]</a></sup> | `298 B` (5ms 459μs) | N/A (freezes) |
447
| `{1..1000000000000000}` | `41 B` (1ms 15μs) | N/A (freezes) |
448
| `{1..100000000000000}` | `40 B` (890μs) | N/A (freezes) |
449
| `{1..10000000000000}` | `39 B` (2ms 49μs) | N/A (freezes) |
450
| `{1..1000000000000}` | `38 B` (608μs) | N/A (freezes) |
451
| `{1..100000000000}` | `37 B` (397μs) | N/A (freezes) |
452
| `{1..10000000000}` | `35 B` (983μs) | N/A (freezes) |
453
| `{1..1000000000}` | `34 B` (798μs) | N/A (freezes) |
454
| `{1..100000000}` | `33 B` (733μs) | N/A (freezes) |
455
| `{1..10000000}` | `32 B` (5ms 632μs) | `78.89 MB` (16s 388ms 569μs) |
456
| `{1..1000000}` | `31 B` (1ms 381μs) | `6.89 MB` (1s 496ms 887μs) |
457
| `{1..100000}` | `30 B` (950μs) | `588.89 kB` (146ms 921μs) |
458
| `{1..10000}` | `29 B` (1ms 114μs) | `48.89 kB` (14ms 187μs) |
459
| `{1..1000}` | `28 B` (760μs) | `3.89 kB` (1ms 453μs) |
460
| `{1..100}` | `22 B` (345μs) | `291 B` (196μs) |
461
| `{1..10}` | `10 B` (533μs) | `20 B` (37μs) |
462
| `{1..3}` | `7 B` (190μs) | `5 B` (27μs) |
463
464
### Faster algorithms
465
466
When you need expansion, braces is still much faster.
467
468
_(the following results were generated using `braces.expand()` and `minimatch.braceExpand()`, respectively)_
469
470
| **Pattern** | **braces** | **[minimatch](https://github.com/isaacs/minimatch)** | 
471
| --- | --- | --- |
472
| `{1..10000000}` | `78.89 MB` (2s 698ms 642μs) | `78.89 MB` (18s 601ms 974μs) |
473
| `{1..1000000}` | `6.89 MB` (458ms 576μs) | `6.89 MB` (1s 491ms 621μs) |
474
| `{1..100000}` | `588.89 kB` (20ms 728μs) | `588.89 kB` (156ms 919μs) |
475
| `{1..10000}` | `48.89 kB` (2ms 202μs) | `48.89 kB` (13ms 641μs) |
476
| `{1..1000}` | `3.89 kB` (1ms 796μs) | `3.89 kB` (1ms 958μs) |
477
| `{1..100}` | `291 B` (424μs) | `291 B` (211μs) |
478
| `{1..10}` | `20 B` (487μs) | `20 B` (72μs) |
479
| `{1..3}` | `5 B` (166μs) | `5 B` (27μs) |
480
481
If you'd like to run these comparisons yourself, see [test/support/generate.js](test/support/generate.js).
482
483
## Benchmarks
484
485
### Running benchmarks
486
487
Install dev dependencies:
488
489
```bash
490
npm i -d && npm benchmark
491
```
492
493
### Latest results
494
495
```bash
496
Benchmarking: (8 of 8)
497
 · combination-nested
498
 · combination
499
 · escaped
500
 · list-basic
501
 · list-multiple
502
 · no-braces
503
 · sequence-basic
504
 · sequence-multiple
505
506
# benchmark/fixtures/combination-nested.js (52 bytes)
507
  brace-expansion x 4,756 ops/sec ±1.09% (86 runs sampled)
508
  braces x 11,202,303 ops/sec ±1.06% (88 runs sampled)
509
  minimatch x 4,816 ops/sec ±0.99% (87 runs sampled)
510
511
  fastest is braces
512
513
# benchmark/fixtures/combination.js (51 bytes)
514
  brace-expansion x 625 ops/sec ±0.87% (87 runs sampled)
515
  braces x 11,031,884 ops/sec ±0.72% (90 runs sampled)
516
  minimatch x 637 ops/sec ±0.84% (88 runs sampled)
517
518
  fastest is braces
519
520
# benchmark/fixtures/escaped.js (44 bytes)
521
  brace-expansion x 163,325 ops/sec ±1.05% (87 runs sampled)
522
  braces x 10,655,071 ops/sec ±1.22% (88 runs sampled)
523
  minimatch x 147,495 ops/sec ±0.96% (88 runs sampled)
524
525
  fastest is braces
526
527
# benchmark/fixtures/list-basic.js (40 bytes)
528
  brace-expansion x 99,726 ops/sec ±1.07% (83 runs sampled)
529
  braces x 10,596,584 ops/sec ±0.98% (88 runs sampled)
530
  minimatch x 100,069 ops/sec ±1.17% (86 runs sampled)
531
532
  fastest is braces
533
534
# benchmark/fixtures/list-multiple.js (52 bytes)
535
  brace-expansion x 34,348 ops/sec ±1.08% (88 runs sampled)
536
  braces x 9,264,131 ops/sec ±1.12% (88 runs sampled)
537
  minimatch x 34,893 ops/sec ±0.87% (87 runs sampled)
538
539
  fastest is braces
540
541
# benchmark/fixtures/no-braces.js (48 bytes)
542
  brace-expansion x 275,368 ops/sec ±1.18% (89 runs sampled)
543
  braces x 9,134,677 ops/sec ±0.95% (88 runs sampled)
544
  minimatch x 3,755,954 ops/sec ±1.13% (89 runs sampled)
545
546
  fastest is braces
547
548
# benchmark/fixtures/sequence-basic.js (41 bytes)
549
  brace-expansion x 5,492 ops/sec ±1.35% (87 runs sampled)
550
  braces x 8,485,034 ops/sec ±1.28% (89 runs sampled)
551
  minimatch x 5,341 ops/sec ±1.17% (87 runs sampled)
552
553
  fastest is braces
554
555
# benchmark/fixtures/sequence-multiple.js (51 bytes)
556
  brace-expansion x 116 ops/sec ±0.77% (77 runs sampled)
557
  braces x 9,445,118 ops/sec ±1.32% (84 runs sampled)
558
  minimatch x 109 ops/sec ±1.16% (76 runs sampled)
559
560
  fastest is braces
561
```
562
563
## About
564
565
<details>
566
<summary><strong>Contributing</strong></summary>
567
568
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
569
570
</details>
571
572
<details>
573
<summary><strong>Running Tests</strong></summary>
574
575
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:
576
577
```sh
578
$ npm install && npm test
579
```
580
581
</details>
582
583
<details>
584
<summary><strong>Building docs</strong></summary>
585
586
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
587
588
To generate the readme, run the following command:
589
590
```sh
591
$ npm install -g verbose/verb#dev verb-generate-readme && verb
592
```
593
594
</details>
595
596
### Related projects
597
598
You might also be interested in these projects:
599
600
* [expand-brackets](https://www.npmjs.com/package/expand-brackets): Expand POSIX bracket expressions (character classes) in glob patterns. | [homepage](https://github.com/jonschlinkert/expand-brackets "Expand POSIX bracket expressions (character classes) in glob patterns.")
601
* [extglob](https://www.npmjs.com/package/extglob): Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob… [more](https://github.com/micromatch/extglob) | [homepage](https://github.com/micromatch/extglob "Extended glob support for JavaScript. Adds (almost) the expressive power of regular expressions to glob patterns.")
602
* [fill-range](https://www.npmjs.com/package/fill-range): Fill in a range of numbers or letters, optionally passing an increment or `step` to… [more](https://github.com/jonschlinkert/fill-range) | [homepage](https://github.com/jonschlinkert/fill-range "Fill in a range of numbers or letters, optionally passing an increment or `step` to use, or create a regex-compatible range with `options.toRegex`")
603
* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")
604
* [nanomatch](https://www.npmjs.com/package/nanomatch): Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash… [more](https://github.com/micromatch/nanomatch) | [homepage](https://github.com/micromatch/nanomatch "Fast, minimal glob matcher for node.js. Similar to micromatch, minimatch and multimatch, but complete Bash 4.3 wildcard support only (no support for exglobs, posix brackets or braces)")
605
606
### Contributors
607
608
| **Commits** | **Contributor** | 
609
| --- | --- |
610
| 188 | [jonschlinkert](https://github.com/jonschlinkert) |
611
| 4 | [doowb](https://github.com/doowb) |
612
| 1 | [es128](https://github.com/es128) |
613
| 1 | [eush77](https://github.com/eush77) |
614
| 1 | [hemanth](https://github.com/hemanth) |
615
616
### Author
617
618
**Jon Schlinkert**
619
620
* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)
621
* [github/jonschlinkert](https://github.com/jonschlinkert)
622
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
623
624
### License
625
626
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
627
Released under the [MIT License](LICENSE).
628
629
***
630
631
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on February 17, 2018._
632
633
<hr class="footnotes-sep">
634
<section class="footnotes">
635
<ol class="footnotes-list">
636
<li id="fn1"  class="footnote-item">this is the largest safe integer allowed in JavaScript. <a href="#fnref1" class="footnote-backref"></a>
637
638
</li>
639
</ol>
640
</section>