Dev tools events: Add a clear events button

[silamon]

Proposed change

Add a clear events button, also put everything in ha-card and ha-buttons.

Type of change

• Dependency upgrade
• Bugfix (non-breaking change which fixes an issue)
• New feature (thank you!)
• Breaking change (fix/feature causing existing functionality to break)
• Code quality improvements to existing code or addition of tests

Example configuration

Additional information

• This PR fixes or closes issue: fixes #
• This PR is related to issue or discussion:
• Link to documentation pull request:

Checklist

• The code change is tested and works locally.
• There is no commented out code in this PR.
• Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated for www.home-assistant.io

Summary by CodeRabbit

• New Features

  • Introduced "Clear events" button within the event subscription card.

• Improvements

  • Enhanced UI consistency by replacing Material Web Components (MWC) buttons with custom ha-button components.
  • Improved event handling functionalities in the developer tools.

• Localization

  • Added translation for "Clear events" in English.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes focus on enhancing the event handling UI in the developer tools section. This involves replacing Material Web Components (MWC) buttons with custom ha-button components, reorganizing UI structures, and adding new functionalities like clearing events. These updates improve the interface's consistency and usability.

Changes

File Path	Change Summary
src/panels/developer-tools/event/developer-tools-event.ts	Updated imports and UI structure, replacing <mwc-button> with <ha-button>.
src/panels/developer-tools/event/event-subscribe-card.ts	Replaced <mwc-button> with <ha-button>, added a clear events button, and updated styles.
src/translations/en.json	Added a new translation key "clear_events": "Clear events".

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HaPanelDevEvent
    participant EventSubscribeCard

    User ->> HaPanelDevEvent: Load Developer Tools - Event
    HaPanelDevEvent ->> HaPanelDevEvent: Render UI with ha-button
    User ->> EventSubscribeCard: Click Start/Stop Button
    EventSubscribeCard ->> EventSubscribeCard: _startOrStopListening()
    User ->> EventSubscribeCard: Click Clear Events Button
    EventSubscribeCard ->> EventSubscribeCard: _clearEvents()

Loading

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 7edc4ef and 33e5b1c.

Files selected for processing (3)

• src/panels/developer-tools/event/developer-tools-event.ts (2 hunks)
• src/panels/developer-tools/event/event-subscribe-card.ts (6 hunks)
• src/translations/en.json (1 hunks)

Additional context used

Biome

src/panels/developer-tools/event/event-subscribe-card.ts

[error] 45-45: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

---

[error] 48-48: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

---

[error] 63-63: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

---

[error] 66-66: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

---

[error] 75-75: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

Additional comments not posted (9)

src/panels/developer-tools/event/event-subscribe-card.ts (5)

9-9: Import change approved.

The import of ha-button is necessary for replacing mwc-button.

---

137-140: New method _clearEvents looks good.

The method correctly clears the events and resets the event count.

---

Line range hint 115-133:
Method _startOrStopListening looks good.

The method correctly subscribes to or unsubscribes from events based on the current state.

---

43-79: Changes in render method are approved.

The changes correctly include a new button for clearing events and replace mwc-button with ha-button.

Tools

Biome

[error] 45-45: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

---

[error] 48-48: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

---

[error] 63-63: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

---

[error] 66-66: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

---

[error] 75-75: Forbidden non-null assertion.

Unsafe fix: Replace with optional chain operator ?. This operator includes runtime checks, so it is safer than the compile-only non-null assertion operator

(lint/style/noNonNullAssertion)

---

161-163: Style changes approved.

The style changes add a margin-bottom to ha-card, improving the layout.

src/panels/developer-tools/event/developer-tools-event.ts (3)

5-6: Import changes approved.

The imports of ha-button and ha-card are necessary for the new feature.

---

35-89: Changes in render method are approved.

The changes correctly replace mwc-button with ha-button and update the card content and actions.

---

Line range hint 161-163:
Style changes approved.

The style changes improve the layout and consistency.

src/translations/en.json (1)

6678-6678: Translation key added correctly.

The new translation key for "clear_events" is added correctly and follows the existing pattern.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.