Files
OpenMaopaoya/frontend-uni/node_modules/brace-expansion/README.md
T

6.0 KiB

brace-expansion

Brace expansion, as known from sh/bash, in JavaScript.

build status downloads Greenkeeper badge

testling badge

Example

var expand = require('brace-expansion')

expand('file-{a,b,c}.jpg')
// => ['file-a.jpg', 'file-b.jpg', 'file-c.jpg']

expand('-v{,,}')
// => ['-v', '-v', '-v']

expand('file{0..2}.jpg')
// => ['file0.jpg', 'file1.jpg', 'file2.jpg']

expand('file-{a..c}.jpg')
// => ['file-a.jpg', 'file-b.jpg', 'file-c.jpg']

expand('file{2..0}.jpg')
// => ['file2.jpg', 'file1.jpg', 'file0.jpg']

expand('file{0..4..2}.jpg')
// => ['file0.jpg', 'file2.jpg', 'file4.jpg']

expand('file-{a..e..2}.jpg')
// => ['file-a.jpg', 'file-c.jpg', 'file-e.jpg']

expand('file{00..10..5}.jpg')
// => ['file00.jpg', 'file05.jpg', 'file10.jpg']

expand('{{A..C},{a..c}}')
// => ['A', 'B', 'C', 'a', 'b', 'c']

expand('ppp{,config,oe{,conf}}')
// => ['ppp', 'pppconfig', 'pppoe', 'pppoeconf']

API

var expand = require('brace-expansion')

var expanded = expand(str, [options])

Return an array of all possible and valid expansions of str. If none are found, [str] is returned.

The options object can provide a max value to cap the number of expansions allowed. This is limited to 100_000 by default, to prevent DoS attacks.

const expansions = expand('{1..100}'.repeat(5), {
  max: 100,
})
// expansions.length will be 100, not 100^5

The options object can also provide a maxLength value to cap the total number of characters across all expansions. This is limited to 4_000_000 by default, to prevent memory exhaustion from inputs whose result count stays under max while each result grows very long.

const expansions = expand('{a,b}'.repeat(1500), {
  maxLength: 10_000,
})

Three more options bound the work a call does rather than its output. Past each of them, the part of str that is left comes back literally instead of being expanded, and nothing is thrown.

  • maxDepth caps how deeply nested brace sets are followed. This is limited to 1_000 by default, to prevent stack exhaustion.
  • maxRewrites caps how many times Bash's {a},b} quirk, where a brace set followed by a comma set still expands, may restart the parse. This is limited to 1_000 by default.
  • maxSteps caps the total work: each character the parser scans, each result it builds and each sequence value it generates is one step, a zero-padded value is one per character, and each string it starts expanding, str itself or a member of a brace set, costs 16 more. This is limited to 20_000_000 by default, which takes well under a second to spend, to prevent CPU exhaustion. Ordinary patterns need a few hundred steps, and nesting to the full maxDepth about 4 million. If you raise max or maxLength, raise this too.

When maxSteps runs out partway, the top-level brace sets before the point where it ran out stay expanded, so the result can be partly expanded rather than [str]:

expand('{a,b}' + '{'.repeat(10_000) + 'c,d' + '}'.repeat(10_000))
// ['a{{{...c,d...}}}', 'b{{{...c,d...}}}']

Pass Infinity to lift any of these bounds.

Valid expansions are:

;/^(.*,)+(.+)?$/
// {a,b,...}

A comma separated list of options, like {a,b} or {a,{b,c}} or {,a,}.

;/^-?\d+\.\.-?\d+(\.\.-?\d+)?$/
// {x..y[..incr]}

A numeric sequence from x to y inclusive, with optional increment. If x or y start with a leading 0, all the numbers will be padded to have equal length. Negative numbers and backwards iteration work too.

;/^-?\d+\.\.-?\d+(\.\.-?\d+)?$/
// {x..y[..incr]}

An alphabetic sequence from x to y inclusive, with optional increment. x and y must be exactly one character, and if given, incr must be a number.

For compatibility reasons, the string ${ is not eligible for brace expansion.

Installation

With npm do:

npm install brace-expansion

Contributors

Sponsors

This module is proudly supported by my Sponsors!

Do you want to support modules like this to improve their quality, stability and weigh in on new features? Then please consider donating to my Patreon. Not sure how much of my modules you're using? Try feross/thanks!

License

(MIT)

Copyright (c) 2013 Julian Gruber <julian@juliangruber.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.