| 'use strict'; |
| |
| /** |
| * Module dependencies |
| */ |
| |
| var toRegex = require('to-regex'); |
| var unique = require('array-unique'); |
| var extend = require('extend-shallow'); |
| |
| /** |
| * Local dependencies |
| */ |
| |
| var compilers = require('./lib/compilers'); |
| var parsers = require('./lib/parsers'); |
| var Braces = require('./lib/braces'); |
| var utils = require('./lib/utils'); |
| var MAX_LENGTH = 1024 * 64; |
| var cache = {}; |
| |
| /** |
| * Convert the given `braces` pattern into a regex-compatible string. By default, only one string is generated for every input string. Set `options.expand` to true to return an array of patterns (similar to Bash or minimatch. Before using `options.expand`, it's recommended that you read the [performance notes](#performance)). |
| * |
| * ```js |
| * var braces = require('braces'); |
| * console.log(braces('{a,b,c}')); |
| * //=> ['(a|b|c)'] |
| * |
| * console.log(braces('{a,b,c}', {expand: true})); |
| * //=> ['a', 'b', 'c'] |
| * ``` |
| * @param {String} `str` |
| * @param {Object} `options` |
| * @return {String} |
| * @api public |
| */ |
| |
| function braces(pattern, options) { |
| var key = utils.createKey(String(pattern), options); |
| var arr = []; |
| |
| var disabled = options && options.cache === false; |
| if (!disabled && cache.hasOwnProperty(key)) { |
| return cache[key]; |
| } |
| |
| if (Array.isArray(pattern)) { |
| for (var i = 0; i < pattern.length; i++) { |
| arr.push.apply(arr, braces.create(pattern[i], options)); |
| } |
| } else { |
| arr = braces.create(pattern, options); |
| } |
| |
| if (options && options.nodupes === true) { |
| arr = unique(arr); |
| } |
| |
| if (!disabled) { |
| cache[key] = arr; |
| } |
| return arr; |
| } |
| |
| /** |
| * Expands a brace pattern into an array. This method is called by the main [braces](#braces) function when `options.expand` is true. Before using this method it's recommended that you read the [performance notes](#performance)) and advantages of using [.optimize](#optimize) instead. |
| * |
| * ```js |
| * var braces = require('braces'); |
| * console.log(braces.expand('a/{b,c}/d')); |
| * //=> ['a/b/d', 'a/c/d']; |
| * ``` |
| * @param {String} `pattern` Brace pattern |
| * @param {Object} `options` |
| * @return {Array} Returns an array of expanded values. |
| * @api public |
| */ |
| |
| braces.expand = function(pattern, options) { |
| return braces.create(pattern, extend({}, options, {expand: true})); |
| }; |
| |
| /** |
| * Expands a brace pattern into a regex-compatible, optimized string. This method is called by the main [braces](#braces) function by default. |
| * |
| * ```js |
| * var braces = require('braces'); |
| * console.log(braces.expand('a/{b,c}/d')); |
| * //=> ['a/(b|c)/d'] |
| * ``` |
| * @param {String} `pattern` Brace pattern |
| * @param {Object} `options` |
| * @return {Array} Returns an array of expanded values. |
| * @api public |
| */ |
| |
| braces.optimize = function(pattern, options) { |
| return braces.create(pattern, options); |
| }; |
| |
| /** |
| * Processes a brace pattern and returns either an expanded array (if `options.expand` is true), a highly optimized regex-compatible string. This method is called by the main [braces](#braces) function. |
| * |
| * ```js |
| * var braces = require('braces'); |
| * console.log(braces.create('user-{200..300}/project-{a,b,c}-{1..10}')) |
| * //=> 'user-(20[0-9]|2[1-9][0-9]|300)/project-(a|b|c)-([1-9]|10)' |
| * ``` |
| * @param {String} `pattern` Brace pattern |
| * @param {Object} `options` |
| * @return {Array} Returns an array of expanded values. |
| * @api public |
| */ |
| |
| braces.create = function(pattern, options) { |
| if (typeof pattern !== 'string') { |
| throw new TypeError('expected a string'); |
| } |
| |
| var maxLength = (options && options.maxLength) || MAX_LENGTH; |
| if (pattern.length >= maxLength) { |
| throw new Error('expected pattern to be less than ' + maxLength + ' characters'); |
| } |
| |
| function create() { |
| if (pattern === '' || pattern.length < 3) { |
| return [pattern]; |
| } |
| |
| if (utils.isEmptySets(pattern)) { |
| return []; |
| } |
| |
| if (utils.isQuotedString(pattern)) { |
| return [pattern.slice(1, -1)]; |
| } |
| |
| var proto = new Braces(options); |
| var result = !options || options.expand !== true |
| ? proto.optimize(pattern, options) |
| : proto.expand(pattern, options); |
| |
| // get the generated pattern(s) |
| var arr = result.output; |
| |
| // filter out empty strings if specified |
| if (options && options.noempty === true) { |
| arr = arr.filter(Boolean); |
| } |
| |
| // filter out duplicates if specified |
| if (options && options.nodupes === true) { |
| arr = unique(arr); |
| } |
| |
| Object.defineProperty(arr, 'result', { |
| enumerable: false, |
| value: result |
| }); |
| |
| return arr; |
| } |
| |
| return memoize('create', pattern, options, create); |
| }; |
| |
| /** |
| * Create a regular expression from the given string `pattern`. |
| * |
| * ```js |
| * var braces = require('braces'); |
| * |
| * console.log(braces.makeRe('id-{200..300}')); |
| * //=> /^(?:id-(20[0-9]|2[1-9][0-9]|300))$/ |
| * ``` |
| * @param {String} `pattern` The pattern to convert to regex. |
| * @param {Object} `options` |
| * @return {RegExp} |
| * @api public |
| */ |
| |
| braces.makeRe = function(pattern, options) { |
| if (typeof pattern !== 'string') { |
| throw new TypeError('expected a string'); |
| } |
| |
| var maxLength = (options && options.maxLength) || MAX_LENGTH; |
| if (pattern.length >= maxLength) { |
| throw new Error('expected pattern to be less than ' + maxLength + ' characters'); |
| } |
| |
| function makeRe() { |
| var arr = braces(pattern, options); |
| var opts = extend({strictErrors: false}, options); |
| return toRegex(arr, opts); |
| } |
| |
| return memoize('makeRe', pattern, options, makeRe); |
| }; |
| |
| /** |
| * Parse the given `str` with the given `options`. |
| * |
| * ```js |
| * var braces = require('braces'); |
| * var ast = braces.parse('a/{b,c}/d'); |
| * console.log(ast); |
| * // { type: 'root', |
| * // errors: [], |
| * // input: 'a/{b,c}/d', |
| * // nodes: |
| * // [ { type: 'bos', val: '' }, |
| * // { type: 'text', val: 'a/' }, |
| * // { type: 'brace', |
| * // nodes: |
| * // [ { type: 'brace.open', val: '{' }, |
| * // { type: 'text', val: 'b,c' }, |
| * // { type: 'brace.close', val: '}' } ] }, |
| * // { type: 'text', val: '/d' }, |
| * // { type: 'eos', val: '' } ] } |
| * ``` |
| * @param {String} `pattern` Brace pattern to parse |
| * @param {Object} `options` |
| * @return {Object} Returns an AST |
| * @api public |
| */ |
| |
| braces.parse = function(pattern, options) { |
| var proto = new Braces(options); |
| return proto.parse(pattern, options); |
| }; |
| |
| /** |
| * Compile the given `ast` or string with the given `options`. |
| * |
| * ```js |
| * var braces = require('braces'); |
| * var ast = braces.parse('a/{b,c}/d'); |
| * console.log(braces.compile(ast)); |
| * // { options: { source: 'string' }, |
| * // state: {}, |
| * // compilers: |
| * // { eos: [Function], |
| * // noop: [Function], |
| * // bos: [Function], |
| * // brace: [Function], |
| * // 'brace.open': [Function], |
| * // text: [Function], |
| * // 'brace.close': [Function] }, |
| * // output: [ 'a/(b|c)/d' ], |
| * // ast: |
| * // { ... }, |
| * // parsingErrors: [] } |
| * ``` |
| * @param {Object|String} `ast` AST from [.parse](#parse). If a string is passed it will be parsed first. |
| * @param {Object} `options` |
| * @return {Object} Returns an object that has an `output` property with the compiled string. |
| * @api public |
| */ |
| |
| braces.compile = function(ast, options) { |
| var proto = new Braces(options); |
| return proto.compile(ast, options); |
| }; |
| |
| /** |
| * Clear the regex cache. |
| * |
| * ```js |
| * braces.clearCache(); |
| * ``` |
| * @api public |
| */ |
| |
| braces.clearCache = function() { |
| cache = braces.cache = {}; |
| }; |
| |
| /** |
| * Memoize a generated regex or function. A unique key is generated |
| * from the method name, pattern, and user-defined options. Set |
| * options.memoize to false to disable. |
| */ |
| |
| function memoize(type, pattern, options, fn) { |
| var key = utils.createKey(type + ':' + pattern, options); |
| var disabled = options && options.cache === false; |
| if (disabled) { |
| braces.clearCache(); |
| return fn(pattern, options); |
| } |
| |
| if (cache.hasOwnProperty(key)) { |
| return cache[key]; |
| } |
| |
| var res = fn(pattern, options); |
| cache[key] = res; |
| return res; |
| } |
| |
| /** |
| * Expose `Braces` constructor and methods |
| * @type {Function} |
| */ |
| |
| braces.Braces = Braces; |
| braces.compilers = compilers; |
| braces.parsers = parsers; |
| braces.cache = cache; |
| |
| /** |
| * Expose `braces` |
| * @type {Function} |
| */ |
| |
| module.exports = braces; |