Skip to content
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.

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

Sort filter-domains on translated name #21116

Merged
merged 1 commit into from
Jun 19, 2024

Conversation

karwosts
Copy link
Contributor

@karwosts karwosts commented Jun 19, 2024

Proposed change

Sort filter-domains on translated name

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

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:

Summary by CodeRabbit

  • New Features
    • Improved domain filtering to include both domain and name attributes, enhancing search accuracy.
    • Updated sorting logic to sort domains by name, making it easier to find specific domains.

Copy link
Contributor

coderabbitai bot commented Jun 19, 2024

Walkthrough

Walkthrough

The HaFilterDomains class has been enhanced to refine domain filtering, mapping, and sorting. Specifically, it now incorporates name attributes for these processes, and subsequently sorts the domains based on their names in alignment with the frontend language. This makes the domain navigation in the filter sidebar more intuitive and user-friendly across different languages.

Changes

File Path Change Summary
src/components/ha-filter-domains.ts Updated HaFilterDomains class to map, filter on domain and name, sort by name, and return only the domain.

Sequence Diagram(s)

No sequence diagrams needed for this update.

Assessment against linked issues

Objective Addressed Explanation
Ensure domains in the filter sidebar are ordered based on the frontend language (#21034)

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 62528b2 and 3f5ad9f.

Files selected for processing (1)
  • src/components/ha-filter-domains.ts (1 hunks)
Additional context used
Biome
src/components/ha-filter-domains.ts

[error] 110-110: Forbidden non-null assertion. (lint/style/noNonNullAssertion)

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

Additional comments not posted (1)
src/components/ha-filter-domains.ts (1)

92-103: The refactoring of the _domains method enhances the domain sorting based on the translated names, aligning with the PR objectives to improve usability for non-English users.

However, consider adding a null check or using optional chaining for accessing properties to enhance the robustness of the code.

- this.renderRoot.querySelector("mwc-list")!.style.height =
+ this.renderRoot.querySelector("mwc-list")?.style.height =

Likely invalid or redundant comment.


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Outside diff range comments (1)
src/components/ha-filter-domains.ts (1)

Line range hint 110-110: Replace the non-null assertion with an optional chaining operator to prevent potential runtime errors.

- this.renderRoot.querySelector("mwc-list")!.style.height =
+ this.renderRoot.querySelector("mwc-list")?.style.height =

Copy link
Member

@piitaya piitaya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @karwosts

@piitaya piitaya merged commit 8272bef into home-assistant:dev Jun 19, 2024
14 checks passed
@karwosts karwosts deleted the sort-translated-domains branch June 19, 2024 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Domains in filter sidebar are not ordered by frontend language
2 participants