diff options
| author | littleblack111 <littleblack11111@gmail.com> | 2024-10-13 10:37:19 +0800 |
|---|---|---|
| committer | littleblack111 <littleblack11111@gmail.com> | 2024-10-13 10:37:19 +0800 |
| commit | e29b244aeab08ea36fb385c7beb2ad0560217039 (patch) | |
| tree | c66b744dc29573f1acc871862937a23f1b80e6bf /node_modules/regjsgen/README.md | |
| parent | 62c2881629e6413a8fec6d3dd092e4568e2a81dc (diff) | |
bump: @babel/cli 7.25.6 → 7.25.7, @babel/core 7.25.2 → 7.25.8, @babel/preset-env 7.25.4 → 7.25.8, postcss 8.4.41 → 8.4.47, swup 4.7.0 → 4.8.1
Diffstat (limited to 'node_modules/regjsgen/README.md')
| -rw-r--r-- | node_modules/regjsgen/README.md | 41 |
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 |
