Regex​Lab

**Custom active** (auto-loaded on startup):

**Disabled** (ignored, not loaded):

**Enable/disable portfolios:**
- Use Portfolio Manager (`Ctrl+K, Ctrl+P`) → "Enable/Disable Portfolio"
- Or drag `.json` files between `portfolios/` and `disabled_portfolios/`

**Create new portfolio:**
- Command Palette → "RegexLab: New Portfolio"
- Follow the 5-step wizard (name, description, author, tags, confirmation)
- Portfolio automatically saved to `User/RegexLab/portfolios/`

📖 **Learn more**: [Portfolio Management Guide](data/portfolios/README.md)

### Working with Dynamic Variables

Dynamic patterns use variables that are resolved when you load the pattern. Think of them as **reusable templates**.

**Example pattern:**
```regex
\[{{LEVEL}}\] {{DATE}} - {{MESSAGE}}

#### Built-in variables (auto-filled behavior)

The following variables are auto-filled with the current date/time by default. You can adjust their formats in `RegexLab.sublime-settings`:

- `{{DATE}}` — Uses `variables.date_format` (default: `%Y-%m-%d`). Default value is `"NOW"` via `variables_assertion.DATE.default`.
- `{{TIME}}` — Uses `variables.time_format` (default: `%H:%M:%S`). Default value is `"NOW"` via `variables_assertion.TIME.default`.

Note: These built-in defaults are provided out of the box and can be overridden in `RegexLab.sublime-settings`. For other variables (e.g., `{{USERNAME}}`, `{{LEVEL}}`, `{{EMAIL}}`, `{{IP}}`, `{{PORT}}`, `{{UUID}}`), prompting and validation are fully controlled by your `variables_assertion` configuration.

#### Custom Variables

You can use **any variable name** you want:
- `{{TASK}}`, `{{PRIORITY}}`, `{{AUTHOR}}`, `{{SERVER}}`, etc.
- RegexLab prompts you for the value when loading the pattern
- No pre-configuration needed ; just use them!

#### Variable Validation (Optional)

Want to **validate user input** for variables? Define constraints in settings!

**Example:** Force `{{DATE}}` to be in `YYYY-MM-DD` format:

```json
// Settings: Preferences > Package Settings > RegexLab > Settings
{
    "variables_assertion": {
        "DATE": {
            "regex": "[0-9]{4}-[0-9]{2}-[0-9]{2}",
            "default": "NOW",
            "hint": "YYYY-MM-DD format",
            "example": "2025-10-26"
        },
        "LEVEL": {
            "regex": "DEBUG|INFO|WARN|ERROR",
            "default": "INFO",
            "hint": "Log severity level",
            "example": "DEBUG, INFO, WARN, ERROR"
        }
    }
}

#### Configure Date/Time Formats

Customize how `{{DATE}}`, `{{TIME}}`, and `{{DATETIME}}` are formatted:

```json
{
    "variables": {
        "date_format": "%Y-%m-%d",           // Default: 2025-10-26
        "time_format": "%H:%M:%S",           // Default: 15:30:45
        "datetime_format": "%Y-%m-%d %H:%M:%S"  // Default: 2025-10-26 15:30:45
    }
}

{
    "name": "My Custom Portfolio",
    "description": "Project-specific patterns",
    "version": "1.0.0",
    "author": "Your Name",
    "readonly": false,
    "patterns": [
        {
            "name": "API Endpoint",
            "regex": "/api/v\\d+/[\\w/-]+",
            "type": "static",
            "description": "Match REST API endpoints"
        },
        {
            "name": "Email Finder",
            "regex": "[a-z0-9._%+-]+@[a-z0-9.-]+\\.[a-z]{2,}",
            "type": "static",
            "description": "Find emails across files",
            "default_panel": "find_in_files"
        }
    ]
}

### Performance Benchmarks

RegexLab is **blazing fast** with enterprise-grade optimizations:

- ⚡ **333x speedup** on `Pattern.variables` (3.33µs vs 1.11ms)
  - Cached property optimization → O(1) after first access
- ⚡ **13x speedup** on `Pattern.resolve()` (76.9µs vs 1ms)
  - Pre-compiled regex patterns → zero runtime compilation

### Code Quality

- ✅ **CCode audit score: 9.8/10** (production-ready)
- ✅ Zero memory leaks detected
- ✅ <1% code duplication
- ✅ 100% type hints (mypy strict mode)
- ✅ Cross-platform validated (Windows, Linux, macOS)

### Memory Safety

- 🛡️ OOM protection for clipboard operations (10MB limit)
- 🛡️ Defensive programming for edge cases
- 🛡️ Proper resource cleanup (no file handle leaks)

---

## 🌟 Community Portfolios

Got a useful portfolio to share? The community would love to see it!

### Share Your Portfolio

**How to share:**

1. **Create a Gist**: Upload your portfolio JSON to [GitHub Gist](https://gist.github.com)
2. **Share it**: Post the link in [GitHub Discussions](https://github.com/KaminoU/RegexLab/discussions) (coming soon!)
3. **Tag it**: Add relevant tags (Python, Web, DevOps, Data Science, etc.)

**What makes a good community portfolio?**
- 🎯 Focused on a specific domain or use case
- 📝 Well-documented patterns with clear descriptions
- ✅ Tested and verified regex patterns
- 💡 Solves real-world problems

### Featured Community Portfolios

Coming soon! Be the first to share yours! 🚀

**How to use community portfolios:**

1. Download the JSON file from the gist
2. Save it to `User/RegexLab/portfolios/`
3. Restart Sublime Text or reload portfolios (`Ctrl+K, Ctrl+P` → "Reload Portfolios")

**Popular ideas for portfolios:**
- Python/Django patterns (imports, decorators, ORM queries)
- Web scraping toolkit (HTML tags, data extraction)
- Data science patterns (CSV, JSON, scientific notation)
- DevOps/Infrastructure (config files, YAML, Docker)
- Security/Forensics (IP addresses, credentials, hashes)

**Best portfolios may be included in future builtin releases!** 🏆

---

## 🤝 Contributing

Contributions are super welcome! 🎉

**Before you start**, please read our [Contributing Guide](https://github.com/KaminoU/RegexLab/blob/main/.github/CONTRIBUTING.md) for:
- Code style guidelines
- Testing requirements
- Pull request process
- Development setup

### Quick Development Setup

```bash
# Clone the repository
git clone https://github.com/KaminoU/RegexLab.git
cd RegexLab

# Install tox (if not already installed)
pip install tox

# Run full test suite (Python 3.8 + 3.13, linting, type checking)
tox

# Run specific tests
tox -e py38-core     # Tests on Python 3.8
tox -e py313-core    # Tests on Python 3.13
tox -e lint          # Linting only (ruff)
tox -e typecheck     # Type checking only (mypy)

# Quick development workflow
pytest tests/ -v     # Run all tests
ruff check src/ tests/ --diff  # Lint (matches CI guardrail)
mypy src/            # Type check

# WSL2/headless testing (no Sublime Text UI)
bash scripts/test-wsl2.sh     # Linux/WSL2
pwsh scripts/test-wsl2.ps1    # PowerShell