diff --git a/README.md b/README.md index c9e5b58..4e6c2bd 100644 --- a/README.md +++ b/README.md @@ -1,293 +1,270 @@

- Debugalizers Logo + Debugalizers Logo

-

πŸ” Debugalizers

+

Debugalizers

- Visual Studio 2022 - .NET Framework - License: MIT + A powerful collection of debug visualizers for Visual Studio with beautiful formatting and syntax highlighting

- Marketplace Version - Marketplace Installs - Build Status + + License + + + Build Status +

---- - -A **powerful collection** of debug visualizers for Visual Studio, providing beautiful formatting, syntax highlighting, and specialized views for common string data types. Stop squinting at raw JSON in the debugger! 🎯✨ +

+ + Marketplace Version + + + Marketplace Installations + + + Marketplace Downloads + + + Marketplace Rating + +

--- -## ✨ Updated Interface +## Updated Interface

- Updated Debugalizers Interface -
+ Updated Debugalizers Interface +
The new modern Debugalizers interface

> **Note:** The screenshots below were captured before the UI overhaul. The updated interface shown above features a modernized design with improved theming, rounded corners, and a cleaner layout. All functionality remains the same. ---- - -## πŸ“Έ Screenshots +## Screenshots

- Debugalizers List -
+ Debugalizers List +
Choose from 30+ specialized visualizers

