Skip to content

refactor: use shared PanelIcon enum values for built-in panel SVG keys. - #41

Merged
terabytesoftw merged 4 commits into
mainfrom
refactor/use-shared-pnael-icon
Sep 7, 2026
Merged

refactor: use shared PanelIcon enum values for built-in panel SVG keys.#41
terabytesoftw merged 4 commits into
mainfrom
refactor/use-shared-pnael-icon

Conversation

@terabytesoftw

Copy link
Copy Markdown
Contributor

Pull Request

  • Breaking change (fix or feature that would cause existing functionality to change)
  • Bugfix (non-breaking change that fixes an issue)
  • CI/build configuration
  • Documentation update
  • New feature (non-breaking change that adds functionality)
  • Refactoring (no functional changes)

@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Team

Run ID: 2312bd8c-4c95-45af-ac0c-ecc8666dd275

📥 Commits

Reviewing files that changed from the base of the PR and between 33ee63d and 6ff79e3.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • src/Panel/PanelIcon.php
  • tests/Panel/PanelIconTest.php

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: mutation / PHP 8.5-ubuntu-latest
  • GitHub Check: mutation / PHP 8.5-ubuntu-latest
🧰 Additional context used
🪛 PHPMD (2.15.0)
tests/Panel/PanelIconTest.php

[error] 40-40: Avoid using static access to class '\PHPForge\Debug\Panel\PanelIcon' in method 'testIconKeysPreserveExistingSvgResources'. (undefined)

(StaticAccess)


[error] 44-44: Avoid using static access to class '\PHPForge\Debug\Panel\PanelIcon' in method 'testIconKeysPreserveExistingSvgResources'. (undefined)

(StaticAccess)


[error] 52-52: Avoid using static access to class '\PHPForge\Debug\Helper\Icon' in method 'testIconKeysPreserveExistingSvgResources'. (undefined)

(StaticAccess)

🔇 Additional comments (3)
src/Panel/PanelIcon.php (1)

1-88: LGTM!

tests/Panel/PanelIconTest.php (1)

1-57: LGTM!

CHANGELOG.md (1)

46-46: LGTM!


📝 Summary

Summary by CodeRabbit

  • New Features

    • Added a standardized set of icons for built-in debugger panels, covering areas such as configuration, database, requests, logs, profiling, and more.
    • Added bundled SVG resources for all supported panel icons.
  • Documentation

    • Updated the changelog for the upcoming 0.1.0 release with the panel icon standardization details.

Walkthrough

The change adds a string-backed PanelIcon enum for built-in panel SVG keys. Tests validate all enum values and bundled SVG resources. The changelog records the new shared icon values.

Changes

Shared Panel Icon Contract

Layer / File(s) Summary
Panel icon enum and validation
src/Panel/PanelIcon.php, tests/Panel/PanelIconTest.php, CHANGELOG.md
The PanelIcon enum defines built-in panel icon keys. Tests verify the cases, mappings, and SVG rendering. The changelog records the change.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 6ff79

This adds shared built-in panel icon keys and validates that each key resolves to a bundled SVG. No current merge-readiness risk remains.

Poem

A rabbit checks each icon bright
Fifteen keys align just right
SVGs bloom from every name
The enum keeps them all the same
The changelog hops behindTHOOK

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (1 skipped: 1 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: built-in panel SVG keys now use shared PanelIcon enum values.
Description check ✅ Passed The description categorizes the change as a non-breaking bugfix, which is related to the pull request objectives and changeset.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch refactor/use-shared-pnael-icon

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Sep 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.95%. Comparing base (33ee63d) to head (6ff79e3).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##               main      #41   +/-   ##
=========================================
  Coverage     99.95%   99.95%           
  Complexity     2177     2177           
=========================================
  Files           163      163           
  Lines          8677     8677           
=========================================
  Hits           8673     8673           
  Misses            4        4           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@terabytesoftw
terabytesoftw merged commit 35d4707 into main Sep 7, 2026
42 of 43 checks passed
@terabytesoftw
terabytesoftw deleted the refactor/use-shared-pnael-icon branch September 7, 2026 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant