diff options
Diffstat (limited to 'node_modules/regjsgen/README.md')
-rw-r--r-- | node_modules/regjsgen/README.md | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/node_modules/regjsgen/README.md b/node_modules/regjsgen/README.md new file mode 100644 index 0000000..0a4dcd0 --- /dev/null +++ b/node_modules/regjsgen/README.md @@ -0,0 +1,60 @@ +# RegJSGen + +Generate `RegExp`s from [RegJSParser](https://github.com/jviereck/regjsparser)’s AST. + +## Installation + +```bash +npm install --save regjsgen +``` + +## Usage + +```js +var regjsgen = require('regjsgen'); +// With `regjsparser` +var regjsparser = require('regjsparser'); +var regex = '^a$'; +var ast = regjsparser.parse(regex); +// Modify AST +// ... +// Regenerate `RegExp` +regex = regjsgen.generate(ast); +``` + +## See Also + + * [RegJSParser](https://github.com/jviereck/regjsparser) + * [RegExp.js](https://github.com/jviereck/regexp.js) + +## Testing + +Run the command + +```bash +npm test +``` + +To create a new reference file, execute + +```bash +node test/update-fixture.js +``` + +from the repo top directory. + +## Support + +Tested in Node.js 0.8.26~0.10.30. + +## Author + +| [](https://twitter.com/demoneaux "Follow @demoneaux on Twitter") | +|---| +| [Benjamin Tan](http://d10.github.io/) | + +## Contributors + +| [](https://twitter.com/mathias "Follow @mathias on Twitter") | +|---| +| [Mathias Bynens](http://mathiasbynens.be/) | |