- JSON Formatted View -
+ JSON Formatted View +
JSON - Formatted View 		- XML Pretty View -
+ XML Pretty View +
XML - Pretty Printed
- HTML Formatted View -
+ HTML Formatted View +
HTML - Formatted View 		- HTML Rendered View -
+ HTML Rendered View +
HTML - Rendered Preview
- Markdown Rendered View -
+ Markdown Rendered View +
Markdown - Rendered Preview 		- JWT Claims View -
+ JWT Claims View +
JWT - Claims Table
- Base64 Image View -
+ Base64 Image View +
Base64 - Image Preview 		- URI Table View -
+ URI Table View +
URI - Parsed Components
- Connection String Table View -
+ Connection String Table View +
Connection String - Parsed Table 		- JSON Raw View -
+ JSON Raw View +
JSON - Raw View
---- +## Features -## πŸš€ Features +- **30+ Visualizers** - JSON, XML, JWT, Base64, images, and many more +- **Multiple Views** - Raw, Formatted, Tree, Table, Hex, Rendered, and Image +- **Syntax Highlighting** - Beautiful code highlighting via AvalonEdit +- **Search** - Find text within large content (Ctrl+F) +- **Copy & Export** - Copy raw/formatted content or export to file +- **Multi-Architecture** - Supports both x64 and ARM64 systems -- 🎨 **30+ Visualizers** β€” JSON, XML, JWT, Base64, images, and many more -- 🌳 **Multiple Views** β€” Raw, Formatted, Tree, Table, Hex, Rendered, and Image -- πŸ–ŒοΈ **Syntax Highlighting** β€” Beautiful code highlighting via AvalonEdit -- πŸ”Ž **Search** β€” Find text within large content (Ctrl+F) -- πŸ“‹ **Copy & Export** β€” Copy raw/formatted content or export to file -- πŸ–₯️ **Multi-Architecture** β€” Supports both x64 and ARM64 systems +## Visualizer Catalog ---- - -## πŸ“¦ Visualizer Catalog - -### πŸ“„ Data Formats +### Data Formats | Visualizer | Description | Views | |------------|-------------|-------| -| πŸ“‹ **JSON** | API responses, config files | Formatted, Tree, Raw | -| πŸ“° **XML** | SOAP, config, SVG | Formatted, Tree, Raw | -| 🌐 **HTML** | Web content, email templates | Formatted, Rendered, Tree, Raw | -| βš™οΈ **YAML** | Docker, K8s, CI/CD configs | Formatted, Tree, Raw | -| πŸ”§ **TOML** | Rust configs, pyproject.toml | Formatted, Tree, Raw | -| πŸ“Š **CSV/TSV** | Tabular data exports | Table, Raw | -| πŸ“ **INI** | Legacy config files | Formatted, Table, Raw | -| πŸ“– **Markdown** | Documentation strings | Rendered, Raw | -| πŸ—ƒοΈ **SQL** | Database queries | Formatted, Syntax Highlighted, Raw | -| πŸ”— **GraphQL** | API queries | Formatted, Syntax Highlighted, Raw | - -### πŸ” Encoded Data +| **JSON** | API responses, config files | Formatted, Tree, Raw | +| **XML** | SOAP, config, SVG | Formatted, Tree, Raw | +| **HTML** | Web content, email templates | Formatted, Rendered, Tree, Raw | +| **YAML** | Docker, K8s, CI/CD configs | Formatted, Tree, Raw | +| **TOML** | Rust configs, pyproject.toml | Formatted, Tree, Raw | +| **CSV/TSV** | Tabular data exports | Table, Raw | +| **INI** | Legacy config files | Formatted, Table, Raw | +| **Markdown** | Documentation strings | Rendered, Raw | +| **SQL** | Database queries | Formatted, Syntax Highlighted, Raw | +| **GraphQL** | API queries | Formatted, Syntax Highlighted, Raw | + +### Encoded Data | Visualizer | Description | Views | |------------|-------------|-------| -| πŸ”€ **Base64** | Decode text from Base64 | Decoded, Hex, Raw | -| πŸ–ΌοΈ **Base64 Image** | Embedded images (data:image/...) | Image Preview, Raw | -| πŸ”— **URL Encoded** | Query strings, form data | Decoded, Raw | -| 🏷️ **HTML Entities** | `&` β†’ `&`, `<` β†’ `<` | Decoded, Raw | -| πŸ”‘ **Unicode Escape** | `\u0041` β†’ `A` | Decoded, Raw | -| πŸ”’ **Hex String** | `48656C6C6F` β†’ `Hello` | Decoded, Hex, Raw | -| πŸ“¦ **GZip/Deflate** | Compressed payloads | Decompressed, Raw | +| **Base64** | Decode text from Base64 | Decoded, Hex, Raw | +| **Base64 Image** | Embedded images (data:image/...) | Image Preview, Raw | +| **URL Encoded** | Query strings, form data | Decoded, Raw | +| **HTML Entities** | `&` β†’ `&`, `<` β†’ `<` | Decoded, Raw | +| **Unicode Escape** | `\u0041` β†’ `A` | Decoded, Raw | +| **Hex String** | `48656C6C6F` β†’ `Hello` | Decoded, Hex, Raw | +| **GZip/Deflate** | Compressed payloads | Decompressed, Raw | -### πŸ›‘οΈ Security & Auth Tokens +### Security & Auth Tokens | Visualizer | Description | Views | |------------|-------------|-------| -| 🎫 **JWT** | Decode header, payload, expiry | Claims Table, Decoded, Raw | -| πŸ”‘ **SAML** | Decode assertions | XML Tree, Claims, Raw | -| πŸ“œ **X.509 Certificate** | PEM/DER certificates | Details Table, Raw | +| **JWT** | Decode header, payload, expiry | Claims Table, Decoded, Raw | +| **SAML** | Decode assertions | XML Tree, Claims, Raw | +| **X.509 Certificate** | PEM/DER certificates | Details Table, Raw | -### πŸ”— Structured Strings +### Structured Strings | Visualizer | Description | Views | |------------|-------------|-------| -| πŸ”Œ **Connection String** | DB/service connections | Parsed Table, Raw | -| 🌍 **URI/URL** | Full URL parsing | Parsed Parts, Query Params Table | -| ❓ **Query String** | `?foo=bar&baz=qux` | Key-Value Table, Raw | -| 🎯 **Regex** | Pattern visualization | Pattern Breakdown, Raw | -| ⏰ **Cron Expression** | Schedule expressions | Human Readable, Next Runs | +| **Connection String** | DB/service connections | Parsed Table, Raw | +| **URI/URL** | Full URL parsing | Parsed Parts, Query Params Table | +| **Query String** | `?foo=bar&baz=qux` | Key-Value Table, Raw | +| **Regex** | Pattern visualization | Pattern Breakdown, Raw | +| **Cron Expression** | Schedule expressions | Human Readable, Next Runs | -### πŸ’Ύ Binary & Low-Level +### Binary & Low-Level | Visualizer | Description | Views | |------------|-------------|-------| -| πŸ”’ **Hex Dump** | Binary data as hex | Hex + ASCII | -| πŸ†” **GUID/UUID** | Format and version info | Formatted, Details | -| πŸ• **Timestamp** | Unix epoch conversion | Human Readable, UTC/Local | -| 🌐 **IP Address** | IPv4/IPv6 details | Formatted, CIDR Info | - ---- +| **Hex Dump** | Binary data as hex | Hex + ASCII | +| **GUID/UUID** | Format and version info | Formatted, Details | +| **Timestamp** | Unix epoch conversion | Human Readable, UTC/Local | +| **IP Address** | IPv4/IPv6 details | Formatted, CIDR Info | -## πŸ“₯ Installation +## Installation -### From Visual Studio Marketplace +### Visual Studio Marketplace -[![VS Marketplace](https://img.shields.io/badge/VS%20Marketplace-Debugalizers-purple?style=for-the-badge&logo=visualstudio&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-Debugalizers) - -1. Open Visual Studio 2022 -2. Go to **Extensions** β†’ **Manage Extensions** -3. Search for "**Debugalizers**" +1. Open Visual Studio 2022 or 2026 +2. Go to **Extensions > Manage Extensions** +3. Search for "Debugalizers" 4. Click **Download** and restart Visual Studio -### From Source - -```bash -# 1. Clone the repository -git clone https://github.com/CodingWithCalvin/VS-Debugalizers.git - -# 2. Build the solution -dotnet build src/CodingWithCalvin.Debugalizers.slnx +### Manual Installation -# 3. Run tests -dotnet test src/CodingWithCalvin.Debugalizers.slnx +Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-Debugalizers/releases) page and double-click to install. -# 4. VSIX will be created in bin/Debug or bin/Release -``` +## Usage ---- - -## πŸš€ Usage - -1. πŸ”΄ Set a breakpoint where a string variable is in scope -2. ⏸️ When the debugger hits the breakpoint, hover over the variable -3. πŸ” Click the **magnifying glass** icon in the DataTip -4. πŸ“‹ Select the appropriate visualizer (e.g., "**Debugalizers: JSON**") -5. ✨ The visualizer window opens with beautifully formatted content! +1. Set a breakpoint where a string variable is in scope +2. When the debugger hits the breakpoint, hover over the variable +3. Click the **magnifying glass** icon in the DataTip +4. Select the appropriate visualizer (e.g., "**Debugalizers: JSON**") +5. The visualizer window opens with beautifully formatted content!

