UNPKG

1.87 kBMarkdownView Raw
1# expand-brackets [![NPM version](https://badge.fury.io/js/expand-brackets.svg)](http://badge.fury.io/js/expand-brackets)
2
3> Expand POSIX bracket expressions (character classes) in glob patterns.
4
5## Install with [npm](npmjs.org)
6
7```bash
8npm i expand-brackets --save
9```
10
11## Usage
12
13```js
14var brackets = require('expand-brackets');
15
16brackets('[![:lower:]]');
17//=> '[^a-z]'
18```
19
20## .isMatch
21
22Return true if the given string matches the bracket expression:
23
24```js
25brackets.isMatch('A', '[![:lower:]]');
26//=> true
27
28brackets.isMatch('a', '[![:lower:]]');
29//=> false
30```
31
32## .makeRe
33
34Make a regular expression from a bracket expression:
35
36```js
37brackets.makeRe('[![:lower:]]');
38//=> /[^a-z]/
39```
40
41The following named POSIX bracket expressions are supported:
42
43- `[:alnum:]`: Alphanumeric characters (`a-zA-Z0-9]`)
44- `[:alpha:]`: Alphabetic characters (`a-zA-Z]`)
45- `[:blank:]`: Space and tab (`[ t]`)
46- `[:digit:]`: Digits (`[0-9]`)
47- `[:lower:]`: Lowercase letters (`[a-z]`)
48- `[:punct:]`: Punctuation and symbols. (`[!"#$%&'()*+, -./:;<=>?@ [\]^_``{|}~]`)
49- `[:upper:]`: Uppercase letters (`[A-Z]`)
50- `[:word:]`: Word characters (letters, numbers and underscores) (`[A-Za-z0-9_]`)
51- `[:xdigit:]`: Hexadecimal digits (`[A-Fa-f0-9]`)
52
53Collating sequences are not supported, and probably won't be.
54
55## Run tests
56
57Install dev dependencies:
58
59```bash
60npm i -d && npm test
61```
62
63## Contributing
64Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/expand-brackets/issues)
65
66## Author
67
68**Jon Schlinkert**
69
70+ [github/jonschlinkert](https://github.com/jonschlinkert)
71+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
72
73## License
74Copyright (c) 2015 Jon Schlinkert
75Released under the MIT license
76
77***
78
79_This file was generated by [verb](https://github.com/assemble/verb) on February 11, 2015._