57 lines
1.0 KiB
Markdown
57 lines
1.0 KiB
Markdown
# RegJSParser
|
|
|
|
Parsing the JavaScript's RegExp in JavaScript.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install regjsparser
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
var parse = require('regjsparser').parse;
|
|
|
|
var parseTree = parse('^a'); // /^a/
|
|
console.log(parseTree);
|
|
|
|
// Toggle on/off additional features:
|
|
var parseTree = parse('^a', '', {
|
|
// SEE: https://github.com/jviereck/regjsparser/pull/78
|
|
unicodePropertyEscape: true,
|
|
|
|
// SEE: https://github.com/jviereck/regjsparser/pull/83
|
|
namedGroups: true,
|
|
|
|
// SEE: https://github.com/jviereck/regjsparser/pull/89
|
|
lookbehind: true,
|
|
|
|
// SEE: https://github.com/jviereck/regjsparser/pull/113
|
|
unicodeSet: true,
|
|
|
|
// SEE: https://github.com/jviereck/regjsparser/pull/127
|
|
modifiers: true,
|
|
|
|
// SEE: https://github.com/jviereck/regjsparser/pull/166
|
|
bufferBoundaries: true
|
|
});
|
|
console.log(parseTree);
|
|
```
|
|
|
|
## Testing
|
|
|
|
To run the tests, run the following command:
|
|
|
|
```bash
|
|
npm test
|
|
```
|
|
|
|
To create a new reference file, execute…
|
|
|
|
```bash
|
|
node test/update-fixtures.js
|
|
```
|
|
|
|
…from the repo top directory.
|