summaryrefslogtreecommitdiff
path: root/node_modules/regjsgen/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/regjsgen/README.md')
-rw-r--r--node_modules/regjsgen/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/node_modules/regjsgen/README.md b/node_modules/regjsgen/README.md
new file mode 100644
index 00000000..9c124211
--- /dev/null
+++ b/node_modules/regjsgen/README.md
@@ -0,0 +1,41 @@
+# regjsgen [![Build status][ci-img]][ci] [![Code coverage status][codecov-img]][codecov]
+
+Generate regular expressions from [regjsparser][regjsparser]’s AST.
+
+## Installation
+
+```sh
+npm i regjsgen
+```
+
+## API
+
+### `regjsgen.generate(ast)`
+
+This function accepts an abstract syntax tree representing a regular expression (see [regjsparser][regjsparser]), and returns the generated regular expression string.
+
+```js
+const regjsparser = require('regjsparser');
+const regjsgen = require('regjsgen');
+
+// Generate an AST with `regjsparser`.
+let ast = regjsparser.parse(regex);
+
+// Modify AST
+// …
+
+// Generate `RegExp` string with `regjsgen`.
+let regex = regjsgen.generate(ast);
+```
+
+## Support
+
+Tested on Node.js 16 and 18.<br>
+Compatible with regjsparser v0.10.0’s AST.
+
+
+[ci]: https://github.com/bnjmnt4n/regjsgen/actions
+[ci-img]: https://github.com/bnjmnt4n/regjsgen/workflows/Node.js%20CI/badge.svg
+[codecov]: https://codecov.io/gh/bnjmnt4n/regjsgen
+[codecov-img]: https://codecov.io/gh/bnjmnt4n/regjsgen/branch/main/graph/badge.svg
+[regjsparser]: https://github.com/jviereck/regjsparser