Skip to content

docs(readme): add emojis and standardize workflows #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CalvinAllen merged 2 commits into from
Jan 30, 2026
Merged

docs(readme): add emojis and standardize workflows #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6c5989
docs(readme): add emojis to section headers and list items
CalvinAllen Jan 30, 2026
484bdba
ci(workflows): standardize GitHub Actions workflows
CalvinAllen Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ on:
push:
branches:
- main
paths:
- 'src/**'
- '*.slnx'
- '.github/workflows/build.yml'

jobs:
build:
Expand Down
28 changes: 15 additions & 13 deletions .github/workflows/commit-lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
name: Commit Lint
name: Lint PR Title

on:
pull_request:
types: [opened, synchronize, reopened, edited]
types: [opened, edited, reopened, synchronize]

permissions:
contents: read
pull-requests: read

jobs:
commitlint:
lint-pr-title:
name: Lint PR Title
runs-on: ubuntu-latest
steps:
- name: Checkout
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
node-version: '20'

- name: Install commitlint
run: |
npm install --save-dev @commitlint/cli @commitlint/config-conventional
npm install --save-dev @commitlint/cli@18.4.3 @commitlint/config-conventional@18.4.3

- name: Lint PR title
- name: Validate PR title
env:
PR_TITLE: ${{ github.event.pull_request.title }}
run: echo "$PR_TITLE" | npx commitlint

- name: Lint commits
run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose
run: |
echo "Validating PR title: $PR_TITLE"
echo "$PR_TITLE" | npx commitlint --verbose
4 changes: 3 additions & 1 deletion .github/workflows/contributors.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ name: Update Contributors

on:
schedule:
- cron: '0 0 * * *'
- cron: '0 6 * * *'
workflow_dispatch:

jobs:
contributors:
uses: CodingWithCalvin/.github/.github/workflows/contributors.yml@main
with:
output-format: html
secrets: inherit
12 changes: 12 additions & 0 deletions .github/workflows/preview-changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Preview Changelog

run-name: Preview release notes for next release

on:
workflow_dispatch:

jobs:
preview:
name: Preview
uses: CodingWithCalvin/.github/.github/workflows/generate-changelog.yml@main
secrets: inherit
54 changes: 27 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

---

## Updated Interface
## 🖼️ Updated Interface

<p align="center">
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-Debugalizers/main/resources/updated-interface.png" alt="Updated Debugalizers Interface" width="700">
Expand All @@ -44,7 +44,7 @@

> **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

<p align="center">
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-Debugalizers/main/resources/debugalizers-list.png" alt="Debugalizers List" width="400">
Expand Down Expand Up @@ -115,18 +115,18 @@
</tr>
</table>

## 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 |
|------------|-------------|-------|
Expand All @@ -141,7 +141,7 @@
| **SQL** | Database queries | Formatted, Syntax Highlighted, Raw |
| **GraphQL** | API queries | Formatted, Syntax Highlighted, Raw |

### Encoded Data
### 🔤 Encoded Data

| Visualizer | Description | Views |
|------------|-------------|-------|
Expand All @@ -153,15 +153,15 @@
| **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 |

### Structured Strings
### 🔗 Structured Strings

| Visualizer | Description | Views |
|------------|-------------|-------|
Expand All @@ -171,7 +171,7 @@
| **Regex** | Pattern visualization | Pattern Breakdown, Raw |
| **Cron Expression** | Schedule expressions | Human Readable, Next Runs |

### Binary & Low-Level
### 💾 Binary & Low-Level

| Visualizer | Description | Views |
|------------|-------------|-------|
Expand All @@ -180,7 +180,7 @@
| **Timestamp** | Unix epoch conversion | Human Readable, UTC/Local |
| **IP Address** | IPv4/IPv6 details | Formatted, CIDR Info |

## Installation
## 🛠️ Installation

### Visual Studio Marketplace

Expand All @@ -193,7 +193,7 @@

Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-Debugalizers/releases) page and double-click to install.

## Usage
## 🚀 Usage

1. Set a breakpoint where a string variable is in scope
2. When the debugger hits the breakpoint, hover over the variable
Expand All @@ -207,14 +207,14 @@ Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCal
<em>Select a visualizer from the list</em>
</p>

### Keyboard Shortcuts
### ⌨️ Keyboard Shortcuts

| Shortcut | Action |
|----------|--------|
| `Ctrl+F` | Search within content |
| `Escape` | Close visualizer window |

### Toolbar Actions
### 🛠️ Toolbar Actions

| Button | Action |
|--------|--------|
Expand All @@ -223,12 +223,12 @@ Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCal
| **Export** | Save content to a file |
| **Word Wrap** | Toggle word wrapping |

## Requirements
## 📋 Requirements

- Visual Studio 2022 (17.8) or later
- .NET Framework 4.8
- 💻 Visual Studio 2022 (17.8) or later
- 🔧 .NET Framework 4.8

## Technology Stack
## 🏗️ Technology Stack

| Component | Technology |
|-----------|------------|
Expand All @@ -241,24 +241,24 @@ Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCal
| 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.

### Development Setup
### 🔧 Development Setup

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.

---

## Contributors
## 👥 Contributors

<!-- readme: contributors -start -->
<!-- readme: contributors -end -->
Expand Down