Merge pull request #74 from yoeunes/dev

Improves regex parser with CLI tool, highlighting, and more

Author: yoeunes

.aiassistant/rules/ProjectRules.md

@@ -23,8 +23,10 @@
 - [Advanced Usage](#advanced-usage)
   - [Parsing bare patterns vs PCRE strings](#parsing-bare-patterns-vs-pcre-strings)
   - [Working with the AST](#working-with-the-ast)
-  - [Writing a custom AST visitor](#writing-a-custom-ast-visitor)
-  - [Optimizing and recompiling patterns](#optimizing-and-recompiling-patterns)
+   - [Writing a custom AST visitor](#writing-a-custom-ast-visitor)
+   - [Optimizing and recompiling patterns](#optimizing-and-recompiling-patterns)
+   - [Auto-Modernize Legacy Patterns](#auto-modernize-legacy-patterns)
+   - [Syntax Highlighting](#syntax-highlighting)
 - [ReDoS Analysis](#redos-analysis)
   - [What is ReDoS?](#what-is-redos)
   - [How RegexParser detects it](#how-regexparser-detects-it)
@@ -321,6 +323,58 @@ This makes it easy to implement automated refactorings (via Rector) or style rul
 
 ---
 
+## ✨ Auto-Modernize Legacy Patterns
+
+Clean up messy or legacy regexes automatically:
+
+```php
+use RegexParser\Regex;
+
+$regex = Regex::create();
+$modern = $regex->modernize('/[0-9]+\-[a-z]+\@(?:gmail)\.com/');
+
+echo $modern; // Outputs: /\d+-[a-z]+@gmail\.com/
+```
+
+**What it does:**
+- Converts `[0-9]` → `\d`, `[a-zA-Z0-9_]` → `\w`, `[\t\n\r\f\v]` → `\s`
+- Removes unnecessary escaping (e.g., `\@` → `@`)
+- Modernizes backrefs (`\1` → `\g{1}`)
+- Preserves exact behavior — no functional changes
+
+Perfect for refactoring legacy codebases or cleaning up generated patterns.
+
+---
+
+## 🎨 Syntax Highlighting
+
+Make complex regexes readable with automatic syntax highlighting:
+
+```php
+use RegexParser\Regex;
+
+$regex = Regex::create();
+
+// For console output
+echo $regex->highlightCli('/^[0-9]+(\w+)$/');
+// Outputs: ^[0-9]+(\w+)$ with ANSI colors
+
+// For web display
+echo $regex->highlightHtml('/^[0-9]+(\w+)$/');
+// Outputs: <span class="regex-anchor">^</span>[<span class="regex-type">\d</span>]+(<span class="regex-type">\w</span>+)$
+```
+
+**Color Scheme:**
+- **Meta-characters** (`(`, `)`, `|`, `[`, `]`): Blue - Structure
+- **Quantifiers** (`*`, `+`, `?`, `{...}`): Yellow - Repetition
+- **Escapes/Types** (`\d`, `\w`, `\n`): Green - Special chars
+- **Anchors/Assertions** (`^`, `$`, `\b`): Magenta - Boundaries
+- **Literals**: Default - Plain text
+
+HTML output uses `<span class="regex-*">` classes for easy styling.
+
+---
+
 ## ReDoS Analysis
 
 ### What is ReDoS?
@@ -519,6 +573,18 @@ If you maintain custom visitors, plan to adjust them when new nodes appear. Brea
 
 ---
 
+## Known Limitations
+
+While this library supports a comprehensive set of PCRE2 features, some highly specific or experimental features may not be fully supported yet. For example:
+
+- Certain Perl-specific verbs not yet standardized in PCRE2.
+- Advanced Unicode features beyond basic properties and escapes.
+- Experimental or platform-specific extensions.
+
+If you encounter an unsupported feature, please [open an issue](https://github.com/yoeunes/regex-parser/issues) with a test case.
+
+---
+
 ## Contributing
 
 Contributions are welcome! Areas where help is especially useful:

.aiexclude

@@ -0,0 +1,7 @@
+# TODO Items for Future Releases
+
+## SampleGeneratorNodeVisitor
+- Implement proper Unicode name to character conversion (line 642)
+
+## ValidatorNodeVisitor
+- Validate that the Unicode name is valid. For now, assume it's correct. (line 569)