1 # braces [![NPM version](https://img.shields.io/npm/v/braces.svg?style=flat)](https://www.npmjs.com/package/braces) [![NPM downloads](https://img.shields.io/npm/dm/braces.svg?style=flat)](https://npmjs.org/package/braces) [![Build Status](https://img.shields.io/travis/jonschlinkert/braces.svg?style=flat)](https://travis-ci.org/jonschlinkert/braces)
3 Fastest brace expansion for node.js, with the most complete support for the Bash 4.3 braces specification.
7 Install with [npm](https://www.npmjs.com/):
10 $ npm install braces --save
15 * Complete support for the braces part of the [Bash 4.3 Brace Expansion](www.gnu.org/software/bash/). Braces passes [all of the relevant unit tests](#bash-4-3-support) from the spec.
16 * Expands comma-separated values: `a/{b,c}/d` => `['a/b/d', 'a/c/d']`
17 * Expands alphabetical or numerical ranges: `{1..3}` => `['1', '2', '3']`
18 * [Very fast](#benchmarks)
19 * [Special characters](./patterns.md) can be used to generate interesting patterns.
24 var braces = require('braces');
26 braces('a/{x,y}/c{d}e')
27 //=> ['a/x/cde', 'a/y/cde']
30 //=> ['a/b/c/x', 'a/b/c/y']
32 braces('a/{x,{1..5},y}/c{d}e')
33 //=> ['a/x/cde', 'a/1/cde', 'a/y/cde', 'a/2/cde', 'a/3/cde', 'a/4/cde', 'a/5/cde']
36 ### Use case: fixtures
38 > Use braces to generate test fixtures!
43 var braces = require('./');
44 var path = require('path');
45 var fs = require('fs');
47 braces('blah/{a..z}.js').forEach(function(fp) {
48 if (!fs.existsSync(path.dirname(fp))) {
49 fs.mkdirSync(path.dirname(fp));
51 fs.writeFileSync(fp, '');
55 See the [tests](./test/test.js) for more examples and use cases (also see the [bash spec tests](./test/bash-mm-adjusted.js));
59 Uses [expand-range](https://github.com/jonschlinkert/expand-range) for range expansion.
63 //=> ['a1b', 'a2b', 'a3b']
66 //=> ['a5b', 'a6b', 'a7b', 'a8b']
69 //=> ['a00b', 'a01b', 'a02b', 'a03b', 'a04b', 'a05b']
72 //=> ['a01b', 'a02b', 'a03b']
74 braces('a{000..005}b')
75 //=> ['a000b', 'a001b', 'a002b', 'a003b', 'a004b', 'a005b']
78 //=> ['aab', 'abb', 'acb', 'adb', 'aeb']
81 //=> ['aAb', 'aBb', 'aCb', 'aDb', 'aEb']
84 Pass a function as the last argument to customize range expansions:
87 var range = braces('x{a..e}y', function (str, i) {
88 return String.fromCharCode(str) + i;
92 //=> ['xa0y', 'xb1y', 'xc2y', 'xd3y', 'xe4y']
95 See [expand-range](https://github.com/jonschlinkert/expand-range) for benchmarks, tests and the full list of range expansion features.
105 Return a regex-optimal string. If you're using braces to generate regex, this will result in dramatically faster performance.
109 With the default settings (`{makeRe: false}`):
113 //=> ['1', '2', '3', '4', '5']
116 With `{makeRe: true}`:
119 braces('{1..5}', {makeRe: true});
122 braces('{3..9..3}', {makeRe: true});
132 Enables complete support for the Bash specification. The downside is a 20-25% speed decrease.
136 Using the default setting (`{bash: false}`):
143 In bash (and minimatch), braces with one item are not expanded. To get the same result with braces, set `{bash: true}`:
146 braces('a{b}c', {bash: true});
156 Duplicates are removed by default. To keep duplicates, pass `{nodupes: false}` on the options
160 > Better support for Bash 4.3 than minimatch
162 This project has comprehensive unit tests, including tests coverted from [Bash 4.3](www.gnu.org/software/bash/). Currently only 8 of 102 unit tests fail, and
166 Install dev dependencies:
169 npm i -d && npm benchmark
176 brace-expansion.js x 114,934 ops/sec ±1.24% (93 runs sampled)
177 braces.js x 342,254 ops/sec ±0.84% (90 runs sampled)
180 brace-expansion.js x 12,359 ops/sec ±0.86% (96 runs sampled)
181 braces.js x 20,389 ops/sec ±0.71% (97 runs sampled)
184 brace-expansion.js x 114,469 ops/sec ±1.44% (94 runs sampled)
185 braces.js x 401,621 ops/sec ±0.87% (91 runs sampled)
188 brace-expansion.js x 102,769 ops/sec ±1.55% (92 runs sampled)
189 braces.js x 314,088 ops/sec ±0.71% (98 runs sampled)
192 brace-expansion.js x 157,577 ops/sec ±1.65% (91 runs sampled)
193 braces.js x 1,115,950 ops/sec ±0.74% (94 runs sampled)
196 brace-expansion.js x 138,822 ops/sec ±1.71% (91 runs sampled)
197 braces.js x 1,108,353 ops/sec ±0.85% (94 runs sampled)
202 You might also be interested in these projects:
204 * [expand-range](https://www.npmjs.com/package/expand-range): Fast, bash-like range expansion. Expand a range of numbers or letters, uppercase or lowercase. See… [more](https://www.npmjs.com/package/expand-range) | [homepage](https://github.com/jonschlinkert/expand-range)
205 * [fill-range](https://www.npmjs.com/package/fill-range): Fill in a range of numbers or letters, optionally passing an increment or multiplier to… [more](https://www.npmjs.com/package/fill-range) | [homepage](https://github.com/jonschlinkert/fill-range)
206 * [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/jonschlinkert/micromatch)
210 Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/braces/issues/new).
214 Generate readme and API documentation with [verb](https://github.com/verbose/verb):
217 $ npm install verb && npm run docs
220 Or, if [verb](https://github.com/verbose/verb) is installed globally:
228 Install dev dependencies:
231 $ npm install -d && npm test
238 * [github/jonschlinkert](https://github.com/jonschlinkert)
239 * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
243 Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
244 Released under the [MIT license](https://github.com/jonschlinkert/braces/blob/master/LICENSE).
248 _This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 21, 2016._