- Selecting a Visualizer -
+ Selecting a Visualizer +
Select a visualizer from the list

-### ⌨️ Keyboard Shortcuts +### Keyboard Shortcuts | Shortcut | Action | |----------|--------| -| `Ctrl+F` | πŸ”Ž Search within content | -| `Escape` | ❌ Close visualizer window | +| `Ctrl+F` | Search within content | +| `Escape` | Close visualizer window | -### πŸ› οΈ Toolbar Actions +### Toolbar Actions | Button | Action | |--------|--------| -| πŸ“‹ **Copy** | Copy raw content to clipboard | -| πŸ“ **Copy Formatted** | Copy formatted content to clipboard | -| πŸ’Ύ **Export** | Save content to a file | -| ↩️ **Word Wrap** | Toggle word wrapping | - ---- - -## πŸ“‹ Requirements +| **Copy** | Copy raw content to clipboard | +| **Copy Formatted** | Copy formatted content to clipboard | +| **Export** | Save content to a file | +| **Word Wrap** | Toggle word wrapping | -- πŸ’» Visual Studio 2022 (17.8) or later -- πŸ”§ .NET Framework 4.8 +## Requirements ---- +- Visual Studio 2022 (17.8) or later +- .NET Framework 4.8 -## πŸ› οΈ Technology Stack +## Technology Stack | Component | Technology | |-----------|------------| -| 🎨 Syntax Highlighting | AvalonEdit | -| πŸ“Š JSON Parsing | Newtonsoft.Json | -| πŸ“„ YAML Parsing | YamlDotNet | -| πŸ”§ TOML Parsing | Tomlyn | -| 🎫 JWT Decoding | System.IdentityModel.Tokens.Jwt | -| πŸ“– Markdown Rendering | Markdig | -| ⏰ Cron Parsing | NCrontab | -| πŸ“Š CSV Parsing | CsvHelper | +| Syntax Highlighting | AvalonEdit | +| JSON Parsing | Newtonsoft.Json | +| YAML Parsing | YamlDotNet | +| TOML Parsing | Tomlyn | +| JWT Decoding | System.IdentityModel.Tokens.Jwt | +| Markdown Rendering | Markdig | +| Cron Parsing | NCrontab | +| CSV Parsing | CsvHelper | ---- +## Contributing -## 🀝 Contributing +Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better. -Contributions are welcome! Feel free to submit issues and pull requests. πŸ’ͺ +### Development Setup -1. 🍴 Fork the repository -2. 🌿 Create a feature branch (`git checkout -b feat/amazing-feature`) -3. πŸ’Ύ Commit your changes (`git commit -m 'feat: add amazing feature'`) -4. πŸ“€ Push to the branch (`git push origin feat/amazing-feature`) -5. πŸŽ‰ Open a Pull Request +1. Clone the repository +2. Open the solution in Visual Studio 2022 or 2026 +3. Ensure you have the "Visual Studio extension development" workload installed +4. Press F5 to launch the experimental instance ---- - -## πŸ“„ License +## License -This project is licensed under the **MIT License** β€” see the [LICENSE](LICENSE) file for details. +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. --- -## πŸ‘₯ Contributors +## Contributors -[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen) [![lennartb-](https://avatars.githubusercontent.com/u/5563601?v=4&s=64)](https://github.com/lennartb-) --- -
- -### ⭐ If you find Debugalizers useful, please consider giving it a star! ⭐ - -*Made with ❀️ for the Visual Studio community from Coding With Calvin* - -
+

+ Made with ❀️ by Coding With Calvin +