magic-regexp
magic-regexp copied to clipboard
feat: add RegExp converter
๐ Linked issue
Apologies, there's no linked issue, as this was originally a feature for my personal use.
โ Type of change
- [ ] ๐ Documentation (updates to the documentation, readme, or JSdoc annotations)
- [ ] ๐ Bug fix (a non-breaking change that fixes an issue)
- [ ] ๐ Enhancement (improving an existing functionality like performance)
- [x] โจ New feature (a non-breaking change that adds functionality)
- [ ] ๐งน Chore (updates to the build process or auxiliary tools and libraries)
- [ ] โ ๏ธ Breaking change (fix or feature that would cause existing functionality to change)
๐ Description
The purpose of creating this converter is due to some of my projects having a large amount of Regex that are difficult to maintain and read. I hope to revamp them using magic-regexp. However, given the vast and complex quantity of Regex, I aim to facilitate their transformation with this converter.
While developing the converter, I discovered some regex syntaxes not yet supported by magic-regexp. Therefore, I've specifically marked these instances in the code with comments or throw error messages. This is to facilitate future modifications when these features are supported. Hence, this converter might also serve as a tracking tool for a functionality todo list, identifying missing regex features.
If this converter could be developed into a UI and integrated into the documentation page in the future, it might enable developers who are new to magic-regexp to get up to speed more quickly. Additionally, it could also encourage more developers to contribute test cases to the converter.
I believe there are many areas where the current converter can be improved, such as accommodating some unforeseen test cases. I'm uncertain whether I should create a PR for the current progress of the converter into this repository, or if it should be split into a separate project. I would appreciate any advice on this matter.
For details usage description and demo, please refer to ./converter/README.md
.
๐ Checklist
- [ ] I have linked an issue or discussion.
- [ ] I have updated the documentation accordingly.
Goodness, I can't believe I didn't see this previously! Thank you. I'll review more fully later.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 100.00%. Comparing base (
892a9e9
) to head (ed9d2b3
). Report is 2 commits behind head on main.
Additional details and impacted files
@@ Coverage Diff @@
## main #368 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 7 7
Lines 629 629
Branches 65 65
=========================================
Hits 629 629
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.